de.larssh.utils.collection

Interface Iterators.ElementsSupplierStateHandler<E>

Type Parameters:

E - the type of the iterator elements

Enclosing class:

Iterators

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public static interface Iterators.ElementsSupplierStateHandler<E>

An instance of this is passed to the elements supplier at the time of calculating the next element. It is used to mark the iteration's end. Check out endOfData() for more information.

Method Summary

Modifier and Type	Method and Description
E	endOfData() Marks the iteration's end, the so called end of data.

Method Detail

endOfData

@Nullable
E endOfData()

Marks the iteration's end, the so called end of data.

If this has been called the return value of the elements supplier will not be taken into account.

Check out Iterators.iterator(Function) for an usage example.

Returns:

any valid value, probably null