Package net.imglib2

Interface Iterator

All Known Subinterfaces:

Cursor<T>, ProjectedSampler<T>, RealCursor<T>

All Known Implementing Classes:

AbstractArrayCursor, AbstractArrayLocalizingCursor, AbstractConvertedCursor, AbstractConvertedRealCursor, AbstractCursor, AbstractCursorInt, AbstractLocalizingCursor, AbstractLocalizingCursorInt, AbstractLongListImg.LongListCursor, AbstractLongListImg.LongListLocalizingCursor, ArrayCursor, ArrayLocalizingCursor, ArrayLocalizingSubIntervalCursor, ArraySubIntervalCursor, BiConvertedCursor, BiConvertedRealCursor, CellCursor, CellLocalizingCursor, ConvertedCursor, ConvertedRealCursor, IntervalIterator, IntervalSampler, KDTree.KDTreeCursor, ListCursor, ListLocalizingCursor, LocalizingIntervalIterator, LocalizingRealIntervalIterator, LocalizingZeroMinIntervalIterator, NtreeCursor, OffsetableIntervalIterator, OffsetableLocalizingIntervalIterator, PlanarCursor, PlanarCursor1D, PlanarCursor2D, PlanarLocalizingCursor, PlanarLocalizingCursor1D, PlanarLocalizingCursor2D, PlanarPlaneSubsetCursor, PlanarPlaneSubsetLocalizingCursor, PointSampleList.PointSampleListCursor, RandomAccessibleIntervalCursor, RealPointSampleList.RealPointSampleListCursor, SelectiveSampler, SlicingCursor, WriteConvertedCursor, WriteConvertedRealCursor, ZeroMinIntervalIterator

public interface Iterator

The Iterator interface provides basic functionality for iterating over a set of elements. The iteration order depends on the Iterator implementation.

Method Summary

Modifier and Type	Method	Description
void	fwd()	Move forward.
boolean	hasNext()	Returns true if another step forward is possible.
default void	jumpFwd(long steps)	Move steps × forward.
void	reset()	Reset the Iterator, that is put it to where it would be if newly created.

Method Detail

jumpFwd

default void jumpFwd(long steps)

Move steps × forward.

Highly recommended to override this with a more efficient version.

Parameters:

steps - number of steps to move forward

fwd

void fwd()

Move forward.

reset

void reset()

Reset the Iterator, that is put it to where it would be if newly created.

hasNext

boolean hasNext()

Returns true if another step forward is possible.

Returns:

true, if there is another step forward is possible, otherwise false