org.apache.beam.sdk.util.common

Interface Reiterator<T>

Type Parameters:

T - the type of elements returned by this iterator

All Superinterfaces:

java.util.Iterator<T>

@Internal
public interface Reiterator<T>
extends java.util.Iterator<T>

An Iterator with the ability to copy its iteration state.

Method Summary

Modifier and Type	Method and Description
Reiterator<T>	copy() Returns a copy of the current Reiterator.

Methods inherited from interface java.util.Iterator

forEachRemaining, hasNext, next, remove

Method Detail

copy

Reiterator<T> copy()

Returns a copy of the current Reiterator. The copy's iteration state is logically independent of the current iterator; each may be advanced without affecting the other.

The returned Reiterator is not guaranteed to return referentially identical iteration results as the original Reiterator, although Object.equals(java.lang.Object) will typically return true for the corresponding elements of each if the original source is logically immutable.