org.starchartlabs.alloy.core.collections

Interface PageIterator<T>

Type Parameters:

T - Type representing a single element of the paged data set

All Superinterfaces:

java.util.Iterator<java.util.Collection<T>>

public interface PageIterator<T>
extends java.util.Iterator<java.util.Collection<T>>

Represents a specialized iterator for handling elements read in distinct chunks ("pages"). Instances of PageIterator are primarily used with MoreSpliterators.ofPaged(PageIterator) to allow treating a sequence of pages as a standard Java Stream

Implementations of PageIterator handle underlying traversal and advancement through a sequence of pages

Since:

0.4.0

See Also:

MoreSpliterators.ofPaged(PageIterator)

Method Summary

Modifier and Type	Method and Description
long	estimateSize() Returns an estimate of the number of elements that would be encountered by a complete traversal, or returns Long.MAX_VALUE if infinite, unknown, or too expensive to compute.
PageIterator<T>	trySplit() Utilized by spliterator implementations to partition via Spliterator.trySplit()

Methods inherited from interface java.util.Iterator

forEachRemaining, hasNext, next, remove

Method Detail

estimateSize

long estimateSize()

Returns an estimate of the number of elements that would be encountered by a complete traversal, or returns Long.MAX_VALUE if infinite, unknown, or too expensive to compute.

Used by spliterator implementations for Spliterator.estimateSize()

Returns:

The estimated size, or Long.MAX_VALUE if infinite, unknown, or too expensive to compute.

Since:

0.4.0

trySplit

PageIterator<T> trySplit()

Utilized by spliterator implementations to partition via Spliterator.trySplit()

If a non-null result is provided, it is expected that the elements covered by the result will not be covered by this PageProvider

Returns:

a PageProvider covering some portion of the elements, or null if this spliterator cannot be split

Since:

0.4.0