com.allanbank.mongodb

Interface MongoIterator<T>

Type Parameters:

T - The type of elements being iterated over.

All Superinterfaces:

AutoCloseable, ClosableIterator<T>, Closeable, Iterable<T>, Iterator<T>, MongoCursorControl

All Known Implementing Classes:

MongoIteratorImpl, SimpleMongoIteratorImpl

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

MongoIterator 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-2013, Allanbank Consulting, Inc., All Rights Reserved

Field Summary

Fields inherited from interface com.allanbank.mongodb.MongoCursorControl

BATCH_SIZE_FIELD, CURSOR_ID_FIELD, LIMIT_FIELD, NAME_SPACE_FIELD, SERVER_FIELD

Method Summary

Methods

Modifier and Type	Method and Description
Object[]	toArray() Consumes all of the elements in the iterator and returns them in a single array.
<S> S[]	toArray(S[] to) Consumes all of the elements in the iterator and returns them in a single array.
List<T>	toList() Consumes all of the elements in the iterator and returns them in a single mutable list.

Methods inherited from interface com.allanbank.mongodb.MongoCursorControl

asDocument, close, getBatchSize, setBatchSize, stop

Methods inherited from interface com.allanbank.mongodb.ClosableIterator

close, getBatchSize, setBatchSize

Methods inherited from interface java.util.Iterator

hasNext, next, remove

Methods inherited from interface java.lang.Iterable

iterator

Method Detail

toArray

Object[] toArray()

Consumes all of the elements in the iterator and returns them in a single array.

WARNING: This method loads all of the iterator results into memory and may cause an OutOfMemoryError.

Returns:

The remaining elements in the iterator.

toArray

<S> S[] toArray(S[] to)

Consumes all of the elements in the iterator and returns them in a single array.

WARNING: This method loads all of the iterator results into memory and may cause an OutOfMemoryError.

Type Parameters:

S - The type of elements in the array.

Parameters:

to - The array to copy into. If not the right size a new array will be allocated of the right size.

Returns:

The remaining elements in the iterator.

toList

List<T> toList()

Consumes all of the elements in the iterator and returns them in a single mutable list.

WARNING: This method loads all of the iterator results into memory and may cause an OutOfMemoryError.

Returns:

The remaining elements in the iterator.