QueryBatchCursor

java.lang.Object
- com.mongodb.operation.QueryBatchCursor<T>

All Implemented Interfaces:

BatchCursor<T>, java.io.Closeable, java.lang.AutoCloseable, java.util.Iterator<java.util.List<T>>

Direct Known Subclasses:

MapReduceInlineResultsCursor
```
class QueryBatchCursor<T>
extends java.lang.Object
implements BatchCursor<T>
```

Field Summary

Fields
Modifier and Type	Field and Description
`private int`	`batchSize`
`private boolean`	`closed`
`private ConnectionSource`	`connectionSource`
`private int`	`count`
`private Decoder<T>`	`decoder`
`private int`	`limit`
`private long`	`maxTimeMS`
`private MongoNamespace`	`namespace`
`private java.util.List<T>`	`nextBatch`
`private ServerCursor`	`serverCursor`

Constructor Summary

Constructors
Constructor and Description
`QueryBatchCursor(QueryResult<T> firstQueryResult, int limit, int batchSize, Decoder<T> decoder)`
`QueryBatchCursor(QueryResult<T> firstQueryResult, int limit, int batchSize, Decoder<T> decoder, ConnectionSource connectionSource)`
`QueryBatchCursor(QueryResult<T> firstQueryResult, int limit, int batchSize, long maxTimeMS, Decoder<T> decoder, ConnectionSource connectionSource, Connection connection)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`private BsonDocument`	`asGetMoreCommandDocument()`
`void`	`close()`
`int`	`getBatchSize()` Gets the batch size to use when requesting the next batch.
`private void`	`getMore()`
`ServerAddress`	`getServerAddress()` Returns the server address
`ServerCursor`	`getServerCursor()` Returns the server cursor
`boolean`	`hasNext()` Returns true if another batch of results exists.
`private void`	`initFromCommandResult(BsonDocument getMoreCommandResultDocument)`
`private void`	`initFromQueryResult(QueryResult<T> queryResult)`
`private void`	`killCursor()`
`private void`	`killCursor(Connection connection)`
`private boolean`	`limitReached()`
`java.util.List<T>`	`next()` Returns the next batch of results.
`void`	`remove()`
`void`	`setBatchSize(int batchSize)` Sets the batch size to use when requesting the next batch.
`(package private) boolean`	`tryHasNext()`
`java.util.List<T>`	`tryNext()` A special `next()` case that returns the next batch if available or null.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Iterator
forEachRemaining

- Field Detail
  - namespace
```
private final MongoNamespace namespace
```
  - limit
```
private final int limit
```
  - decoder
```
private final Decoder<T> decoder
```
  - connectionSource
```
private final ConnectionSource connectionSource
```
  - maxTimeMS
```
private final long maxTimeMS
```
  - batchSize
```
private int batchSize
```
  - serverCursor
```
private ServerCursor serverCursor
```
  - nextBatch
```
private java.util.List<T> nextBatch
```
  - count
```
private int count
```
  - closed
```
private boolean closed
```
- Constructor Detail
  - QueryBatchCursor
```
QueryBatchCursor(QueryResult<T> firstQueryResult,
                 int limit,
                 int batchSize,
                 Decoder<T> decoder)
```
  - QueryBatchCursor
```
QueryBatchCursor(QueryResult<T> firstQueryResult,
                 int limit,
                 int batchSize,
                 Decoder<T> decoder,
                 ConnectionSource connectionSource)
```
  - QueryBatchCursor
```
QueryBatchCursor(QueryResult<T> firstQueryResult,
                 int limit,
                 int batchSize,
                 long maxTimeMS,
                 Decoder<T> decoder,
                 ConnectionSource connectionSource,
                 Connection connection)
```
- Method Detail
  - hasNext
```
public boolean hasNext()
```
    Description copied from interface: BatchCursor
    
    Returns true if another batch of results exists. A tailable cursor will block until another batch exists.
    
    Specified by:
    
    hasNext in interface BatchCursor<T>
    
    Specified by:
    
    hasNext in interface java.util.Iterator<java.util.List<T>>
    
    Returns:
    
    true if another batch exists
  - next
```
public java.util.List<T> next()
```
    Description copied from interface: BatchCursor
    
    Returns the next batch of results. A tailable cursor will block until another batch exists.
    
    Specified by:
    
    next in interface BatchCursor<T>
    
    Specified by:
    
    next in interface java.util.Iterator<java.util.List<T>>
    
    Returns:
    
    the next batch of results
  - setBatchSize
```
public void setBatchSize(int batchSize)
```
    Description copied from interface: BatchCursor
    
    Sets the batch size to use when requesting the next batch. This is the number of documents to request in the next batch.
    
    Specified by:
    
    setBatchSize in interface BatchCursor<T>
    
    Parameters:
    
    batchSize - the non-negative batch size. 0 means to use the server default.
  - getBatchSize
```
public int getBatchSize()
```
    Description copied from interface: BatchCursor
    
    Gets the batch size to use when requesting the next batch. This is the number of documents to request in the next batch.
    
    Specified by:
    
    getBatchSize in interface BatchCursor<T>
    
    Returns:
    
    the non-negative batch size. 0 means to use the server default.
  - remove
```
public void remove()
```
    Specified by:
    
    remove in interface java.util.Iterator<java.util.List<T>>
  - close
```
public void close()
```
    Specified by:
    
    close in interface BatchCursor<T>
    
    Specified by:
    
    close in interface java.io.Closeable
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
  - tryNext
```
public java.util.List<T> tryNext()
```
    Description copied from interface: BatchCursor
    
    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.
    
    Specified by:
    
    tryNext in interface BatchCursor<T>
    
    Returns:
    
    the next batch if available or null.
  - tryHasNext
```
boolean tryHasNext()
```
  - getServerCursor
```
public ServerCursor getServerCursor()
```
    Description copied from interface: BatchCursor
    
    Returns the server cursor
    
    Specified by:
    
    getServerCursor in interface BatchCursor<T>
    
    Returns:
    
    ServerCursor
  - getServerAddress
```
public ServerAddress getServerAddress()
```
    Description copied from interface: BatchCursor
    
    Returns the server address
    
    Specified by:
    
    getServerAddress in interface BatchCursor<T>
    
    Returns:
    
    ServerAddress
  - getMore
```
private void getMore()
```
  - asGetMoreCommandDocument
```
private BsonDocument asGetMoreCommandDocument()
```
  - initFromQueryResult
```
private void initFromQueryResult(QueryResult<T> queryResult)
```
  - initFromCommandResult
```
private void initFromCommandResult(BsonDocument getMoreCommandResultDocument)
```
  - limitReached
```
private boolean limitReached()
```
  - killCursor
```
private void killCursor()
```
  - killCursor
```
private void killCursor(Connection connection)
```

Class QueryBatchCursor<T>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Iterator

Field Detail

namespace

limit

decoder

connectionSource

maxTimeMS

batchSize

serverCursor

nextBatch

count

closed

Constructor Detail

QueryBatchCursor

QueryBatchCursor

QueryBatchCursor

Method Detail

hasNext

next

setBatchSize

getBatchSize

remove

close

tryNext

tryHasNext

getServerCursor

getServerAddress

getMore

asGetMoreCommandDocument

initFromQueryResult

initFromCommandResult

limitReached

killCursor

killCursor