com.mongodb.client.MongoChangeStreamCursor Maven / Gradle / Ivy

/*
 * Copyright 2008-present MongoDB, Inc.
 *
 * Licensed 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 com.mongodb.client;

import com.mongodb.lang.Nullable;
import org.bson.BsonDocument;

/**
 * The Mongo Cursor interface for change streams implementing the iterator protocol.
 * 
 * An application should ensure that a cursor is closed in all circumstances, e.g. using a try-with-resources statement:
 * 
 *  * try (MongoChangeStreamCursor<Document> cursor = collection.find().cursor()) {
 *     while (cursor.hasNext()) {
 *         System.out.println(cursor.next());
 *     }
 * }
 * 
 *
 * @since 3.11
 * @param  The type of documents the cursor contains
 */
public interface MongoChangeStreamCursor extends MongoCursor {
    /**
     * Returns the resume token. If a batch has been iterated to the last change stream document in the batch
     * and a postBatchResumeToken is included in the document, the postBatchResumeToken will be returned.
     * Otherwise, the resume token contained in the last change stream document will be returned.
     *
     * @return the resume token, which can be null if the cursor has either not been iterated yet, or the cursor is closed.
     */
    @Nullable
    BsonDocument getResumeToken();
}