org.neo4j.helpers.collection

Class LimitingResourceIterator<T>

java.lang.Object

org.neo4j.helpers.collection.PrefetchingIterator<T>

org.neo4j.helpers.collection.PrefetchingResourceIterator<T>

org.neo4j.helpers.collection.LimitingResourceIterator<T>

Type Parameters:

T - the type of items in this Iterator.

All Implemented Interfaces:

AutoCloseable, Iterator<T>, org.neo4j.graphdb.Resource, org.neo4j.graphdb.ResourceIterator<T>

public class LimitingResourceIterator<T>
extends PrefetchingResourceIterator<T>

Limits the amount of items returned by an Iterator.

Author:

Mattias Persson

Field Summary

Fields inherited from interface org.neo4j.graphdb.Resource

EMPTY

Constructor Summary

Constructors

Constructor and Description
LimitingResourceIterator(org.neo4j.graphdb.ResourceIterator<T> source, int limit) Instantiates a new limiting iterator which iterates over source and if limit items have been returned the next PrefetchingIterator.hasNext() will return false.

Method Summary

Modifier and Type	Method and Description
void	close()
boolean	limitReached()

Methods inherited from class org.neo4j.helpers.collection.PrefetchingIterator

hasNext, next, peek, remove

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.neo4j.graphdb.ResourceIterator

empty, map, stream

Methods inherited from interface java.util.Iterator

forEachRemaining, hasNext, next, remove

Constructor Detail

LimitingResourceIterator

public LimitingResourceIterator(org.neo4j.graphdb.ResourceIterator<T> source,
                                int limit)

Instantiates a new limiting iterator which iterates over source and if limit items have been returned the next PrefetchingIterator.hasNext() will return false.

Parameters:

source - the source of items.

limit - the limit, i.e. the max number of items to return.

Method Detail

limitReached

public boolean limitReached()

Returns:

true if the number of items returned up to this point is equal to the limit given in the constructor, otherwise false.

close

public void close()