com.allanbank.mongodb

Interface ClosableIterator<T>

Type Parameters:

T - The type of elements being iterated over.

All Superinterfaces:

Iterable<T>, Iterator<T>

All Known Implementing Classes:

MongoIterator

public interface ClosableIterator<T>
extends Iterator<T>, Iterable<T>

ClosableIterator provides an interface for an iterator that can be closed.

In addition the batch size for the next request for documents from the cursor can be set.

API Notice:

This interface is part of the driver's API. Public and protected members will be deprecated for at least 1 non-bugfix release (version numbers are <major>.<minor>.<bugfix>) before being removed or modified.

Copyright ©:

2012, Allanbank Consulting, Inc., All Rights Reserved

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Close the iterator and release any resources it is holding.
int	getBatchSize() Returns the size for batches of documents that are requested.
void	setBatchSize(int batchSize) Sets the size for future batch sizes.

Methods inherited from interface java.util.Iterator

hasNext, next, remove

Methods inherited from interface java.lang.Iterable

iterator

Method Detail

close

void close()

Close the iterator and release any resources it is holding.

getBatchSize

int getBatchSize()

Returns the size for batches of documents that are requested.

Returns:

The size of the batches of documents that are requested.

setBatchSize

void setBatchSize(int batchSize)

Sets the size for future batch sizes.

Parameters:

batchSize - The size to request for future batch sizes.