Package com.mongodb.operation

Interface BatchCursor<T>

  • Type Parameters:
    T - The type of documents the cursor contains
    All Superinterfaces:
    , , <<T>>
    All Known Subinterfaces:
    AggregateResponseBatchCursor<T>, MapReduceBatchCursor<T>
    @NotThreadSafe

public interface BatchCursor<T>
extends <<T>>,
    Deprecated.
    MongoDB returns query results as batches, and this interface provideds an iterator over those batches. The first call to the next method will return the first batch, and subsequent calls will trigger a request to get the next batch of results. Clients can control the batch size by setting the batchSize property between calls to next.
    Since:
    3.0
    MongoDB documentation

    • Method Detail

      • close

        void close()
        Deprecated.
        Specified by:
         in interface 
        Specified by:
         in interface 

      • hasNext

        boolean hasNext()
        Deprecated.
        Returns true if another batch of results exists. A tailable cursor will block until another batch exists.
        Specified by:
         in interface <T>
        Returns:
        true if another batch exists

      • next

        <T> next()
        Deprecated.
        Returns the next batch of results. A tailable cursor will block until another batch exists.
        Specified by:
         in interface <T>
        Returns:
        the next batch of results
        Throws:
        - if no next batch exists

      • setBatchSize

        void setBatchSize​(int batchSize)
        Deprecated.
        Sets the batch size to use when requesting the next batch. This is the number of documents to request in the next batch.
        Parameters:
        batchSize - the non-negative batch size. 0 means to use the server default.

      • getBatchSize

        int getBatchSize()
        Deprecated.
        Gets the batch size to use when requesting the next batch. This is the number of documents to request in the next batch.
        Returns:
        the non-negative batch size. 0 means to use the server default.

      • tryNext

        <T> tryNext()
        Deprecated.
        A special next() case that returns the next batch if available or null.

        Tailable cursors are an example where this is useful. A call to tryNext() may return null, but in the future calling tryNext() would return a new batch if a document had been added to the capped collection.

        Returns:
        the next batch if available or null.
        MongoDB documentation

      • getServerCursor

        ServerCursor getServerCursor()
        Deprecated.
        Returns the server cursor
        Returns:
        ServerCursor

      • getServerAddress

        ServerAddress getServerAddress()
        Deprecated.
        Returns the server address
        Returns:
        ServerAddress