001/*
002 * (C) Copyright 2017 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     bdelbosc
018 */
019package org.nuxeo.lib.stream.log;
020
021/**
022 * A message position in a partition.
023 *
024 * @since 9.3"
025 */
026public interface LogOffset extends Comparable<LogOffset> {
027    /**
028     * Returns the tuple Log name and partition.
029     */
030    LogPartition partition();
031
032    /**
033     * The position for the this {@link #partition()}.
034     */
035    long offset();
036
037    /**
038     * Returns the next offset corresponding to the next position in the same partition.
039     *
040     * @since 10.1
041     */
042    LogOffset nextOffset();
043}