FiniteIterable (utility-functional 0.7.0 API)

All Superinterfaces:

net.digitalid.utility.interfaces.Countable, FunctionalIterable<ELEMENT>, Iterable<ELEMENT>

All Known Subinterfaces:

CollectionIterable<ELEMENT>

All Known Implementing Classes:

CollectionBasedIterable
```
@ReadOnly
 @Functional
public interface FiniteIterable<ELEMENT>
extends FunctionalIterable<ELEMENT>, net.digitalid.utility.interfaces.Countable
```
This interface extends the functional iterable interface to model finite iterables.

See Also:

CollectionIterable

Method Summary

All Methods Static Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default double`	`average()` Returns the average of all `numbers` in this iterable.
`default <RESULT,COLLECT_EXCEPTION extends Exception,RESULT_EXCEPTION extends Exception> RESULT`	`collect(@Nonnull FailableCollector<? super ELEMENT,? extends RESULT,? extends COLLECT_EXCEPTION,? extends RESULT_EXCEPTION> collector)` Returns the result of the given collector after consuming all elements of this iterable.
`default @Nonnull FiniteIterable<ELEMENT>`	`combine(@Nonnull FiniteIterable<? extends ELEMENT> iterable)` Returns the elements of this iterable followed by the elements of the given iterable.
`default @Nonnull InfiniteIterable<ELEMENT>`	`combine(@Nonnull InfiniteIterable<? extends ELEMENT> iterable)` Returns the elements of this iterable followed by the elements of the given iterable.
`default boolean`	`contains(@Nullable Object object)` Returns whether this iterable contains the given object.
`default boolean`	`containsAll(@Nonnull Collection<?> collection)` Returns whether this iterable contains all of the elements of the given collection.
`default boolean`	`containsAll(@Nonnull FiniteIterable<?> iterable)` Returns whether this iterable contains all of the elements of the given iterable.
`default boolean`	`containsDuplicates()` Returns whether this iterable contains duplicates.
`default boolean`	`containsNull()` Returns whether this iterable contains null.
`default @NonNegative int`	`count(@Nullable Object object)` Returns the number of elements in this iterable that equal the given object.
`default @Nonnull FiniteIterable<ELEMENT>`	`distinct()` Returns the distinct elements of this iterable.
`default <EXCEPTION extends Exception> FiniteIterable<ELEMENT>`	`doForEach(@Nonnull FailableConsumer<? super ELEMENT,? extends EXCEPTION> action)` Performs the given action for each element of this iterable and returns this iterable.
`default boolean`	`equals(@Nullable FiniteIterable<?> iterable)` Returns whether this iterable equals the given iterable.
`default <EXCEPTION extends Exception> @Nonnull FiniteIterable<ELEMENT>`	`evaluate()` Iterates through the elements of this iterable and returns them as a new iterable.
`default @Nonnull FiniteIterable<ELEMENT>`	`exclude(@Nonnull FiniteIterable<? super ELEMENT> iterable)` Returns the elements that are contained in this iterable but not in the given iterable.
`default @Nonnull FiniteIterable<ELEMENT>`	`filter(@Nonnull FailablePredicate<? super ELEMENT,?> predicate)` Returns the elements of this iterable that satisfy the given predicate.
`default @Nonnull FiniteIterable<ELEMENT>`	`filterNot(@Nonnull FailablePredicate<? super ELEMENT,?> predicate)` Returns the elements of this iterable that do not satisfy the given predicate.
`default @Nonnull FiniteIterable<ELEMENT>`	`filterNulls()` Returns the elements of this iterable without the null values.
`default <EXCEPTION extends Exception> ELEMENT`	`findFirst(@Nonnull FailablePredicate<? super ELEMENT,? extends EXCEPTION> predicate)` Returns the first element of this iterable that fulfills the given predicate or null if no such element is found.
`default <EXCEPTION extends Exception> ELEMENT`	`findFirst(@Nonnull FailablePredicate<? super ELEMENT,? extends EXCEPTION> predicate, ELEMENT defaultElement)` Returns the first element of this iterable that fulfills the given predicate or the given default element if no such element is found.
`default <EXCEPTION extends Exception> ELEMENT`	`findLast(@Nonnull FailablePredicate<? super ELEMENT,? extends EXCEPTION> predicate)` Returns the last element of this iterable that fulfills the given predicate or null if no such element is found.
`default <EXCEPTION extends Exception> ELEMENT`	`findLast(@Nonnull FailablePredicate<? super ELEMENT,? extends EXCEPTION> predicate, ELEMENT defaultElement)` Returns the last element of this iterable that fulfills the given predicate or the given default element if no such element is found.
`default <EXCEPTION extends Exception> ELEMENT`	`findUnique(@Nonnull FailablePredicate<? super ELEMENT,? extends EXCEPTION> predicate)` Returns the unique element of this iterable that fulfills the given predicate.
`default <TYPE> @Nonnull FiniteIterable<TYPE>`	`flatten(@Positive int level)` Returns the elements of this iterable with all collections up to the given level flattened.
`default <TYPE> @Nonnull FiniteIterable<TYPE>`	`flattenAll()` Returns the elements of this iterable with all collections directly or indirectly contained in this iterable flattened.
`default <TYPE> @Nonnull FiniteIterable<TYPE>`	`flattenOne()` Returns the elements of this iterable with all collections directly contained in this iterable flattened.
`default ELEMENT`	`getFirst()` Returns the first element of this iterable.
`default ELEMENT`	`getFirst(ELEMENT defaultElement)` Returns the first element of this iterable or the given default element if this iterable is empty.
`default ELEMENT`	`getFirstOrNull()` Returns the first element of this iterable or null if this iterable is empty.
`default ELEMENT`	`getLast()` Returns the last element of this iterable.
`default ELEMENT`	`getLast(ELEMENT defaultElement)` Returns the last element of this iterable or the given default element if this iterable is empty.
`default ELEMENT`	`getLastOrNull()` Returns the last element of this iterable or null if this iterable is empty.
`default <KEY,EXCEPTION extends Exception> @Modifiable @Nonnull Map<KEY,List<ELEMENT>>`	`groupBy(@Nonnull FailableUnaryFunction<? super ELEMENT,? extends KEY,? extends EXCEPTION> function)` Returns the elements of this iterable as a map grouped by the given function.
`default @GreaterThanOrEqualTo(value=-1L) int`	`indexOf(@Nullable Object object)` Returns the index of the first occurrence of the given object in this iterable or -1 if this iterable does not contain the given object.
`default <TYPE> @Nonnull FiniteIterable<TYPE>`	`instanceOf(@Nonnull Class<TYPE> type)` Returns the elements of this iterable which are an instance of the given type.
`default @Nonnull FiniteIterable<ELEMENT>`	`intersect(@Nonnull FiniteIterable<? super ELEMENT> iterable)` Returns the elements that are contained both in this iterable and the given iterable.
`default boolean`	`isAscending()` Returns whether the elements in this iterable are ascending (excluding null values).
`default boolean`	`isDescending()` Returns whether the elements in this iterable are descending (excluding null values).
`default boolean`	`isEmpty()` Returns whether this iterable is empty.
`default boolean`	`isEmptyOrSingle()` Returns whether this iterable is empty or single.
`default boolean`	`isOrdered(boolean strictly, boolean ascending)` Returns whether the elements in this iterable are ordered (excluding null values).
`default boolean`	`isSingle()` Returns whether this iterable contains a single element.
`default boolean`	`isStrictlyAscending()` Returns whether the elements in this iterable are strictly ascending (excluding null values).
`default boolean`	`isStrictlyDescending()` Returns whether the elements in this iterable are strictly descending (excluding null values).
`default @Nonnull String`	`join()` Returns the elements of this iterable joined by commas.
`default @Nonnull String`	`join(@Nonnull CharSequence delimiter)` Returns the elements of this iterable joined by the given delimiter.
`default @Nonnull String`	`join(@Nonnull CharSequence prefix, @Nonnull CharSequence suffix)` Returns the elements of this iterable joined by commas with the given prefix and suffix.
`default @Nonnull String`	`join(@Nonnull CharSequence prefix, @Nonnull CharSequence suffix, @Nonnull CharSequence empty)` Returns the elements of this iterable joined by commas with the given prefix and suffix or the given empty string if this iterable is empty.
`default @Nonnull String`	`join(@Nonnull CharSequence prefix, @Nonnull CharSequence suffix, @Nonnull CharSequence empty, @Nonnull CharSequence delimiter)` Returns the elements of this iterable joined by the given delimiter with the given prefix and suffix or the given empty string if this iterable is empty.
`default @Nonnull String`	`join(@Nullable net.digitalid.utility.circumfixes.Circumfix fixes)` Returns the elements of this iterable joined by commas with the given fixes.
`default @Nonnull String`	`join(@Nullable net.digitalid.utility.circumfixes.Circumfix fixes, @Nonnull CharSequence empty)` Returns the elements of this iterable joined by commas with the given fixes or the given empty string if this iterable is empty.
`default @Nonnull String`	`join(@Nullable net.digitalid.utility.circumfixes.Circumfix fixes, @Nonnull CharSequence empty, @Nonnull CharSequence delimiter)` Returns the elements of this iterable joined by the given delimiter with the given fixes or the given empty string if this iterable is empty.
`default @GreaterThanOrEqualTo(value=-1L) int`	`lastIndexOf(@Nullable Object object)` Returns the index of the last occurrence of the given object in this iterable or -1 if this iterable does not contain the given object.
`default <TYPE> @Nonnull FiniteIterable<TYPE>`	`map(@Nonnull FailableUnaryFunction<? super ELEMENT,? extends TYPE,?> function)` Returns the elements of this iterable mapped by the given function.
`default <EXCEPTION extends Exception> boolean`	`matchAll(@Nonnull FailablePredicate<? super ELEMENT,? extends EXCEPTION> predicate)` Returns whether all elements of this iterable match the given predicate.
`default <EXCEPTION extends Exception> boolean`	`matchAny(@Nonnull FailablePredicate<? super ELEMENT,? extends EXCEPTION> predicate)` Returns whether any elements of this iterable match the given predicate.
`default <EXCEPTION extends Exception> boolean`	`matchNone(@Nonnull FailablePredicate<? super ELEMENT,? extends EXCEPTION> predicate)` Returns whether no element of this iterable matches the given predicate.
`default ELEMENT`	`max()` Returns the maximum element of this iterable according to the natural order or null if this iterable is empty.
`default ELEMENT`	`max(@Nonnull Comparator<? super ELEMENT> comparator)` Returns the maximum element of this iterable according to the given comparator or null if this iterable is empty.
`default ELEMENT`	`max(@Nonnull Comparator<? super ELEMENT> comparator, ELEMENT defaultElement)` Returns the maximum element of this iterable according to the given comparator or the given default element if this iterable is empty.
`default ELEMENT`	`max(ELEMENT defaultElement)` Returns the maximum element of this iterable according to the natural order or the given default element if this iterable is empty.
`default ELEMENT`	`min()` Returns the minimum element of this iterable according to the natural order or null if this iterable is empty.
`default ELEMENT`	`min(@Nonnull Comparator<? super ELEMENT> comparator)` Returns the minimum element of this iterable according to the given comparator or null if this iterable is empty.
`default ELEMENT`	`min(@Nonnull Comparator<? super ELEMENT> comparator, ELEMENT defaultElement)` Returns the minimum element of this iterable according to the given comparator or the given default element if this iterable is empty.
`default ELEMENT`	`min(ELEMENT defaultElement)` Returns the minimum element of this iterable according to the natural order or the given default element if this iterable is empty.
`static <ELEMENT> FiniteIterable<ELEMENT>`	`of(Collection<? extends ELEMENT> collection)` Wraps the given collection as a finite iterable or returns null if the collection is null.
`static <ELEMENT> @Nonnull FiniteIterable<ELEMENT>`	`of(ELEMENT... elements)` Wraps the given elements as a finite iterable.
`default <EXCEPTION extends Exception> ELEMENT`	`reduce(@Nonnull FailableBinaryOperator<ELEMENT,? extends EXCEPTION> operator)` Returns the value reduced by the given operator or null if this iterable is empty.
`default <EXCEPTION extends Exception> ELEMENT`	`reduce(@Nonnull FailableBinaryOperator<ELEMENT,? extends EXCEPTION> operator, ELEMENT element)` Returns the value reduced by the given operator or the given element if this iterable is empty.
`default @Nonnull InfiniteIterable<ELEMENT>`	`repeated()` Returns the elements of this iterable repeated indefinitely.
`default @Nonnull FiniteIterable<ELEMENT>`	`reversed()` Returns the elements of this iterable in reversed order.
`default @NonNegative int`	`size()` Returns the size of this iterable.
`default @Nonnull FiniteIterable<ELEMENT>`	`skip(@Positive int number)` Returns the elements of this iterable after discarding the given number of elements from the beginning.
`default @Nonnull FiniteIterable<ELEMENT>`	`sorted()` Returns the elements of this iterable sorted according to their natural order.
`default @Nonnull FiniteIterable<ELEMENT>`	`sorted(@Nonnull Comparator<? super ELEMENT> comparator)` Returns the elements of this iterable sorted according to the given comparator.
`default double`	`sumAsDouble()` Returns the sum of all `numbers` in this iterable as a double.
`default long`	`sumAsLong()` Returns the sum of all `numbers` in this iterable as a long.
`default @Nonnull Object[]`	`toArray()` Returns the elements of this iterable as an array.
`default <TYPE> TYPE[]`	`toArray(TYPE[] array)` Returns the elements of this iterable as a generic array of the given type.
`default ELEMENT[]`	`toGenericArray()` Returns the elements of this iterable as a generic array.
`default @Modifiable @Nonnull List<ELEMENT>`	`toList()` Returns the elements of this iterable as a list.
`default <KEY,EXCEPTION extends Exception> @Modifiable @Nonnull Map<KEY,ELEMENT>`	`toMap(@Nonnull FailableUnaryFunction<? super ELEMENT,? extends KEY,? extends EXCEPTION> function)` Returns the elements of this iterable as a map with their key determined by the given function.
`default @Modifiable @Nonnull Set<ELEMENT>`	`toSet()` Returns the elements of this iterable as a set.
`default <TYPE> @Nonnull FiniteIterable<Pair<ELEMENT,TYPE>>`	`zipLongest(@Nonnull FiniteIterable<? extends TYPE> iterable)` Returns the elements from this and the given iterable as pairs, where the i-th pair contains the i-th element of each iterable.
`default <TYPE> @Nonnull FiniteIterable<Pair<ELEMENT,TYPE>>`	`zipShortest(@Nonnull InfiniteIterable<? extends TYPE> iterable)` Returns the elements from this and the given iterable as pairs, where the i-th pair contains the i-th element of each iterable.

Methods inherited from interface net.digitalid.utility.functional.iterables.FunctionalIterable
extract, get, hasSize, iterator, limit, size, sizeAtLeast, sizeAtMost, zipLongest, zipShortest

Methods inherited from interface java.lang.Iterable
forEach, spliterator

Method Detail

of

@Pure
static <ELEMENT> FiniteIterable<ELEMENT> of(@Shared @Unmodified
                                                  Collection<? extends ELEMENT> collection)

Wraps the given collection as a finite iterable or returns null if the collection is null.

of

@Pure
 @SafeVarargs
 @Nonnull
static <ELEMENT> @Nonnull FiniteIterable<ELEMENT> of(@Shared @Unmodified @Nonnull
                                                                                   ELEMENT... elements)

Wraps the given elements as a finite iterable.

size
```
@Pure
 @NonNegative
default @NonNegative int size()
```
Returns the size of this iterable.

Specified by:

size in interface net.digitalid.utility.interfaces.Countable

isEmpty
```
@Pure
default boolean isEmpty()
```
Description copied from interface: FunctionalIterable

Returns whether this iterable is empty.

Specified by:

isEmpty in interface net.digitalid.utility.interfaces.Countable

Specified by:

isEmpty in interface FunctionalIterable<ELEMENT>

isSingle
```
@Pure
default boolean isSingle()
```
Description copied from interface: FunctionalIterable

Returns whether this iterable contains a single element.

Specified by:

isSingle in interface net.digitalid.utility.interfaces.Countable

Specified by:

isSingle in interface FunctionalIterable<ELEMENT>

isEmptyOrSingle
```
@Pure
default boolean isEmptyOrSingle()
```
Description copied from interface: FunctionalIterable

Returns whether this iterable is empty or single.

Specified by:

isEmptyOrSingle in interface net.digitalid.utility.interfaces.Countable

Specified by:

isEmptyOrSingle in interface FunctionalIterable<ELEMENT>