/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.distributedlog;

/**
 * A iterator to iterate records in the stream.
 */
public interface RecordStream {
    /**
     * advance <i>numRecords</i> records.
     */
    void advance(int numRecords);

    /**
     * Get position of current record in the stream.
     *
     * @return position of current record
     */
    DLSN getCurrentPosition();

    /**
     * Get the name of the stream.
     *
     * @return the name of the stream
     */
    String getName();
}

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.distributedlog;

/**
 * A iterator to iterate records in the stream.
 */
interface RecordStream {
    /**
     * advance <i>numRecords</i> records.
     */
    void advance(int numRecords);

    /**
     * Get position of current record in the stream.
     *
     * @return position of current record
     */
    DLSN getCurrentPosition();

    /**
     * Get the name of the stream.
     *
     * @return the name of the stream
     */
    String getName();
}

Add javadoc to website