Iterator (Javaslang 2.0.0-RC2 API)

Type Parameters:

T - Component type

All Superinterfaces:

Foldable<T>, Functor<T>, Iterable<T>, Iterator<T>, Monad<T>, Traversable<T>, Value<T>
```
public interface Iterator<T>
extends Iterator<T>, Traversable<T>
```
javaslang.collection.Iterator is a compositional replacement for java.util.Iterator whose purpose is to iterate once over a sequence of elements.
It is recommended to create instances using AbstractIterator in favor of Iterator.
Note: Iterators encapsulate mutable state. They are not meant to be used concurrently by different threads. Do not reuse Iterators, e.g. after passing to List.ofAll(Iterable).
There are two abstract methods: hasNext for checking if there is a next element available, and next which removes the next element from the iterator and returns it. They can be called an arbitrary amount of times. If hasNext returns false, a call of next will throw a NoSuchElementException.
Caution: Other methods than hasNext and next can be called only once (exclusively). More specifically, after calling a method it cannot be guaranteed that the next call will succeed. An Iterator that can be only used once because it is a traversal pointer into a collection, and not a collection itself.

Since:

2.0.0

Author:

Daniel Dietrich

Field Summary

Fields
Modifier and Type Field and Description

static Iterator<Object> EMPTY
The empty Iterator.

Fields
Modifier and Type	Field and Description
`static Iterator<Object>`	`EMPTY` The empty Iterator.

Method Summary

All Methods Static Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default Iterator<T>`	`clear()` Returns an empty version of this traversable, i.e.
`static <T> Iterator<T>`	`concat(Iterable<? extends Iterable<? extends T>> iterables)` Creates an Iterator which traverses along the concatenation of the given iterables.
`static <T> Iterator<T>`	`concat(Iterable<? extends T>... iterables)` Creates an Iterator which traverses along the concatenation of the given iterables.
`default Iterator<T>`	`concat(Iterator<T> that)`
`default <U> boolean`	`corresponds(Iterable<U> that, java.util.function.BiPredicate<? super T,? super U> predicate)` Tests whether every element of this iterable relates to the corresponding element of another iterable by satisfying a test predicate.
`default Iterator<T>`	`distinct()` Returns a new version of this which contains no duplicates.
`default Iterator<T>`	`distinctBy(Comparator<? super T> comparator)` Returns a new version of this which contains no duplicates.
`default <U> Iterator<T>`	`distinctBy(java.util.function.Function<? super T,? extends U> keyExtractor)` Returns a new version of this which contains no duplicates.
`default Iterator<T>`	`drop(int n)` Removes up to n elements from this iterator.
`default Iterator<T>`	`dropRight(int n)` Drops the last n elements of this or all elements, if this length < n.
`default Iterator<T>`	`dropUntil(java.util.function.Predicate<? super T> predicate)` Drops elements until the predicate holds for the current element.
`default Iterator<T>`	`dropWhile(java.util.function.Predicate<? super T> predicate)` Drops elements while the predicate holds for the current element.
`static <T> Iterator<T>`	`empty()` Returns the empty Iterator.
`default boolean`	`eq(Object o)` A smoothing replacement for `equals`.
`default boolean`	`exists(java.util.function.Predicate<? super T> predicate)` Checks, if an element exists such that the predicate holds.
`default Iterator<T>`	`filter(java.util.function.Predicate<? super T> predicate)` Returns an Iterator that contains elements that satisfy the given `predicate`.
`default Option<T>`	`findLast(java.util.function.Predicate<? super T> predicate)` Returns the last element of this which satisfies the given predicate.
`default <U> Iterator<U>`	`flatMap(java.util.function.Function<? super T,? extends Iterable<? extends U>> mapper)` FlatMaps the elements of this Iterator to java.lang.Iterables, which are iterated in the order of occurrence.
`default <U> U`	`foldRight(U zero, java.util.function.BiFunction<? super T,? super U,? extends U> f)` Accumulates the elements of this Traversable by successively calling the given function `f` from the right, starting with a value `zero` of type B.
`default boolean`	`forAll(java.util.function.Predicate<? super T> predicate)` Checks, if the given predicate holds for all elements.
`default void`	`forEach(java.util.function.Consumer<? super T> action)` Performs an action on each element.
`static Iterator<Integer>`	`from(int value)` Returns an infinitely iterator of int values starting from `from`.
`static Iterator<Long>`	`from(long value)` Returns an infinitely iterator of long values starting from `from`.
`static <T> Iterator<T>`	`gen(java.util.function.Supplier<? extends T> supplier)` Generates an infinitely iterator using a value Supplier.
`static <T> Iterator<T>`	`gen(T seed, java.util.function.Function<? super T,? extends T> f)` Generates an infinitely iterator using a function to calculate the next value based on the previous.
`default T`	`get()` Gets the underlying value or throws if no value is present.
`default <C> Map<C,Iterator<T>>`	`groupBy(java.util.function.Function<? super T,? extends C> classifier)` Groups this elements by classifying the elements.
`default Iterator<Seq<T>>`	`grouped(int size)` Groups this `Traversable` into fixed size blocks.
`default boolean`	`hasDefiniteSize()` Checks if this Traversable is known to have a finite size.
`default T`	`head()` Returns the first element of a non-empty Traversable.
`default Option<T>`	`headOption()` Returns the first element of a non-empty Traversable as `Option`.
`default Iterator<T>`	`init()` Dual of Traversable.tail(), returning all elements except the last.
`default Option<Iterator<T>>`	`initOption()` Dual of Traversable.tailOption(), returning all elements except the last as `Option`.
`default Iterator<T>`	`intersperse(T element)` Inserts an element between all elements of this Iterator.
`default boolean`	`isEmpty()` Checks if this Traversable is empty.
`default boolean`	`isTraversableAgain()` Checks if this Traversable can be repeatedly traversed.
`default Iterator<T>`	`iterator()` An iterator by means of head() and tail().
`default int`	`length()` Computes the number of elements of this.
`default <U> Iterator<U>`	`map(java.util.function.Function<? super T,? extends U> mapper)` Maps the elements of this Iterator lazily using the given `mapper`.
`static <T> Iterator<T>`	`of(T... elements)` Creates an Iterator which traverses the given elements.
`static <T> Iterator<T>`	`of(T element)` Creates an Iterator which traverses one element.
`static Iterator<Boolean>`	`ofAll(boolean[] array)` Creates an Iterator based on the elements of a boolean array.
`static Iterator<Byte>`	`ofAll(byte[] array)` Creates an Iterator based on the elements of a byte array.
`static Iterator<Character>`	`ofAll(char[] array)` Creates an Iterator based on the elements of a char array.
`static Iterator<Double>`	`ofAll(double[] array)` Creates ann Iterator based on the elements of a double array.
`static Iterator<Float>`	`ofAll(float[] array)` Creates an Iterator based on the elements of a float array.
`static Iterator<Integer>`	`ofAll(int[] array)` Creates an Iterator based on the elements of an int array.
`static <T> Iterator<T>`	`ofAll(Iterable<? extends T> iterable)` Creates an Iterator based on the given java.lang.Iterable.
`static <T> Iterator<T>`	`ofAll(Iterator<? extends T> iterator)` Creates an Iterator based on the given Iterator by delegating calls of `hasNext()` and `next()` to it.
`static Iterator<Long>`	`ofAll(long[] array)` Creates an Iterator based on the elements of a long array.
`static Iterator<Short>`	`ofAll(short[] array)` Creates an Iterator based on the elements of a short array.
`default Tuple2<Iterator<T>,Iterator<T>>`	`partition(java.util.function.Predicate<? super T> predicate)` Creates a partition of this `Traversable` by splitting this elements in two in distinct tarversables according to a predicate.
`default Iterator<T>`	`peek(java.util.function.Consumer<? super T> action)` Performs the given `action` on the first element if this is an eager implementation.
`static Iterator<Character>`	`range(char from, char toExclusive)` Creates an Iterator of characters starting from `from`, extending to `toExclusive - 1`.
`static Iterator<Integer>`	`range(int from, int toExclusive)` Creates an Iterator of int numbers starting from `from`, extending to `toExclusive - 1`.
`static Iterator<Long>`	`range(long from, long toExclusive)` Creates an Iterator of long numbers starting from `from`, extending to `toExclusive - 1`.
`static Iterator<Character>`	`rangeBy(char from, char toExclusive, int step)` Creates an Iterator of characters starting from `from`, extending to `toExclusive - 1`, with `step`.
`static Iterator<Double>`	`rangeBy(double from, double toExclusive, double step)`
`static Iterator<Integer>`	`rangeBy(int from, int toExclusive, int step)` Creates an Iterator of int numbers starting from `from`, extending to `toExclusive - 1`, with `step`.
`static Iterator<Long>`	`rangeBy(long from, long toExclusive, long step)` Creates an Iterator of long numbers starting from `from`, extending to `toExclusive - 1`, with `step`.
`static Iterator<Character>`	`rangeClosed(char from, char toInclusive)` Creates an Iterator of characters starting from `from`, extending to `toInclusive`.
`static Iterator<Integer>`	`rangeClosed(int from, int toInclusive)` Creates an Iterator of int numbers starting from `from`, extending to `toInclusive`.
`static Iterator<Long>`	`rangeClosed(long from, long toInclusive)` Creates an Iterator of long numbers starting from `from`, extending to `toInclusive`.
`static Iterator<Character>`	`rangeClosedBy(char from, char toInclusive, int step)` Creates an Iterator of characters starting from `from`, extending to `toInclusive`, with `step`.
`static Iterator<Double>`	`rangeClosedBy(double from, double toInclusive, double step)`
`static Iterator<Integer>`	`rangeClosedBy(int from, int toInclusive, int step)` Creates an Iterator of int numbers starting from `from`, extending to `toInclusive`, with `step`.
`static Iterator<Long>`	`rangeClosedBy(long from, long toInclusive, long step)` Creates an Iterator of long numbers starting from `from`, extending to `toInclusive`, with `step`.
`default T`	`reduceLeft(java.util.function.BiFunction<? super T,? super T,? extends T> op)` Accumulates the elements of this Traversable by successively calling the given operation `op` from the left.
`default T`	`reduceRight(java.util.function.BiFunction<? super T,? super T,? extends T> op)` Accumulates the elements of this Traversable by successively calling the given operation `op` from the right.
`static <T> Iterator<T>`	`repeat(T t)` Repeats an element infinitely often.
`default Iterator<T>`	`replace(T currentElement, T newElement)` Replaces the first occurrence (if exists) of the given currentElement with newElement.
`default Iterator<T>`	`replaceAll(T currentElement, T newElement)` Replaces all occurrences of the given currentElement with newElement.
`default Iterator<T>`	`retainAll(Iterable<? extends T> elements)` Keeps all occurrences of the given elements from this.
`default Traversable<T>`	`scan(T zero, java.util.function.BiFunction<? super T,? super T,? extends T> operation)` Computes a prefix scan of the elements of the collection.
`default <U> Iterator<U>`	`scanLeft(U zero, java.util.function.BiFunction<? super U,? super T,? extends U> operation)` Produces a collection containing cumulative results of applying the operator going left to right.
`default <U> Iterator<U>`	`scanRight(U zero, java.util.function.BiFunction<? super T,? super U,? extends U> operation)` Produces a collection containing cumulative results of applying the operator going right to left.
`default Iterator<Seq<T>>`	`sliding(int size)` Slides a window of a specific `size` and step size 1 over this `Traversable` by calling `Traversable.sliding(int, int)`.
`default Iterator<Seq<T>>`	`sliding(int size, int step)` Slides a window of a specific `size` and `step` size over this `Traversable`.
`default Tuple2<Iterator<T>,Iterator<T>>`	`span(java.util.function.Predicate<? super T> predicate)` Returns a tuple where the first element is the longest prefix of elements that satisfy the given `predicate` and the second element is the remainder.
`default Spliterator<T>`	`spliterator()`
`default void`	`stderr()` Sends the string representations of this value to the standard error stream System.err.
`default void`	`stdout()` Sends the string representations of this value to the standard output stream System.out.
`default Iterator<T>`	`tail()` Drops the first element of a non-empty Traversable.
`default Option<Iterator<T>>`	`tailOption()` Drops the first element of a non-empty Traversable and returns an `Option`.
`default Iterator<T>`	`take(int n)` Take the first n elements from this iterator.
`default Iterator<T>`	`takeRight(int n)` Takes the last n elements of this or all elements, if this length < n.
`default Iterator<T>`	`takeUntil(java.util.function.Predicate<? super T> predicate)` Takes elements until the predicate holds for the current element.
`default Iterator<T>`	`takeWhile(java.util.function.Predicate<? super T> predicate)` Takes elements while the predicate holds for the current element.
`default Object[]`	`toJavaArray()` Converts this value to an untyped Java array.
`default <T1,T2> Tuple2<Iterator<T1>,Iterator<T2>>`	`unzip(java.util.function.Function<? super T,Tuple2<? extends T1,? extends T2>> unzipper)` Unzips this elements by mapping this elements to pairs which are subsequently split into two distinct sets.
`default <T1,T2,T3> Tuple3<Iterator<T1>,Iterator<T2>,Iterator<T3>>`	`unzip3(java.util.function.Function<? super T,Tuple3<? extends T1,? extends T2,? extends T3>> unzipper)` Unzips this elements by mapping this elements to triples which are subsequently split into three distinct sets.
`default <U> Iterator<Tuple2<T,U>>`	`zip(Iterable<U> that)` Returns a traversable formed from this traversable and another java.lang.Iterable collection by combining corresponding elements in pairs.
`default <U> Iterator<Tuple2<T,U>>`	`zipAll(Iterable<U> that, T thisElem, U thatElem)` Returns a traversable formed from this traversable and another java.lang.Iterable by combining corresponding elements in pairs.
`default Iterator<Tuple2<T,Integer>>`	`zipWithIndex()` Zips this traversable with its indices.

Methods inherited from interface java.util.Iterator
forEachRemaining, hasNext, next, remove

Methods inherited from interface javaslang.collection.Traversable
average, contains, containsAll, existsUnique, findFirst, foldLeft, hash, isSingletonType, last, lastOption, max, maxBy, maxBy, min, minBy, minBy, mkString, mkString, mkString, product, reduce, sum

Methods inherited from interface javaslang.Value
equals, get, getOption, hashCode, ifDefined, ifDefined, ifEmpty, ifEmpty, isDefined, orElse, orElseGet, orElseThrow, orElseTry, out, out, toArray, toCharSeq, toJavaArray, toJavaList, toJavaMap, toJavaOptional, toJavaSet, toJavaStream, toLazy, toList, toMap, toOption, toQueue, toSet, toStack, toStream, toString, toTree, toTry, toTry, toVector

Methods inherited from interface javaslang.algebra.Foldable
fold, fold, foldLeft, foldMap, foldRight

Methods inherited from interface javaslang.algebra.Monad
lift, lift, lift, lift, lift, lift, lift, lift

- Field Detail
 - EMPTY
```
static final Iterator<Object> EMPTY
```
 The empty Iterator.
- Method Detail
 - concat
```
@SafeVarargs
static <T> Iterator<T> concat(Iterable<? extends T>... iterables)
```
 Creates an Iterator which traverses along the concatenation of the given iterables.
 
 Type Parameters:
 
 T - Component type.
 
 Parameters:
 
 iterables - The iterables
 
 Returns:
 
 A new javaslang.collection.Iterator
 - concat
```
static <T> Iterator<T> concat(Iterable<? extends Iterable<? extends T>> iterables)
```
 Creates an Iterator which traverses along the concatenation of the given iterables.
 
 Type Parameters:
 
 T - Component type.
 
 Parameters:
 
 iterables - The iterable of iterables
 
 Returns:
 
 A new javaslang.collection.Iterator
 - empty
```
static <T> Iterator<T> empty()
```
 Returns the empty Iterator.
 
 Type Parameters:
 
 T - Component type
 
 Returns:
 
 The empty Iterator
 - of
```
static <T> Iterator<T> of(T element)
```
 Creates an Iterator which traverses one element.
 
 Type Parameters:
 
 T - Component type.
 
 Parameters:
 
 element - An element
 
 Returns:
 
 A new Iterator
 - of
```
@SafeVarargs
static <T> Iterator<T> of(T... elements)
```
 Creates an Iterator which traverses the given elements.
 
 Type Parameters:
 
 T - Component type
 
 Parameters:
 
 elements - Zero or more elements
 
 Returns:
 
 A new Iterator
 - ofAll
```
static <T> Iterator<T> ofAll(Iterable<? extends T> iterable)
```
 Creates an Iterator based on the given java.lang.Iterable. This is a convenience method for Iterator.of(iterable.iterator().
 
 Type Parameters:
 
 T - Component type.
 
 Parameters:
 
 iterable - A Iterable
 
 Returns:
 
 A new javaslang.collection.Iterator
 - ofAll
```
static <T> Iterator<T> ofAll(Iterator<? extends T> iterator)
```
 Creates an Iterator based on the given Iterator by delegating calls of hasNext() and next() to it.
 
 Type Parameters:
 
 T - Component type.
 
 Parameters:
 
 iterator - A Iterator
 
 Returns:
 
 A new javaslang.collection.Iterator
 - ofAll
```
static Iterator<Boolean> ofAll(boolean[] array)
```
 Creates an Iterator based on the elements of a boolean array.
 
 Parameters:
 
 array - a boolean array
 
 Returns:
 
 A new Iterator of Boolean values
 - ofAll
```
static Iterator<Byte> ofAll(byte[] array)
```
 Creates an Iterator based on the elements of a byte array.
 
 Parameters:
 
 array - a byte array
 
 Returns:
 
 A new Iterator of Byte values
 - ofAll
```
static Iterator<Character> ofAll(char[] array)
```
 Creates an Iterator based on the elements of a char array.
 
 Parameters:
 
 array - a char array
 
 Returns:
 
 A new Iterator of Character values
 - ofAll
```
static Iterator<Double> ofAll(double[] array)
```
 Creates ann Iterator based on the elements of a double array.
 
 Parameters:
 
 array - a double array
 
 Returns:
 
 A new Iterator of Double values
 - ofAll
```
static Iterator<Float> ofAll(float[] array)
```
 Creates an Iterator based on the elements of a float array.
 
 Parameters:
 
 array - a float array
 
 Returns:
 
 A new Iterator of Float values
 - ofAll
```
static Iterator<Integer> ofAll(int[] array)
```
 Creates an Iterator based on the elements of an int array.
 
 Parameters:
 
 array - an int array
 
 Returns:
 
 A new Iterator of Integer values
 - ofAll
```
static Iterator<Long> ofAll(long[] array)
```
 Creates an Iterator based on the elements of a long array.
 
 Parameters:
 
 array - a long array
 
 Returns:
 
 A new Iterator of Long values
 - ofAll
```
static Iterator<Short> ofAll(short[] array)
```
 Creates an Iterator based on the elements of a short array.
 
 Parameters:
 
 array - a short array
 
 Returns:
 
 A new Iterator of Short values
 - range
```
static Iterator<Character> range(char from,
 char toExclusive)
```
 Creates an Iterator of characters starting from from, extending to toExclusive - 1.
 Examples:
```
 
 Iterator.range('a', 'c') // = ('a', 'b')
 Iterator.range('c', 'a') // = ()
 
 
```
 Parameters:
 
 from - the first character
 
 toExclusive - the successor of the last character
 
 Returns:
 
 a range of characters as specified or the empty range if from >= toExclusive
 - rangeBy
```
static Iterator<Character> rangeBy(char from,
 char toExclusive,
 int step)
```
 Creates an Iterator of characters starting from from, extending to toExclusive - 1, with step.
 Examples:
```
 
 Iterator.rangeBy('a', 'c', 1) // = ('a', 'b')
 Iterator.rangeBy('a', 'd', 2) // = ('a', 'c')
 Iterator.rangeBy('d', 'a', -2) // = ('d', 'b')
 Iterator.rangeBy('d', 'a', 2) // = ()
 
 
```
 Parameters:
 
 from - the first character
 
 toExclusive - the successor of the last character if step > 0, the predecessor of the last character if step < 0
 
 step - the step
 
 Returns:
 
 a range of characters as specified or the empty range if (from == toExclusive) || (step * (from - toExclusive) > 0).
 
 Throws:
 
 IllegalArgumentException - if step is zero
 - rangeBy
```
static Iterator<Double> rangeBy(double from,
 double toExclusive,
 double step)
```
 - range
```
static Iterator<Integer> range(int from,
 int toExclusive)
```
 Creates an Iterator of int numbers starting from from, extending to toExclusive - 1.
 Examples:
```
 
 Iterator.range(0, 0) // = ()
 Iterator.range(2, 0) // = ()
 Iterator.range(-2, 2) // = (-2, -1, 0, 1)
 
 
```
 Parameters:
 
 from - the first number
 
 toExclusive - the last number + 1
 
 Returns:
 
 a range of int values as specified or the empty range if from >= toExclusive
 - rangeBy
```
static Iterator<Integer> rangeBy(int from,
 int toExclusive,
 int step)
```
 Creates an Iterator of int numbers starting from from, extending to toExclusive - 1, with step.
 Examples:
```
 
 Iterator.rangeBy(1, 3, 1) // = (1, 2)
 Iterator.rangeBy(1, 4, 2) // = (1, 3)
 Iterator.rangeBy(4, 1, -2) // = (4, 2)
 Iterator.rangeBy(4, 1, 2) // = ()
 
 
```
 Parameters:
 
 from - the first number
 
 toExclusive - the last number + 1 if step > 0, the last number - 1 if step < 0
 
 step - the step
 
 Returns:
 
 a range of long values as specified or the empty range if (from == toExclusive) || (step * (from - toExclusive) > 0).
 
 Throws:
 
 IllegalArgumentException - if step is zero
 - range
```
static Iterator<Long> range(long from,
 long toExclusive)
```
 Creates an Iterator of long numbers starting from from, extending to toExclusive - 1.
 Examples:
```
 
 Iterator.range(0L, 0L) // = ()
 Iterator.range(2L, 0L) // = ()
 Iterator.range(-2L, 2L) // = (-2L, -1L, 0L, 1L)
 
 
```
 Parameters:
 
 from - the first number
 
 toExclusive - the last number + 1
 
 Returns:
 
 a range of long values as specified or the empty range if from >= toExclusive
 - rangeBy
```
static Iterator<Long> rangeBy(long from,
 long toExclusive,
 long step)
```
 Creates an Iterator of long numbers starting from from, extending to toExclusive - 1, with step.
 Examples:
```
 
 Iterator.rangeBy(1L, 3L, 1L) // = (1L, 2L)
 Iterator.rangeBy(1L, 4L, 2L) // = (1L, 3L)
 Iterator.rangeBy(4L, 1L, -2L) // = (4L, 2L)
 Iterator.rangeBy(4L, 1L, 2L) // = ()
 
 
```
 Parameters:
 
 from - the first number
 
 toExclusive - the last number + 1 if step > 0, the last number - 1 if step < 0
 
 step - the step
 
 Returns:
 
 a range of long values as specified or the empty range if (from == toExclusive) || (step * (from - toExclusive) > 0).
 
 Throws:
 
 IllegalArgumentException - if step is zero
 - rangeClosed
```
static Iterator<Character> rangeClosed(char from,
 char toInclusive)
```
 Creates an Iterator of characters starting from from, extending to toInclusive.
 Examples:
```
 
 Iterator.rangeClosed('a', 'c') // = ('a', 'b', 'c')
 Iterator.rangeClosed('c', 'a') // = ()
 
 
```
 Parameters:
 
 from - the first character
 
 toInclusive - the last character
 
 Returns:
 
 a range of characters as specified or the empty range if from > toInclusive
 - rangeClosedBy
```
static Iterator<Character> rangeClosedBy(char from,
 char toInclusive,
 int step)
```
 Creates an Iterator of characters starting from from, extending to toInclusive, with step.
 Examples:
```
 
 Iterator.rangeClosedBy('a', 'c', 1) // = ('a', 'b', 'c')
 Iterator.rangeClosedBy('a', 'd', 2) // = ('a', 'c')
 Iterator.rangeClosedBy('d', 'a', -2) // = ('d', 'b')
 Iterator.rangeClosedBy('d', 'a', 2) // = ()
 
 
```
 Parameters:
 
 from - the first character
 
 toInclusive - the last character
 
 step - the step
 
 Returns:
 
 a range of characters as specified or the empty range if step * (from - toInclusive) > 0.
 
 Throws:
 
 IllegalArgumentException - if step is zero
 - rangeClosedBy
```
static Iterator<Double> rangeClosedBy(double from,
 double toInclusive,
 double step)
```
 - rangeClosed
```
static Iterator<Integer> rangeClosed(int from,
 int toInclusive)
```
 Creates an Iterator of int numbers starting from from, extending to toInclusive.
 Examples:
```
 
 Iterator.rangeClosed(0, 0) // = (0)
 Iterator.rangeClosed(2, 0) // = ()
 Iterator.rangeClosed(-2, 2) // = (-2, -1, 0, 1, 2)
 
 
```
 Parameters:
 
 from - the first number
 
 toInclusive - the last number
 
 Returns:
 
 a range of int values as specified or the empty range if from > toInclusive
 - rangeClosedBy
```
static Iterator<Integer> rangeClosedBy(int from,
 int toInclusive,
 int step)
```
 Creates an Iterator of int numbers starting from from, extending to toInclusive, with step.
 Examples:
```
 
 Iterator.rangeClosedBy(1, 3, 1) // = (1, 2, 3)
 Iterator.rangeClosedBy(1, 4, 2) // = (1, 3)
 Iterator.rangeClosedBy(4, 1, -2) // = (4, 2)
 Iterator.rangeClosedBy(4, 1, 2) // = ()
 
 
```
 Parameters:
 
 from - the first number
 
 toInclusive - the last number
 
 step - the step
 
 Returns:
 
 a range of int values as specified or the empty range if step * (from - toInclusive) > 0.
 
 Throws:
 
 IllegalArgumentException - if step is zero
 - rangeClosed
```
static Iterator<Long> rangeClosed(long from,
 long toInclusive)
```
 Creates an Iterator of long numbers starting from from, extending to toInclusive.
 Examples:
```
 
 Iterator.rangeClosed(0L, 0L) // = (0L)
 Iterator.rangeClosed(2L, 0L) // = ()
 Iterator.rangeClosed(-2L, 2L) // = (-2L, -1L, 0L, 1L, 2L)
 
 
```
 Parameters:
 
 from - the first number
 
 toInclusive - the last number
 
 Returns:
 
 a range of long values as specified or the empty range if from > toInclusive
 - rangeClosedBy
```
static Iterator<Long> rangeClosedBy(long from,
 long toInclusive,
 long step)
```
 Creates an Iterator of long numbers starting from from, extending to toInclusive, with step.
 Examples:
```
 
 Iterator.rangeClosedBy(1L, 3L, 1L) // = (1L, 2L, 3L)
 Iterator.rangeClosedBy(1L, 4L, 2L) // = (1L, 3L)
 Iterator.rangeClosedBy(4L, 1L, -2L) // = (4L, 2L)
 Iterator.rangeClosedBy(4L, 1L, 2L) // = ()
 
 
```
 Parameters:
 
 from - the first number
 
 toInclusive - the last number
 
 step - the step
 
 Returns:
 
 a range of int values as specified or the empty range if step * (from - toInclusive) > 0.
 
 Throws:
 
 IllegalArgumentException - if step is zero
 - from
```
static Iterator<Integer> from(int value)
```
 Returns an infinitely iterator of int values starting from from.
 The Iterator extends to Integer.MIN_VALUE when passing Integer.MAX_VALUE.
 
 Parameters:
 
 value - a start int value
 
 Returns:
 
 a new Iterator of int values starting from from
 - from
```
static Iterator<Long> from(long value)
```
 Returns an infinitely iterator of long values starting from from.
 The Iterator extends to Long.MIN_VALUE when passing Long.MAX_VALUE.
 
 Parameters:
 
 value - a start long value
 
 Returns:
 
 a new Iterator of long values starting from from
 - gen
```
static <T> Iterator<T> gen(java.util.function.Supplier<? extends T> supplier)
```
 Generates an infinitely iterator using a value Supplier.
 
 Type Parameters:
 
 T - value type
 
 Parameters:
 
 supplier - A Supplier of iterator values
 
 Returns:
 
 A new Iterator
 - gen
```
static <T> Iterator<T> gen(T seed,
 java.util.function.Function<? super T,? extends T> f)
```
 Generates an infinitely iterator using a function to calculate the next value based on the previous.
 
 Type Parameters:
 
 T - value type
 
 Parameters:
 
 seed - The first value in the iterator
 
 f - A function to calculate the next value based on the previous
 
 Returns:
 
 A new Iterator
 - repeat
```
static <T> Iterator<T> repeat(T t)
```
 Repeats an element infinitely often.
 
 Type Parameters:
 
 T - Element type
 
 Parameters:
 
 t - An element
 
 Returns:
 
 A new Iterator containing infinite t's.
 - concat
```
default Iterator<T> concat(Iterator<T> that)
```
 - intersperse
```
default Iterator<T> intersperse(T element)
```
 Inserts an element between all elements of this Iterator.
 
 Parameters:
 
 element - An element.
 
 Returns:
 
 an interspersed version of this
 - zip
```
default  Iterator<Tuple2<T,U>> zip(Iterable that)
```
 Description copied from interface: Traversable
 
 Returns a traversable formed from this traversable and another java.lang.Iterable collection by combining corresponding elements in pairs. If one of the two iterables is longer than the other, its remaining elements are ignored.
 The length of the returned traversable is the minimum of the lengths of this traversable and that iterable.
 
 Specified by:
 
 zip in interface Traversable<T>
 
 Type Parameters:
 
 U - The type of the second half of the returned pairs.
 
 Parameters:
 
 that - The java.lang.Iterable providing the second half of each result pair.
 
 Returns:
 
 a new traversable containing pairs consisting of corresponding elements of this traversable and that iterable.
 - zipAll
```
default  Iterator<Tuple2<T,U>> zipAll(Iterable that,
 T thisElem,
 U thatElem)
```
 Description copied from interface: Traversable
 
 Returns a traversable formed from this traversable and another java.lang.Iterable by combining corresponding elements in pairs. If one of the two collections is shorter than the other, placeholder elements are used to extend the shorter collection to the length of the longer.
 The length of the returned traversable is the maximum of the lengths of this traversable and that iterable.
 Special case: if this traversable is shorter than that elements, and that elements contains duplicates, the resulting traversable may be shorter than the maximum of the lengths of this and that because a traversable contains an element at most once.
 If this Traversable is shorter than that, thisElem values are used to fill the result. If that is shorter than this Traversable, thatElem values are used to fill the result.
 
 Specified by:
 
 zipAll in interface Traversable<T>
 
 Type Parameters:
 
 U - The type of the second half of the returned pairs.
 
 Parameters:
 
 that - The java.lang.Iterable providing the second half of each result pair.
 
 thisElem - The element to be used to fill up the result if this traversable is shorter than that.
 
 thatElem - The element to be used to fill up the result if that is shorter than this traversable.
 
 Returns:
 
 A new traversable containing pairs consisting of corresponding elements of this traversable and that.
 - zipWithIndex
```
default Iterator<Tuple2<T,Integer>> zipWithIndex()
```
 Description copied from interface: Traversable
 
 Zips this traversable with its indices.
 
 Specified by:
 
 zipWithIndex in interface Traversable<T>
 
 Returns:
 
 A new traversable containing all elements of this traversable paired with their index, starting with 0.
 - unzip
```
default <T1,T2> Tuple2<Iterator<T1>,Iterator<T2>> unzip(java.util.function.Function<? super T,Tuple2<? extends T1,? extends T2>> unzipper)
```
 Description copied from interface: Traversable
 
 Unzips this elements by mapping this elements to pairs which are subsequently split into two distinct sets.
 
 Specified by:
 
 unzip in interface Traversable<T>
 
 Type Parameters:
 
 T1 - 1st element type of a pair returned by unzipper
 
 T2 - 2nd element type of a pair returned by unzipper
 
 Parameters:
 
 unzipper - a function which converts elements of this to pairs
 
 Returns:
 
 A pair of set containing elements split by unzipper
 - unzip3
```
default <T1,T2,T3> Tuple3<Iterator<T1>,Iterator<T2>,Iterator<T3>> unzip3(java.util.function.Function<? super T,Tuple3<? extends T1,? extends T2,? extends T3>> unzipper)
```
 Description copied from interface: Traversable
 
 Unzips this elements by mapping this elements to triples which are subsequently split into three distinct sets.
 
 Specified by:
 
 unzip3 in interface Traversable<T>
 
 Type Parameters:
 
 T1 - 1st element type of a triplet returned by unzipper
 
 T2 - 2nd element type of a triplet returned by unzipper
 
 T3 - 3rd element type of a triplet returned by unzipper
 
 Parameters:
 
 unzipper - a function which converts elements of this to pairs
 
 Returns:
 
 A triplet of set containing elements split by unzipper
 - clear
```
default Iterator<T> clear()
```
 Description copied from interface: Traversable
 
 Returns an empty version of this traversable, i.e. this.clear().isEmpty() == true.
 
 Specified by:
 
 clear in interface Traversable<T>
 
 Returns:
 
 an empty Traversable.
 - distinct
```
default Iterator<T> distinct()
```
 Description copied from interface: Traversable
 
 Returns a new version of this which contains no duplicates. Elements are compared using equals.
 
 Specified by:
 
 distinct in interface Traversable<T>
 
 Returns:
 
 a new Traversable containing this elements without duplicates
 - distinctBy
```
default Iterator<T> distinctBy(Comparator<? super T> comparator)
```
 Description copied from interface: Traversable
 
 Returns a new version of this which contains no duplicates. Elements are compared using the given comparator.
 
 Specified by:
 
 distinctBy in interface Traversable<T>
 
 Parameters:
 
 comparator - A comparator
 
 Returns:
 
 a new Traversable containing this elements without duplicates
 - distinctBy
```
default  Iterator<T> distinctBy(java.util.function.Function<? super T,? extends U> keyExtractor)
```
 Description copied from interface: Traversable
 
 Returns a new version of this which contains no duplicates. Elements mapped to keys which are compared using equals.
 The elements of the result are determined in the order of their occurrence - first match wins.
 
 Specified by:
 
 distinctBy in interface Traversable<T>
 
 Type Parameters:
 
 U - key type
 
 Parameters:
 
 keyExtractor - A key extractor
 
 Returns:
 
 a new Traversable containing this elements without duplicates
 - drop
```
default Iterator<T> drop(int n)
```
 Removes up to n elements from this iterator.
 
 Specified by:
 
 drop in interface Traversable<T>
 
 Parameters:
 
 n - A number
 
 Returns:
 
 The empty iterator, if n <= 0 or this is empty, otherwise a new iterator without the first n elements.
 - dropRight
```
default Iterator<T> dropRight(int n)
```
 Description copied from interface: Traversable
 
 Drops the last n elements of this or all elements, if this length < n.
 
 Specified by:
 
 dropRight in interface Traversable<T>
 
 Parameters:
 
 n - The number of elements to drop.
 
 Returns:
 
 a new instance consisting of all elements of this except the last n ones, or else the empty instance, if this has less than n elements.
 - dropUntil
```
default Iterator<T> dropUntil(java.util.function.Predicate<? super T> predicate)
```
 Description copied from interface: Traversable
 
 Drops elements until the predicate holds for the current element.
 Note: This is essentially the same as dropWhile(predicate.negate()). It is intended to be used with method references, which cannot be negated directly.
 
 Specified by:
 
 dropUntil in interface Traversable<T>
 
 Parameters:
 
 predicate - A condition tested subsequently for this elements.
 
 Returns:
 
 a new instance consisting of all elements starting from the first one which does satisfy the given predicate.
 - dropWhile
```
default Iterator<T> dropWhile(java.util.function.Predicate<? super T> predicate)
```
 Description copied from interface: Traversable
 
 Drops elements while the predicate holds for the current element.
 
 Specified by:
 
 dropWhile in interface Traversable<T>
 
 Parameters:
 
 predicate - A condition tested subsequently for this elements starting with the first.
 
 Returns:
 
 a new instance consisting of all elements starting from the first one which does not satisfy the given predicate.
 - filter
```
default Iterator<T> filter(java.util.function.Predicate<? super T> predicate)
```
 Returns an Iterator that contains elements that satisfy the given predicate.
 
 Specified by:
 
 filter in interface Monad<T>
 
 Specified by:
 
 filter in interface Traversable<T>
 
 Specified by:
 
 filter in interface Value<T>
 
 Parameters:
 
 predicate - A predicate
 
 Returns:
 
 A new Iterator
 - findLast
```
default Option<T> findLast(java.util.function.Predicate<? super T> predicate)
```
 Description copied from interface: Traversable
 
 Returns the last element of this which satisfies the given predicate.
 Same as reverse().findFirst(predicate).
 
 Specified by:
 
 findLast in interface Traversable<T>
 
 Parameters:
 
 predicate - A predicate.
 
 Returns:
 
 Some(element) or None, where element may be null (i.e. List.of(null).findFirst(e -> e == null)).
 - flatMap
```
default  Iterator flatMap(java.util.function.Function<? super T,? extends Iterable<? extends U>> mapper)
```
 FlatMaps the elements of this Iterator to java.lang.Iterables, which are iterated in the order of occurrence.
 
 Specified by:
 
 flatMap in interface Monad<T>
 
 Specified by:
 
 flatMap in interface Traversable<T>
 
 Specified by:
 
 flatMap in interface Value<T>
 
 Type Parameters:
 
 U - Component type
 
 Parameters:
 
 mapper - A mapper
 
 Returns:
 
 A new java.lang.Iterable
 - foldRight
```
default  U foldRight(U zero,
 java.util.function.BiFunction<? super T,? super U,? extends U> f)
```
 Description copied from interface: Traversable
 
 Accumulates the elements of this Traversable by successively calling the given function f from the right, starting with a value zero of type B.
 Example: List.of("a", "b", "c").foldRight("", (x, xs) -> x + xs) = "abc"
 
 Specified by:
 
 foldRight in interface Foldable<T>
 
 Specified by:
 
 foldRight in interface Traversable<T>
 
 Specified by:
 
 foldRight in interface Value<T>
 
 Type Parameters:
 
 U - Result type of the accumulator.
 
 Parameters:
 
 zero - Value to start the accumulation with.
 
 f - The accumulator function.
 
 Returns:
 
 an accumulated version of this.
 - get
```
default T get()
```
 Description copied from interface: Value
 
 Gets the underlying value or throws if no value is present.
 
 Specified by:
 
 get in interface Traversable<T>
 
 Specified by:
 
 get in interface Value<T>
 
 Returns:
 
 the underlying value
 - groupBy
```
default <C> Map<C,Iterator<T>> groupBy(java.util.function.Function<? super T,? extends C> classifier)
```
 Description copied from interface: Traversable
 
 Groups this elements by classifying the elements.
 
 Specified by:
 
 groupBy in interface Traversable<T>
 
 Type Parameters:
 
 C - classified class type
 
 Parameters:
 
 classifier - A function which classifies elements into classes
 
 Returns:
 
 A Map containing the grouped elements
 - grouped
```
default Iterator<Seq<T>> grouped(int size)
```
 Description copied from interface: Traversable
 Groups this Traversable into fixed size blocks.
 Let length be the length of this Iterable. Then grouped is defined as follows:
 - If this.isEmpty(), the resulting Iterator is empty.
 - If size <= length, the resulting Iterator will contain length / size blocks of size size and maybe a non-empty block of size length % size, if there are remaining elements.
 - If size > length, the resulting Iterator will contain one block of size length.
 Examples:
```
 
 [].grouped(1) = []
 [].grouped(0) throws
 [].grouped(-1) throws
 [1,2,3,4].grouped(2) = [[1,2],[3,4]]
 [1,2,3,4,5].grouped(2) = [[1,2],[3,4],[5]]
 [1,2,3,4].grouped(5) = [[1,2,3,4]]
 
 
```
 Please note that grouped(int) is a special case of Traversable.sliding(int, int), i.e. grouped(size) is the same as sliding(size, size).
 Specified by:
 
 grouped in interface Traversable<T>
 
 Parameters:
 
 size - a positive block size
 
 Returns:
 
 A new Iterator of grouped blocks of the given size
 - hasDefiniteSize
```
default boolean hasDefiniteSize()
```
 Description copied from interface: Traversable
 
 Checks if this Traversable is known to have a finite size.
 This method should be implemented by classes only, i.e. not by interfaces.
 
 Specified by:
 
 hasDefiniteSize in interface Traversable<T>
 
 Returns:
 
 true, if this Traversable is known to hafe a finite size, false otherwise.
 - head
```
default T head()
```
 Description copied from interface: Traversable
 
 Returns the first element of a non-empty Traversable.
 
 Specified by:
 
 head in interface Traversable<T>
 
 Returns:
 
 The first element of this Traversable.
 - headOption
```
default Option<T> headOption()
```
 Description copied from interface: Traversable
 
 Returns the first element of a non-empty Traversable as Option.
 
 Specified by:
 
 headOption in interface Traversable<T>
 
 Returns:
 
 Some(element) or None if this is empty.
 - init
```
default Iterator<T> init()
```
 Description copied from interface: Traversable
 
 Dual of Traversable.tail(), returning all elements except the last.
 
 Specified by:
 
 init in interface Traversable<T>
 
 Returns:
 
 a new instance containing all elements except the last.
 - initOption
```
default Option<Iterator<T>> initOption()
```
 Description copied from interface: Traversable
 
 Dual of Traversable.tailOption(), returning all elements except the last as Option.
 
 Specified by:
 
 initOption in interface Traversable<T>
 
 Returns:
 
 Some(traversable) or None if this is empty.
 - isEmpty
```
default boolean isEmpty()
```
 Description copied from interface: Traversable
 
 Checks if this Traversable is empty.
 
 Specified by:
 
 isEmpty in interface Traversable<T>
 
 Specified by:
 
 isEmpty in interface Value<T>
 
 Returns:
 
 true, if this Traversable contains no elements, false otherwise.
 - isTraversableAgain
```
default boolean isTraversableAgain()
```
 Description copied from interface: Traversable
 
 Checks if this Traversable can be repeatedly traversed.
 This method should be implemented by classes only, i.e. not by interfaces.
 
 Specified by:
 
 isTraversableAgain in interface Traversable<T>
 
 Returns:
 
 true, if this Traversable is known to be traversable repeatedly, false otherwise.
 - iterator
```
default Iterator<T> iterator()
```
 Description copied from interface: Traversable
 
 An iterator by means of head() and tail(). Subclasses may want to override this method.
 
 Specified by:
 
 iterator in interface Iterable<T>
 
 Specified by:
 
 iterator in interface Traversable<T>
 
 Returns:
 
 A new Iterator of this Traversable elements.
 - length
```
default int length()
```
 Description copied from interface: Traversable
 
 Computes the number of elements of this.
 
 Specified by:
 
 length in interface Traversable<T>
 
 Returns:
 
 the number of elements
 - map
```
default  Iterator map(java.util.function.Function<? super T,? extends U> mapper)
```
 Maps the elements of this Iterator lazily using the given mapper.
 
 Specified by:
 
 map in interface Functor<T>
 
 Specified by:
 
 map in interface Monad<T>
 
 Specified by:
 
 map in interface Traversable<T>
 
 Specified by:
 
 map in interface Value<T>
 
 Type Parameters:
 
 U - Component type
 
 Parameters:
 
 mapper - A mapper.
 
 Returns:
 
 A new Iterator
 - partition
```
default Tuple2<Iterator<T>,Iterator<T>> partition(java.util.function.Predicate<? super T> predicate)
```
 Description copied from interface: Traversable
 
 Creates a partition of this Traversable by splitting this elements in two in distinct tarversables according to a predicate.
 
 Specified by:
 
 partition in interface Traversable<T>
 
 Parameters:
 
 predicate - A predicate which classifies an element if it is in the first or the second traversable.
 
 Returns:
 
 A disjoint union of two traversables. The first Traversable contains all elements that satisfy the given predicate, the second Traversable contains all elements that don't. The original order of elements is preserved.
 - peek
```
default Iterator<T> peek(java.util.function.Consumer<? super T> action)
```
 Description copied from interface: Value
 
 Performs the given action on the first element if this is an eager implementation. Performs the given action on all elements (the first immediately, successive deferred), if this is a lazy implementation.
 
 Specified by:
 
 peek in interface Traversable<T>
 
 Specified by:
 
 peek in interface Value<T>
 
 Parameters:
 
 action - The action that will be performed on the element(s).
 
 Returns:
 
 this instance
 - reduceLeft
```
default T reduceLeft(java.util.function.BiFunction<? super T,? super T,? extends T> op)
```
 Description copied from interface: Traversable
 
 Accumulates the elements of this Traversable by successively calling the given operation op from the left.
 
 Specified by:
 
 reduceLeft in interface Traversable<T>
 
 Parameters:
 
 op - A BiFunction of type T
 
 Returns:
 
 the reduced value.
 - reduceRight
```
default T reduceRight(java.util.function.BiFunction<? super T,? super T,? extends T> op)
```
 Description copied from interface: Traversable
 
 Accumulates the elements of this Traversable by successively calling the given operation op from the right.
 
 Specified by:
 
 reduceRight in interface Traversable<T>
 
 Parameters:
 
 op - An operation of type T
 
 Returns:
 
 the reduced value.
 - replace
```
default Iterator<T> replace(T currentElement,
 T newElement)
```
 Description copied from interface: Traversable
 
 Replaces the first occurrence (if exists) of the given currentElement with newElement.
 
 Specified by:
 
 replace in interface Traversable<T>
 
 Parameters:
 
 currentElement - An element to be substituted.
 
 newElement - A replacement for currentElement.
 
 Returns:
 
 a Traversable containing all elements of this where the first occurrence of currentElement is replaced with newELement.
 - replaceAll
```
default Iterator<T> replaceAll(T currentElement,
 T newElement)
```
 Description copied from interface: Traversable
 
 Replaces all occurrences of the given currentElement with newElement.
 
 Specified by:
 
 replaceAll in interface Traversable<T>
 
 Parameters:
 
 currentElement - An element to be substituted.
 
 newElement - A replacement for currentElement.
 
 Returns:
 
 a Traversable containing all elements of this where all occurrences of currentElement are replaced with newELement.
 - retainAll
```
default Iterator<T> retainAll(Iterable<? extends T> elements)
```
 Description copied from interface: Traversable
 
 Keeps all occurrences of the given elements from this.
 
 Specified by:
 
 retainAll in interface Traversable<T>
 
 Parameters:
 
 elements - Elements to be kept.
 
 Returns:
 
 a Traversable containing all occurrences of the given elements.
 - scan
```
default Traversable<T> scan(T zero,
 java.util.function.BiFunction<? super T,? super T,? extends T> operation)
```
 Description copied from interface: Traversable
 
 Computes a prefix scan of the elements of the collection. Note: The neutral element z may be applied more than once.
 
 Specified by:
 
 scan in interface Traversable<T>
 
 Parameters:
 
 zero - neutral element for the operator op
 
 operation - the associative operator for the scan
 
 Returns:
 
 a new traversable collection containing the prefix scan of the elements in this traversable collection
 - scanLeft
```
default  Iterator scanLeft(U zero,
 java.util.function.BiFunction<? super U,? super T,? extends U> operation)
```
 Description copied from interface: Traversable
 
 Produces a collection containing cumulative results of applying the operator going left to right. Note: will not terminate for infinite-sized collections. Note: might return different results for different runs, unless the underlying collection type is ordered.
 
 Specified by:
 
 scanLeft in interface Traversable<T>
 
 Type Parameters:
 
 U - the type of the elements in the resulting collection
 
 Parameters:
 
 zero - the initial value
 
 operation - the binary operator applied to the intermediate result and the element
 
 Returns:
 
 collection with intermediate results
 - scanRight
```
default  Iterator scanRight(U zero,
 java.util.function.BiFunction<? super T,? super U,? extends U> operation)
```
 Description copied from interface: Traversable
 
 Produces a collection containing cumulative results of applying the operator going right to left. The head of the collection is the last cumulative result. Note: will not terminate for infinite-sized collections. Note: might return different results for different runs, unless the underlying collection type is ordered.
 
 Specified by:
 
 scanRight in interface Traversable<T>
 
 Type Parameters:
 
 U - the type of the elements in the resulting collection
 
 Parameters:
 
 zero - the initial value
 
 operation - the binary operator applied to the intermediate result and the element
 
 Returns:
 
 collection with intermediate results
 - sliding
```
default Iterator<Seq<T>> sliding(int size)
```
 Description copied from interface: Traversable
 
 Slides a window of a specific size and step size 1 over this Traversable by calling Traversable.sliding(int, int).
 
 Specified by:
 
 sliding in interface Traversable<T>
 
 Parameters:
 
 size - a positive window size
 
 Returns:
 
 a new Iterator of windows of a specific size using step size 1
 - sliding
```
default Iterator<Seq<T>> sliding(int size,
 int step)
```
 Description copied from interface: Traversable
 Slides a window of a specific size and step size over this Traversable.
 Examples:
```
 
 [].sliding(1,1) = []
 [1,2,3,4,5].sliding(2,3) = [[1,2],[4,5]]
 [1,2,3,4,5].sliding(2,4) = [[1,2],[5]]
 [1,2,3,4,5].sliding(2,5) = [[1,2]]
 [1,2,3,4].sliding(5,3) = [[1,2,3,4],[4]]
 
 
```
 Specified by:
 
 sliding in interface Traversable<T>
 
 Parameters:
 
 size - a positive window size
 
 step - a positive step size
 
 Returns:
 
 a new Iterator of windows of a specific size using a specific step size
 - span
```
default Tuple2<Iterator<T>,Iterator<T>> span(java.util.function.Predicate<? super T> predicate)
```
 Description copied from interface: Traversable
 
 Returns a tuple where the first element is the longest prefix of elements that satisfy the given predicate and the second element is the remainder.
 
 Specified by:
 
 span in interface Traversable<T>
 
 Parameters:
 
 predicate - A predicate.
 
 Returns:
 
 a Tuple containing the longest prefix of elements that satisfy p and the remainder.
 - spliterator
```
default Spliterator<T> spliterator()
```
 Specified by:
 
 spliterator in interface Iterable<T>
 - tail
```
default Iterator<T> tail()
```
 Description copied from interface: Traversable
 
 Drops the first element of a non-empty Traversable.
 
 Specified by:
 
 tail in interface Traversable<T>
 
 Returns:
 
 A new instance of Traversable containing all elements except the first.
 - tailOption
```
default Option<Iterator<T>> tailOption()
```
 Description copied from interface: Traversable
 
 Drops the first element of a non-empty Traversable and returns an Option.
 
 Specified by:
 
 tailOption in interface Traversable<T>
 
 Returns:
 
 Some(traversable) or None if this is empty.
 - take
```
default Iterator<T> take(int n)
```
 Take the first n elements from this iterator.
 
 Specified by:
 
 take in interface Traversable<T>
 
 Parameters:
 
 n - A number
 
 Returns:
 
 The empty iterator, if n <= 0 or this is empty, otherwise a new iterator without the first n elements.
 - takeRight
```
default Iterator<T> takeRight(int n)
```
 Description copied from interface: Traversable
 
 Takes the last n elements of this or all elements, if this length < n.
 The result is equivalent to sublist(max(0, min(length(), length() - n)), n), i.e. takeRight will not throw if n < 0 or n > length().
 In the case of n < 0 the empty instance is returned, in the case of n > length() this is returned.
 
 Specified by:
 
 takeRight in interface Traversable<T>
 
 Parameters:
 
 n - The number of elements to take.
 
 Returns:
 
 A new instance consisting the first n elements of this or all elements, if this has less than n elements.
 - takeUntil
```
default Iterator<T> takeUntil(java.util.function.Predicate<? super T> predicate)
```
 Description copied from interface: Traversable
 
 Takes elements until the predicate holds for the current element.
 Note: This is essentially the same as takeWhile(predicate.negate()). It is intended to be used with method references, which cannot be negated directly.
 
 Specified by:
 
 takeUntil in interface Traversable<T>
 
 Parameters:
 
 predicate - A condition tested subsequently for this elements.
 
 Returns:
 
 a new instance consisting of all elements until the first which does satisfy the given predicate.
 - takeWhile
```
default Iterator<T> takeWhile(java.util.function.Predicate<? super T> predicate)
```
 Description copied from interface: Traversable
 
 Takes elements while the predicate holds for the current element.
 
 Specified by:
 
 takeWhile in interface Traversable<T>
 
 Parameters:
 
 predicate - A condition tested subsequently for the contained elements.
 
 Returns:
 
 a new instance consisting of all elements until the first which does not satisfy the given predicate.
 - corresponds
```
default  boolean corresponds(Iterable that,
 java.util.function.BiPredicate<? super T,? super U> predicate)
```
 Tests whether every element of this iterable relates to the corresponding element of another iterable by satisfying a test predicate.
 
 Type Parameters:
 
 U - Component type of that iterable
 
 Parameters:
 
 that - the other iterable
 
 predicate - the test predicate, which relates elements from both iterables
 
 Returns:
 
 true if both iterables have the same length and predicate(x, y) is true for all corresponding elements x of this iterable and y of that, otherwise false.
 - eq
```
default boolean eq(Object o)
```
 A smoothing replacement for equals. It is similar to Scala's == but better in the way that it is not limited to collection types, e.g. Some(1) eq List(1), None eq Failure(x) etc.
 In a nutshell: eq checks congruence of structures and equality of contained values.
 Example:
```
 // ((1, 2), ((3))) => structure: (()(())) values: 1, 2, 3
 final Iterable<?> i1 = List.of(List.of(1, 2), Arrays.asList(List.of(3)));
 final Iterable<?> i2 = Queue.of(Stream.of(1, 2), List.of(Lazy.of(() -> 3)));
 assertThat(i1.eq(i2)).isTrue();
 
```
 Semantics:
```
 o == this : true
 o instanceof javaslang.Iterable : iterable elements are eq, non-iterable elements equals, for all (o1, o2) in (this, o)
 o instanceof java.lang.Iterable : this eq Iterator.of((java.lang.Iterable<?>) o);
 otherwise : false
 
```
 Parameters:
 
 o - An object
 
 Returns:
 
 true, if this equals o according to the rules defined above, otherwise false.
 - exists
```
default boolean exists(java.util.function.Predicate<? super T> predicate)
```
 Checks, if an element exists such that the predicate holds.
 
 Parameters:
 
 predicate - A Predicate
 
 Returns:
 
 true, if predicate holds for one or more elements, false otherwise
 
 Throws:
 
 NullPointerException - if predicate is null
 - forAll
```
default boolean forAll(java.util.function.Predicate<? super T> predicate)
```
 Checks, if the given predicate holds for all elements.
 
 Parameters:
 
 predicate - A Predicate
 
 Returns:
 
 true, if the predicate holds for all elements, false otherwise
 
 Throws:
 
 NullPointerException - if predicate is null
 - forEach
```
default void forEach(java.util.function.Consumer<? super T> action)
```
 Performs an action on each element.
 
 Specified by:
 
 forEach in interface Iterable<T>
 
 Parameters:
 
 action - A Consumer
 
 Throws:
 
 NullPointerException - if action is null
 - toJavaArray
```
default Object[] toJavaArray()
```
 Converts this value to an untyped Java array.
 
 Returns:
 
 A new Java array.
 - stderr
```
default void stderr()
```
 Sends the string representations of this value to the standard error stream System.err. If this value consists of multiple elements, each element is displayed in a new line.
 
 Throws:
 
 IllegalStateException - if PrintStream.checkError() is true after writing to stderr.
 - stdout
```
default void stdout()
```
 Sends the string representations of this value to the standard output stream System.out. If this value consists of multiple elements, each element is displayed in a new line.
 
 Throws:
 
 IllegalStateException - if PrintStream.checkError() is true after writing to stdout.

Interface Iterator<T>

Field Summary

Method Summary

Methods inherited from interface java.util.Iterator

Methods inherited from interface javaslang.collection.Traversable

Methods inherited from interface javaslang.Value

Methods inherited from interface javaslang.algebra.Foldable

Methods inherited from interface javaslang.algebra.Monad

Field Detail

EMPTY

Method Detail

concat

concat

empty

of

of

ofAll

ofAll

ofAll

ofAll

ofAll

ofAll

ofAll

ofAll

ofAll

ofAll

range

rangeBy

rangeBy

range

rangeBy

range

rangeBy

rangeClosed

rangeClosedBy

rangeClosedBy

rangeClosed

rangeClosedBy

rangeClosed

rangeClosedBy

from

from

gen

gen

repeat

concat

intersperse

zip

zipAll

zipWithIndex

unzip

unzip3

clear

distinct

distinctBy

distinctBy

drop

dropRight

dropUntil

dropWhile

filter

findLast

flatMap

foldRight

get

groupBy

grouped

hasDefiniteSize

head

headOption

init

initOption

isEmpty

isTraversableAgain

iterator

length

map

partition

peek

reduceLeft