InfiniteIterable (utility-functional 0.7.0 API)

All Superinterfaces:

FunctionalIterable<ELEMENT>, Iterable<ELEMENT>
```
@ReadOnly
 @Functional
public interface InfiniteIterable<ELEMENT>
extends FunctionalIterable<ELEMENT>
```
This interface extends the functional iterable interface to model infinite iterables.

Method Summary

All Methods Static Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default @Nonnull InfiniteIterable<ELEMENT>`	`filter(@Nonnull FailablePredicate<? super ELEMENT,?> predicate)` Returns the elements of this iterable that satisfy the given predicate.
`default @Nonnull InfiniteIterable<ELEMENT>`	`filterNot(@Nonnull FailablePredicate<? super ELEMENT,?> predicate)` Returns the elements of this iterable that do not satisfy the given predicate.
`default @Nonnull InfiniteIterable<ELEMENT>`	`filterNulls()` Returns the elements of this iterable without the null values.
`default <TYPE> @Nonnull InfiniteIterable<TYPE>`	`flatten(@Positive int level)` Returns the elements of this iterable with all collections up to the given level flattened.
`default <TYPE> @Nonnull InfiniteIterable<TYPE>`	`flattenAll()` Returns the elements of this iterable with all collections directly or indirectly contained in this iterable flattened.
`default <TYPE> @Nonnull InfiniteIterable<TYPE>`	`flattenOne()` Returns the elements of this iterable with all collections directly contained in this iterable flattened.
`static <ELEMENT> @Nonnull InfiniteIterable<ELEMENT>`	`generate(@Nonnull Producer<? extends FailableProducer<? extends ELEMENT,?>> producer)` Returns a new infinite iterable that generates an infinite number of elements with the producer produced by the given producer.
`default <TYPE> @Nonnull InfiniteIterable<TYPE>`	`instanceOf(@Nonnull Class<TYPE> type)` Returns the elements of this iterable which are an instance of the given type.
`default boolean`	`isEmpty()` Returns whether this iterable is empty.
`static <ELEMENT> @Nonnull InfiniteIterable<ELEMENT>`	`iterate(ELEMENT firstElement, @Nonnull FailableUnaryOperator<ELEMENT,?> unaryOperator)` Returns a new infinite iterable that iterates over the sequence produced by the given operator from the given first element.
`default <TYPE> @Nonnull InfiniteIterable<TYPE>`	`map(@Nonnull FailableUnaryFunction<? super ELEMENT,? extends TYPE,?> function)` Returns the elements of this iterable mapped by the given function.
`static <ELEMENT> @Nonnull InfiniteIterable<ELEMENT>`	`repeat(ELEMENT element)` Returns a new infinite iterable that repeats the given element infinitely.
`default @NonNegative int`	`size(@Positive int limit)` Returns the size of this iterable or the given limit if the size is greater than the limit.
`default @Nonnull InfiniteIterable<ELEMENT>`	`skip(@Positive int number)` Returns the elements of this iterable after discarding the given number of elements from the beginning.
`default <TYPE> @Nonnull InfiniteIterable<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 InfiniteIterable<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, isEmptyOrSingle, isSingle, iterator, limit, sizeAtLeast, sizeAtMost, zipLongest, zipShortest

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

- Method Detail
  - repeat
```
@Pure
 @Nonnull
static <ELEMENT> @Nonnull InfiniteIterable<ELEMENT> repeat(@Captured
                                                                           ELEMENT element)
```
    Returns a new infinite iterable that repeats the given element infinitely.
  - iterate
```
@Pure
 @Nonnull
static <ELEMENT> @Nonnull InfiniteIterable<ELEMENT> iterate(@Captured
                                                                            ELEMENT firstElement,
                                                                            @Nonnull
                                                                            @Nonnull FailableUnaryOperator<ELEMENT,?> unaryOperator)
```
    Returns a new infinite iterable that iterates over the sequence produced by the given operator from the given first element.
  - generate
```
@Pure
 @Nonnull
static <ELEMENT> @Nonnull InfiniteIterable<ELEMENT> generate(@Captured @Nonnull
                                                                             @Nonnull Producer<? extends FailableProducer<? extends ELEMENT,?>> producer)
```
    Returns a new infinite iterable that generates an infinite number of elements with the producer produced by the given producer. All producers produced by the given producer should produce the same sequence of elements, otherwise operations like FunctionalIterable.get(int) are no longer side-effect free and calling them repeatedly leads to unexpected results.
  - isEmpty
```
@Pure
default boolean isEmpty()
```
    Description copied from interface: FunctionalIterable
    
    Returns whether this iterable is empty.
    
    Specified by:
    
    isEmpty in interface FunctionalIterable<ELEMENT>
  - size
```
@Pure
 @NonNegative
default @NonNegative int size(@Positive
                                                  @Positive int limit)
```
    Description copied from interface: FunctionalIterable
    
    Returns the size of this iterable or the given limit if the size is greater than the limit.
    
    Specified by:
    
    size in interface FunctionalIterable<ELEMENT>
  - filter
```
@Pure
 @Nonnull
default @Nonnull InfiniteIterable<ELEMENT> filter(@Nonnull
                                                                  @Nonnull FailablePredicate<? super ELEMENT,?> predicate)
```
    Description copied from interface: FunctionalIterable
    
    Returns the elements of this iterable that satisfy the given predicate. Iterating over the returned iterable can throw a IterationException.
    
    Specified by:
    
    filter in interface FunctionalIterable<ELEMENT>
  - filterNot
```
@Pure
 @Nonnull
default @Nonnull InfiniteIterable<ELEMENT> filterNot(@Nonnull
                                                                     @Nonnull FailablePredicate<? super ELEMENT,?> predicate)
```
    Description copied from interface: FunctionalIterable
    
    Returns the elements of this iterable that do not satisfy the given predicate. Iterating over the returned iterable can throw a IterationException.
    
    Specified by:
    
    filterNot in interface FunctionalIterable<ELEMENT>
  - filterNulls
```
@Pure
 @Nonnull
default @Nonnull InfiniteIterable<ELEMENT> filterNulls()
```
    Description copied from interface: FunctionalIterable
    
    Returns the elements of this iterable without the null values.
    
    Specified by:
    
    filterNulls in interface FunctionalIterable<ELEMENT>
  - map
```
@Pure
 @Nonnull
default <TYPE> @Nonnull InfiniteIterable<TYPE> map(@Nonnull
                                                                   @Nonnull FailableUnaryFunction<? super ELEMENT,? extends TYPE,?> function)
```
    Description copied from interface: FunctionalIterable
    
    Returns the elements of this iterable mapped by the given function. Iterating over the returned iterable can throw a IterationException.
    
    Specified by:
    
    map in interface FunctionalIterable<ELEMENT>
  - instanceOf
```
@Pure
 @Nonnull
default <TYPE> @Nonnull InfiniteIterable<TYPE> instanceOf(@Nonnull
                                                                          @Nonnull Class<TYPE> type)
```
    Description copied from interface: FunctionalIterable
    
    Returns the elements of this iterable which are an instance of the given type.
    
    Specified by:
    
    instanceOf in interface FunctionalIterable<ELEMENT>
  - skip
```
@Pure
 @Nonnull
default @Nonnull InfiniteIterable<ELEMENT> skip(@Positive
                                                                @Positive int number)
```
    Description copied from interface: FunctionalIterable
    
    Returns the elements of this iterable after discarding the given number of elements from the beginning.
    
    Specified by:
    
    skip in interface FunctionalIterable<ELEMENT>
  - zipShortest
```
@Pure
 @Nonnull
default <TYPE> @Nonnull InfiniteIterable<Pair<ELEMENT,TYPE>> zipShortest(@Nonnull
                                                                                         @Nonnull InfiniteIterable<? extends TYPE> iterable)
```
    Description copied from interface: FunctionalIterable
    
    Returns the elements from this and the given iterable as pairs, where the i-th pair contains the i-th element of each iterable. The returned iterable is truncated to the length of the shorter iterable.
    
    Specified by:
    
    zipShortest in interface FunctionalIterable<ELEMENT>
  - zipLongest
```
@Pure
 @Nonnull
default <TYPE> @Nonnull InfiniteIterable<Pair<ELEMENT,TYPE>> zipLongest(@Nonnull
                                                                                        @Nonnull FiniteIterable<? extends TYPE> iterable)
```
    Description copied from interface: FunctionalIterable
    
    Returns the elements from this and the given iterable as pairs, where the i-th pair contains the i-th element of each iterable. The shorter iterable is extended to the length of the longer iterable with null values for the missing elements.
    
    Specified by:
    
    zipLongest in interface FunctionalIterable<ELEMENT>
  - flatten
```
@Pure
 @Nonnull
default <TYPE> @Nonnull InfiniteIterable<TYPE> flatten(@Positive
                                                                       @Positive int level)
```
    Description copied from interface: FunctionalIterable
    
    Returns the elements of this iterable with all collections up to the given level flattened.
    
    Specified by:
    
    flatten in interface FunctionalIterable<ELEMENT>
  - flattenOne
```
@Pure
 @Nonnull
default <TYPE> @Nonnull InfiniteIterable<TYPE> flattenOne()
```
    Description copied from interface: FunctionalIterable
    
    Returns the elements of this iterable with all collections directly contained in this iterable flattened.
    
    Specified by:
    
    flattenOne in interface FunctionalIterable<ELEMENT>
  - flattenAll
```
@Pure
 @Nonnull
default <TYPE> @Nonnull InfiniteIterable<TYPE> flattenAll()
```
    Description copied from interface: FunctionalIterable
    
    Returns the elements of this iterable with all collections directly or indirectly contained in this iterable flattened.
    
    Specified by:
    
    flattenAll in interface FunctionalIterable<ELEMENT>

Interface InfiniteIterable<ELEMENT>

Method Summary

Methods inherited from interface net.digitalid.utility.functional.iterables.FunctionalIterable

Methods inherited from interface java.lang.Iterable

Method Detail

repeat

iterate

generate

isEmpty

size

filter

filterNot

filterNulls

map

instanceOf

skip

zipShortest

zipLongest

flatten

flattenOne

flattenAll