net.markenwerk.commons.iterables (net.markenwerk:commons-iterables 3.2.1 API)

Interface Summary
Interface	Description
BidirectionalIterable<Payload>	A `BidirectionalIterable` is an `Iterable` that guarantees that every call to Iterable.iterator() yields a `BidirectionalIterator`.
ProtectedBidirectionalIterable<Payload>	A `ProtectedBidirectionalIterable` is a `BidirectionalIterable` that guarantees that every call to Iterable.iterator() yields a `ProtectedBidirectionalIterator`.
ProtectedIterable<Payload>	A `ProtectedIterable` is an `Iterable` that guarantees that every call to Iterable.iterator() yields a `ProtectedIterator`.

Class Summary
Class	Description
ArrayIterable<Payload>	An `ArrayIterable` is a `ProtectedBidirectionalIterable` that generates `Iterators` that iterate over a given payload array.
BooleanArrayIterable	A `BooleanArrayIterable` is a `ProtectedBidirectionalIterable` that generates `Iterators` that iterate over a given `boolean[]`.
ByteArrayIterable	A `ByteArrayIterable` is a `ProtectedBidirectionalIterable` that generates `Iterators` that iterate over a given `byte[]`.
CharacterArrayIterable	A `CharacterArrayIterable` is a `ProtectedBidirectionalIterable` that generates `Iterators` that iterate over a given `char[]`.
CombinedIterable<Payload>	A `CombinedIterable` is an `Iterable` that wraps around some given `Iterables` and combines them into a single `Iterable` by iterating over all given `Iterables` in the order they were given.
ConvertingIterable<From,To>	A `ConvertingIterable` is an `Iterable` that can be wrapped around a given `Iterable` and generates `Iterators` that converts all values with a given `Converter`.
CountDownIterable	A `CountDownIterable` is a `ProtectedIterable` that generates `Iterators` that that yields all integer value between a given lower bound and a given upper bound.
CountUpIterable	A `CountUpIterable` is a `ProtectedBidirectionalIterable` that generates `Iterators` that that yields all integer value between a given lower bound and a given upper bound.
DoubleArrayIterable	A `DoubleArrayIterable` is a `ProtectedBidirectionalIterable` that generates `Iterators` that iterate over a given `double[]`.
EmptyIterable<Payload>	An `EmptyIterable` is a `ProtectedBidirectionalIterable` that generates `Iterators` that that don't yield any values.
EnumerationIterable<Payload>	An `EnumerationIterable` is a `ProtectedIterable` that can be wrapped around a given `Provider` for `Enumerations` and generates `Iterators` that yield all values from a produced `Enumeration`.
FilteredIterable<Payload>	A `FilteredIterable` is an `Iterable` that can be wrapped around a given `Iterable` and generates `Iterators` that filters out values according to a given `Predicate`.
FloatArrayIterable	A `FloatArrayIterable` is a `ProtectedBidirectionalIterable` that generates `Iterators` that iterate over a given `float[]`.
InfiniteIterable<Payload>	An `InfiniteIterable` is a `ProtectedIterable` that generates `Iterators` that iterate over a given `NodeList`.
InfixedIterable<Payload>	An `InfixedIterable` is an `Iterable` that can be wrapped around a given `Iterable` and generates `Iterators` that yield some given infix values between every value yielded by an `Iterator` that is generated by the given `Iterable`.
IntegerArrayIterable	An `IntegerArrayIterable` is a `ProtectedBidirectionalIterable` that generates `Iterators` that iterate over a given `int[]`.
LongArrayIterable	A `LongArrayIterable` is a `ProtectedBidirectionalIterable` that generates `Iterators` that iterate over a given `long[]` .
LookAheadIterable<Payload>	A `LookAheadIterable` is a `ProtectedIterable` that can be wrapped around a given `Iterator` and generates `Iterators` that yield a `LookAhead` container that holds the current and the next payload value of an `Iterator` that is generated by the given `Iterable`.
NodeListIterable	A `NodeListIterable` is a `ProtectedBidirectionalIterable` that generates `Iterators` that iterate over a given `NodeList`.
NullFreeIterable<Payload>	A `NullFreeIterable` is an `Iterable` that can be wrapped around a given `Iterable` and generates `Iterators` that filters out null values.
NullSaveIterable<Payload>	A `NullSaveIterable` is an `Iterable` that can be wrapped around a given `Iterable` and generates `Iterators` that always behaves correctly, even if the given `Iterable` is null (by generating an `EmptyIterator`).
ObjectIterable<Payload>	An `ObjectIterable` is a `ProtectedBidirectionalIterable` that generates `Iterators` that iterate over a single payload object.
OptionalIterable<Payload>	A `OptionalIterable` is a `ProtectedBidirectionalIterable` that generates `Iterators` that iterate over a given `NodeList`.
PairIterable<Payload>	A `PairIterable` is a `ProtectedBidirectionalIterable` that generates `Iterators` that iterate over a given `NodeList`.
PrefixedIterable<Payload>	A `PrefixedIterable` is an `Iterable` that can be wrapped around a given `Iterable` and generates `Iterators` that yield some given prefix values before every object yielded by an `Iterator` that is generated by the given `Iterable`.
ProtectingBidirectionalIterable<Payload>	A `ProtectingBidirectionalIterable` is a `ProtectedBidirectionalIterable` that can be wrapped around a given `BidirectionalIterable` and generates that every call to ProtectingBidirectionalIterable.iterator() yields a `ProtectedIterator`.
ProtectingIterable<Payload>	A `ProtectingIterable` is a `ProtectedIterable` that can be wrapped around a given `Iterable` and generates that every call to ProtectingIterable.iterator() yields a `ProtectedIterator`.
RemoveHandlerIterable<Payload>	A `RemoveHandlerIterable` is an `Iterable` that can be wrapped around a given `Iterable` and generates `Iterators` that filters out values according to a given `Predicate`.
ShortArrayIterable	A `ShortArrayIterable` is a `ProtectedBidirectionalIterable` that generates `Iterators` that iterate over a given `short[]`.
StringTokenizerIterable	A `StringTokenizerIterable` is a `ProtectedIterable` that can be wrapped around a given `Producer` for `StringTokenizers` and generates `Iterators` that yield all strings from a produced `StringTokenizer`.
SuffixedIterable<Payload>	A `SuffixedIterable` is an `Iterable` that can be wrapped around a given `Iterable` and generates `Iterators` that yield some given suffix values after every object yielded by an `Iterator` that is generated by the given `Iterable`.
TripleIterable<Payload>	A `TripleIterable` is a `ProtectedBidirectionalIterable` that generates `Iterators` that iterate over a given `NodeList`.
TupleIterable<Payload>	A `TupleIterable` is a `ProtectedBidirectionalIterable` that generates `Iterators` that iterate over a given `NodeList`.

Package net.markenwerk.commons.iterables