com.mongodb.operation.AggregateResponseBatchCursor Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mongo-java-driver Show documentation

The MongoDB Java Driver uber-artifact, containing mongodb-driver, mongodb-driver-core, and bson

There is a newer version: 3.12.14

/*
 * 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.operation;

import com.mongodb.annotations.NotThreadSafe;
import org.bson.BsonDocument;
import org.bson.BsonTimestamp;

/**
 * Extends the batch cursor interface to include information included in an aggregate or getMore response.
 *
 * @param  The type of documents the cursor contains
 * @mongodb.driver.manual ../meta-driver/latest/legacy/mongodb-wire-protocol/#wire-op-get-more OP_GET_MORE
 * @since 3.11
 */
@NotThreadSafe
@Deprecated
public interface AggregateResponseBatchCursor extends BatchCursor {
    /**
     * Returns the postBatchResumeToken.
     *
     * @return the postBatchResumeToken
     */
    BsonDocument getPostBatchResumeToken();

    /**
     * Returns the operation time found in the aggregate or getMore response.
     *
     * @return the operation time
     */
    BsonTimestamp getOperationTime();

    /**
     * Returns true if the first batch was empty.
     *
     * @return true if the first batch was empty
     */
    boolean isFirstBatchEmpty();
}