Interface Stream<T>
-
- Type Parameters:
T- component type of this Stream
- All Superinterfaces:
Foldable<T>,java.util.function.Function<java.lang.Integer,T>,Function1<java.lang.Integer,T>,java.lang.Iterable<T>,LinearSeq<T>,PartialFunction<java.lang.Integer,T>,Seq<T>,java.io.Serializable,Traversable<T>,Value<T>
- All Known Implementing Classes:
Stream.Cons,Stream.Empty,StreamModule.AppendElements,StreamModule.ConsImpl
public interface Stream<T> extends LinearSeq<T>
An immutableStreamis lazy sequence of elements which may be infinitely long. Its immutability makes it suitable for concurrent programming.A
Streamis composed of aheadelement and a lazy evaluatedtailStream.There are two implementations of the
Streaminterface:Stream.Empty, which represents the emptyStream.Stream.Cons, which represents aStreamcontaining one or more elements.
Stream:
Factory method applications:// factory methods Stream.empty() // = Stream.of() = Nil.instance() Stream.of(x) // = new Cons<>(x, Nil.instance()) Stream.of(Object...) // e.g. Stream.of(1, 2, 3) Stream.ofAll(Iterable) // e.g. Stream.ofAll(List.of(1, 2, 3)) = 1, 2, 3 Stream.ofAll(<primitive array>) // e.g. List.ofAll(1, 2, 3) = 1, 2, 3 // int sequences Stream.from(0) // = 0, 1, 2, 3, ... Stream.range(0, 3) // = 0, 1, 2 Stream.rangeClosed(0, 3) // = 0, 1, 2, 3 // generators Stream.cons(Object, Supplier) // e.g. Stream.cons(current, () -> next(current)); Stream.continually(Supplier) // e.g. Stream.continually(Math::random); Stream.iterate(Object, Function)// e.g. Stream.iterate(1, i -> i * 2);
Example: Generating prime numbersStream<Integer> s1 = Stream.of(1); Stream<Integer> s2 = Stream.of(1, 2, 3); // = Stream.of(new Integer[] {1, 2, 3}); Stream<int[]> s3 = Stream.ofAll(1, 2, 3); Stream<List<Integer>> s4 = Stream.ofAll(List.of(1, 2, 3)); Stream<Integer> s5 = Stream.ofAll(1, 2, 3); Stream<Integer> s6 = Stream.ofAll(List.of(1, 2, 3)); // cuckoo's egg Stream<Integer[]> s7 = Stream.<Integer[]> of(new Integer[] {1, 2, 3});
See Okasaki, Chris: Purely Functional Data Structures (p. 34 ff.). Cambridge, 2003.// = Stream(2L, 3L, 5L, 7L, ...) Stream.iterate(2L, PrimeNumbers::nextPrimeFrom) // helpers static long nextPrimeFrom(long num) { return Stream.from(num + 1).find(PrimeNumbers::isPrime).get(); } static boolean isPrime(long num) { return !Stream.rangeClosed(2L, (long) Math.sqrt(num)).exists(d -> num % d == 0); }
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static classStream.Cons<T>Non-emptyStream, consisting of ahead, andtail.static classStream.Empty<T>The empty Stream.
-
Field Summary
Fields Modifier and Type Field Description static longserialVersionUID
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description default Stream<T>append(T element)Appends an element to this.default Stream<T>appendAll(java.lang.Iterable<? extends T> elements)Appends all given elements to this.default Stream<T>appendSelf(java.util.function.Function<? super Stream<T>,? extends Stream<T>> mapper)Appends itself to the end of stream withmapperfunction.default java.util.List<T>asJava()Creates an immutableListview on top of thisSeq, i.e.default Stream<T>asJava(java.util.function.Consumer<? super java.util.List<T>> action)Creates an immutableListview on top of thisSeqthat is passed to the givenaction.default java.util.List<T>asJavaMutable()Creates a mutableListview on top of thisSeq, i.e.default Stream<T>asJavaMutable(java.util.function.Consumer<? super java.util.List<T>> action)Creates a mutableListview on top of thisSeqthat is passed to the givenaction.default <R> Stream<R>collect(PartialFunction<? super T,? extends R> partialFunction)Collects all elements that are in the domain of the givenpartialFunctionby mapping the elements to typeR.static <T> java.util.stream.Collector<T,java.util.ArrayList<T>,Stream<T>>collector()Returns aCollectorwhich may be used in conjunction withStream.collect(java.util.stream.Collector)to obtain aStream.default Stream<Stream<T>>combinations()Returns the union of all combinations from k = 0 to length().default Stream<Stream<T>>combinations(int k)Returns the k-combination of this traversable, i.e.static <T> Stream<T>concat(java.lang.Iterable<? extends java.lang.Iterable<? extends T>> iterables)Lazily creates a Stream in O(1) which traverses along the concatenation of the given iterables.static <T> Stream<T>concat(java.lang.Iterable<? extends T>... iterables)Lazily creates a Stream in O(1) which traverses along the concatenation of the given iterables.static <T> Stream<T>cons(T head, java.util.function.Supplier<? extends Stream<? extends T>> tailSupplier)Constructs a Stream of a head element and a tail supplier.static <T> Stream<T>continually(java.util.function.Supplier<? extends T> supplier)Generates an (theoretically) infinitely long Stream using a value Supplier.static <T> Stream<T>continually(T t)Repeats an element infinitely often.default Iterator<Stream<T>>crossProduct(int power)Calculates the n-ary cartesian power (or cross product or simply product) of this.default Stream<T>cycle()Repeat the elements of this Stream infinitely.default Stream<T>cycle(int count)Repeat the elements of this Streamcounttimes.default Stream<T>distinct()Returns a new version of this which contains no duplicates.default Stream<T>distinctBy(java.util.Comparator<? super T> comparator)Returns a new version of this which contains no duplicates.default <U> Stream<T>distinctBy(java.util.function.Function<? super T,? extends U> keyExtractor)Returns a new version of this which contains no duplicates.default Stream<T>drop(int n)Drops the first n elements of this or all elements, if this length < n.default Stream<T>dropRight(int n)Drops the last n elements of this or all elements, if this length < n.default Stream<T>dropRightUntil(java.util.function.Predicate<? super T> predicate)Drops elements until the predicate holds for the current element, starting from the end.default Stream<T>dropRightWhile(java.util.function.Predicate<? super T> predicate)Drops elements while the predicate holds for the current element, starting from the end.default Stream<T>dropUntil(java.util.function.Predicate<? super T> predicate)Drops elements until the predicate holds for the current element.default Stream<T>dropWhile(java.util.function.Predicate<? super T> predicate)Drops elements while the predicate holds for the current element.static <T> Stream<T>empty()Returns the single instance of Nil.default Stream<T>extend(java.util.function.Function<? super T,? extends T> nextFunction)Extends (continues) thisStreamwith a Stream of values created by applying consecutively providedFunctionto the last element of the original Stream.default Stream<T>extend(java.util.function.Supplier<? extends T> nextSupplier)Extends (continues) thisStreamwith values provided by aSupplierdefault Stream<T>extend(T next)Extends (continues) thisStreamwith a constantly repeated value.static <T> Stream<T>fill(int n, java.util.function.Supplier<? extends T> s)Returns a Stream containingnvalues supplied by a given Suppliers.static <T> Stream<T>fill(int n, T element)Returns a Stream containingntimes the givenelementdefault Stream<T>filter(java.util.function.Predicate<? super T> predicate)Returns a new traversable consisting of all elements which satisfy the given predicate.default <U> Stream<U>flatMap(java.util.function.Function<? super T,? extends java.lang.Iterable<? extends U>> mapper)FlatMaps this Traversable.static Stream<java.lang.Integer>from(int value)Returns an infinitely long Stream ofintvalues starting fromfrom.static Stream<java.lang.Integer>from(int value, int step)Returns an infinite long Stream ofintvalues starting fromvalueand spaced bystep.static Stream<java.lang.Long>from(long value)Returns an infinitely long Stream oflongvalues starting fromfrom.static Stream<java.lang.Long>from(long value, long step)Returns an infinite long Stream oflongvalues starting fromvalueand spaced bystep.default Tget(int index)Returns the element at the specified index.default <C> Map<C,Stream<T>>groupBy(java.util.function.Function<? super T,? extends C> classifier)Groups this elements by classifying the elements.default Iterator<Stream<T>>grouped(int size)Groups thisTraversableinto fixed size blocks.default booleanhasDefiniteSize()Checks if this Traversable is known to have a finite size.default intindexOf(T element, int from)Returns the index of the first occurrence of the given element after or at some start index or -1 if this does not contain the given element.default Stream<T>init()Dual of Traversable.tail(), returning all elements except the last.default Option<Stream<T>>initOption()Dual of Traversable.tailOption(), returning all elements except the last asOption.default Stream<T>insert(int index, T element)Inserts the given element at the specified index.default Stream<T>insertAll(int index, java.lang.Iterable<? extends T> elements)Inserts the given elements at the specified index.default Stream<T>intersperse(T element)Inserts an element between all elements of this Traversable.default booleanisAsync()AStreamis computed synchronously.default booleanisLazy()AStreamis computed lazily.default booleanisTraversableAgain()Checks if this Traversable can be repeatedly traversed.static <T> Stream<T>iterate(java.util.function.Supplier<? extends Option<? extends T>> supplier)Generates a (theoretically) infinitely long Stream using a repeatedly invoked supplier that provides aSomefor each next value and aNonefor the end.static <T> Stream<T>iterate(T seed, java.util.function.Function<? super T,? extends T> f)Generates a (theoretically) infinitely long Stream using a function to calculate the next value based on the previous.default Tlast()Dual of Traversable.head(), returning the last element.default intlastIndexOf(T element, int end)Returns the index of the last occurrence of the given element before or at a given end index or -1 if this does not contain the given element.default Stream<T>leftPadTo(int length, T element)A copy of this sequence with an element prepended until a given target length is reached.default intlength()Computes the number of elements of this Traversable.default <U> Stream<U>map(java.util.function.Function<? super T,? extends U> mapper)Maps the elements of thisTraversableto elements of a new type preserving their order, if any.static <T> Stream<T>narrow(Stream<? extends T> stream)Narrows a widenedStream<? extends T>toStream<T>by performing a type-safe cast.static <T> Stream<T>of(T element)Returns a singletonStream, i.e.static <T> Stream<T>of(T... elements)Creates a Stream of the given elements.static Stream<java.lang.Boolean>ofAll(boolean... elements)Creates a Stream from boolean values.static Stream<java.lang.Byte>ofAll(byte... elements)Creates a Stream from byte values.static Stream<java.lang.Character>ofAll(char... elements)Creates a Stream from char values.static Stream<java.lang.Double>ofAll(double... elements)Creates a Stream values double values.static Stream<java.lang.Float>ofAll(float... elements)Creates a Stream from float values.static Stream<java.lang.Integer>ofAll(int... elements)Creates a Stream from int values.static Stream<java.lang.Long>ofAll(long... elements)Creates a Stream from long values.static Stream<java.lang.Short>ofAll(short... elements)Creates a Stream from short values.static <T> Stream<T>ofAll(java.lang.Iterable<? extends T> elements)Creates a Stream of the given elements.static <T> Stream<T>ofAll(java.util.stream.Stream<? extends T> javaStream)Creates a Stream that contains the elements of the givenStream.default Stream<T>orElse(java.lang.Iterable<? extends T> other)Returns thisTraversableif it is nonempty, otherwise return the alternative.default Stream<T>orElse(java.util.function.Supplier<? extends java.lang.Iterable<? extends T>> supplier)Returns thisTraversableif it is nonempty, otherwise return the result of evaluating supplier.default Stream<T>padTo(int length, T element)A copy of this sequence with an element appended until a given target length is reached.default Tuple2<Stream<T>,Stream<T>>partition(java.util.function.Predicate<? super T> predicate)Creates a partition of thisTraversableby splitting this elements in two in distinct traversables according to a predicate.default Stream<T>patch(int from, java.lang.Iterable<? extends T> that, int replaced)Produces a new list where a slice of elements in this list is replaced by another sequence.default Stream<T>peek(java.util.function.Consumer<? super T> action)Performs the givenactionon the first element if this is an eager implementation.default Stream<Stream<T>>permutations()Computes all unique permutations.default Stream<T>prepend(T element)Prepends an element to this.default Stream<T>prependAll(java.lang.Iterable<? extends T> elements)Prepends all given elements to this.static Stream<java.lang.Character>range(char from, char toExclusive)static Stream<java.lang.Integer>range(int from, int toExclusive)Creates a Stream of int numbers starting fromfrom, extending totoExclusive - 1.static Stream<java.lang.Long>range(long from, long toExclusive)Creates a Stream of long numbers starting fromfrom, extending totoExclusive - 1.static Stream<java.lang.Character>rangeBy(char from, char toExclusive, int step)static Stream<java.lang.Double>rangeBy(double from, double toExclusive, double step)static Stream<java.lang.Integer>rangeBy(int from, int toExclusive, int step)Creates a Stream of int numbers starting fromfrom, extending totoExclusive - 1, withstep.static Stream<java.lang.Long>rangeBy(long from, long toExclusive, long step)Creates a Stream of long numbers starting fromfrom, extending totoExclusive - 1, withstep.static Stream<java.lang.Character>rangeClosed(char from, char toInclusive)static Stream<java.lang.Integer>rangeClosed(int from, int toInclusive)Creates a Stream of int numbers starting fromfrom, extending totoInclusive.static Stream<java.lang.Long>rangeClosed(long from, long toInclusive)Creates a Stream of long numbers starting fromfrom, extending totoInclusive.static Stream<java.lang.Character>rangeClosedBy(char from, char toInclusive, int step)static Stream<java.lang.Double>rangeClosedBy(double from, double toInclusive, double step)static Stream<java.lang.Integer>rangeClosedBy(int from, int toInclusive, int step)Creates a Stream of int numbers starting fromfrom, extending totoInclusive, withstep.static Stream<java.lang.Long>rangeClosedBy(long from, long toInclusive, long step)Creates a Stream of long numbers starting fromfrom, extending totoInclusive, withstep.default Stream<T>reject(java.util.function.Predicate<? super T> predicate)Returns a new traversable consisting of all elements which do not satisfy the given predicate.default Stream<T>remove(T element)Removes the first occurrence of the given element.default Stream<T>removeAll(java.lang.Iterable<? extends T> elements)Removes all occurrences of the given elements.default Stream<T>removeAll(java.util.function.Predicate<? super T> predicate)Deprecated.default Stream<T>removeAll(T element)Removes all occurrences of the given element.default Stream<T>removeAt(int index)Removes the element at the specified position in this sequence.default Stream<T>removeFirst(java.util.function.Predicate<T> predicate)Removes the first occurrence that satisfy predicatedefault Stream<T>removeLast(java.util.function.Predicate<T> predicate)Removes the last occurrence that satisfy predicatedefault Stream<T>replace(T currentElement, T newElement)Replaces the first occurrence (if exists) of the given currentElement with newElement.default Stream<T>replaceAll(T currentElement, T newElement)Replaces all occurrences of the given currentElement with newElement.default Stream<T>retainAll(java.lang.Iterable<? extends T> elements)Keeps all occurrences of the given elements from this.default Stream<T>reverse()Reverses the order of elements.default Stream<T>rotateLeft(int n)Circular rotates the elements by the specified distance to the left direction.default Stream<T>rotateRight(int n)Circular rotates the elements by the specified distance to the right direction.default Stream<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> Stream<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> Stream<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 Stream<T>shuffle()Randomize the order of the elements in the current sequence.default Stream<T>slice(int beginIndex, int endIndex)Returns a Seq that is a slice of this.default Iterator<Stream<T>>slideBy(java.util.function.Function<? super T,?> classifier)Slides a non-overlapping window of a variable size over thisTraversable.default Iterator<Stream<T>>sliding(int size)Slides a window of a specificsizeand step size 1 over thisTraversableby callingTraversable.sliding(int, int).default Iterator<Stream<T>>sliding(int size, int step)Slides a window of a specificsizeandstepsize over thisTraversable.default <U> Stream<T>sortBy(java.util.Comparator<? super U> comparator, java.util.function.Function<? super T,? extends U> mapper)Sorts this elements by comparing the elements in a different domain, using the givenmapper.default <U extends java.lang.Comparable<? super U>>
Stream<T>sortBy(java.util.function.Function<? super T,? extends U> mapper)Sorts this elements by comparing the elements in a different domain, using the givenmapper.default Stream<T>sorted()Sorts this elements according to their natural order.default Stream<T>sorted(java.util.Comparator<? super T> comparator)Sorts this elements according to the providedComparator.default Tuple2<Stream<T>,Stream<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 givenpredicateand the second element is the remainder.default Tuple2<Stream<T>,Stream<T>>splitAt(int n)Splits a Seq at the specified index.default Tuple2<Stream<T>,Stream<T>>splitAt(java.util.function.Predicate<? super T> predicate)Splits a sequence at the first element which satisfies thePredicate, e.g.default Tuple2<Stream<T>,Stream<T>>splitAtInclusive(java.util.function.Predicate<? super T> predicate)Splits a sequence at the first element which satisfies thePredicate, e.g.default java.lang.StringstringPrefix()Returns the name of this Value type, which is used by toString().default Stream<T>subSequence(int beginIndex)Returns a Seq that is a subsequence of this.default Stream<T>subSequence(int beginIndex, int endIndex)Returns a Seq that is a subsequence of this.static <T> Stream<T>tabulate(int n, java.util.function.Function<? super java.lang.Integer,? extends T> f)Returns a Stream containingnvalues of a given Functionfover a range of integer values from 0 ton - 1.Stream<T>tail()Drops the first element of a non-empty Traversable.default Option<Stream<T>>tailOption()Drops the first element of a non-empty Traversable and returns anOption.default Stream<T>take(int n)Takes the first n elements of this or all elements, if this length < n.default Stream<T>takeRight(int n)Takes the last n elements of this or all elements, if this length < n.default Stream<T>takeRightUntil(java.util.function.Predicate<? super T> predicate)Takes elements until the predicate holds for the current element, starting from the end.default Stream<T>takeRightWhile(java.util.function.Predicate<? super T> predicate)Takes elements while the predicate holds for the current element, starting from the end.default Stream<T>takeUntil(java.util.function.Predicate<? super T> predicate)Takes elements until the predicate holds for the current element.default Stream<T>takeWhile(java.util.function.Predicate<? super T> predicate)Takes elements while the predicate holds for the current element.default <U> Utransform(java.util.function.Function<? super Stream<T>,? extends U> f)Transforms thisStream.static <T> Stream<Stream<T>>transpose(Stream<Stream<T>> matrix)Transposes the rows and columns of aStreammatrix.static <T> Stream<T>unfold(T seed, java.util.function.Function<? super T,Option<Tuple2<? extends T,? extends T>>> f)Creates a Stream from a seed value and a function.static <T,U>
Stream<U>unfoldLeft(T seed, java.util.function.Function<? super T,Option<Tuple2<? extends T,? extends U>>> f)Creates a Stream from a seed value and a function.static <T,U>
Stream<U>unfoldRight(T seed, java.util.function.Function<? super T,Option<Tuple2<? extends U,? extends T>>> f)Creates a Stream from a seed value and a function.default <T1,T2>
Tuple2<Stream<T1>,Stream<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<Stream<T1>,Stream<T2>,Stream<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 Stream<T>update(int index, java.util.function.Function<? super T,? extends T> updater)Updates the given element at the specified index using the specified function.default Stream<T>update(int index, T element)Updates the given element at the specified index.default <U> Stream<Tuple2<T,U>>zip(java.lang.Iterable<? extends U> that)Returns a traversable formed from this traversable and another Iterable collection by combining corresponding elements in pairs.default <U> Stream<Tuple2<T,U>>zipAll(java.lang.Iterable<? extends U> iterable, T thisElem, U thatElem)Returns a traversable formed from this traversable and another Iterable by combining corresponding elements in pairs.default <U,R>
Stream<R>zipWith(java.lang.Iterable<? extends U> that, java.util.function.BiFunction<? super T,? super U,? extends R> mapper)Returns a traversable formed from this traversable and another Iterable collection by mapping elements.default Stream<Tuple2<T,java.lang.Integer>>zipWithIndex()Zips this traversable with its indices.default <U> Stream<U>zipWithIndex(java.util.function.BiFunction<? super T,? super java.lang.Integer,? extends U> mapper)Zips this traversable with its indices by applying mapper provided.-
Methods inherited from interface io.vavr.collection.Foldable
fold, reduce, reduceOption
-
Methods inherited from interface io.vavr.Function1
andThen, arity, compose, curried, isMemoized, memoized, partial, reversed, tupled
-
Methods inherited from interface io.vavr.collection.LinearSeq
asPartialFunction, indexOfSlice, indexWhere, isDefinedAt, lastIndexOfSlice, lastIndexWhere, reverseIterator, search, search, segmentLength
-
Methods inherited from interface io.vavr.collection.Seq
apply, containsSlice, crossProduct, crossProduct, endsWith, foldRight, indexOf, indexOfOption, indexOfOption, indexOfSlice, indexOfSliceOption, indexOfSliceOption, indexWhere, indexWhereOption, indexWhereOption, isSequential, iterator, lastIndexOf, lastIndexOfOption, lastIndexOfOption, lastIndexOfSlice, lastIndexOfSliceOption, lastIndexOfSliceOption, lastIndexWhere, lastIndexWhereOption, lastIndexWhereOption, lift, prefixLength, startsWith, startsWith, withDefault, withDefaultValue
-
Methods inherited from interface io.vavr.collection.Traversable
arrangeBy, average, containsAll, count, equals, existsUnique, find, findLast, foldLeft, forEachWithIndex, get, hashCode, head, headOption, isDistinct, isEmpty, isOrdered, isSingleValued, iterator, lastOption, max, maxBy, maxBy, min, minBy, minBy, mkCharSeq, mkCharSeq, mkCharSeq, mkString, mkString, mkString, nonEmpty, product, reduceLeft, reduceLeftOption, reduceRight, reduceRightOption, single, singleOption, size, spliterator, sum
-
Methods inherited from interface io.vavr.Value
collect, collect, contains, corresponds, eq, exists, forAll, forEach, getOrElse, getOrElse, getOrElseThrow, getOrElseTry, getOrNull, out, out, stderr, stdout, toArray, toCharSeq, toCompletableFuture, toEither, toEither, toInvalid, toInvalid, toJavaArray, toJavaArray, toJavaArray, toJavaCollection, toJavaList, toJavaList, toJavaMap, toJavaMap, toJavaMap, toJavaOptional, toJavaParallelStream, toJavaSet, toJavaSet, toJavaStream, toLeft, toLeft, toLinkedMap, toLinkedMap, toLinkedSet, toList, toMap, toMap, toOption, toPriorityQueue, toPriorityQueue, toQueue, toRight, toRight, toSet, toSortedMap, toSortedMap, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toStream, toString, toTree, toTree, toTry, toTry, toValid, toValid, toValidation, toValidation, toVector
-
-
-
-
Field Detail
-
serialVersionUID
static final long serialVersionUID
- See Also:
- Constant Field Values
-
-
Method Detail
-
collector
static <T> java.util.stream.Collector<T,java.util.ArrayList<T>,Stream<T>> collector()
Returns aCollectorwhich may be used in conjunction withStream.collect(java.util.stream.Collector)to obtain aStream.- Type Parameters:
T- Component type of the Stream.- Returns:
- A io.vavr.collection.Stream Collector.
-
concat
@SafeVarargs static <T> Stream<T> concat(java.lang.Iterable<? extends T>... iterables)
Lazily creates a Stream in O(1) which traverses along the concatenation of the given iterables.- Type Parameters:
T- Component type.- Parameters:
iterables- The iterables- Returns:
- A new
Stream
-
concat
static <T> Stream<T> concat(java.lang.Iterable<? extends java.lang.Iterable<? extends T>> iterables)
Lazily creates a Stream in O(1) which traverses along the concatenation of the given iterables.- Type Parameters:
T- Component type.- Parameters:
iterables- The iterable of iterables- Returns:
- A new
Stream
-
from
static Stream<java.lang.Integer> from(int value)
Returns an infinitely long Stream ofintvalues starting fromfrom.The
Streamextends toInteger.MIN_VALUEwhen passingInteger.MAX_VALUE.- Parameters:
value- a start int value- Returns:
- a new Stream of int values starting from
from
-
from
static Stream<java.lang.Integer> from(int value, int step)
Returns an infinite long Stream ofintvalues starting fromvalueand spaced bystep.The
Streamextends toInteger.MIN_VALUEwhen passingInteger.MAX_VALUE.- Parameters:
value- a start int valuestep- the step by which to advance on each next value- Returns:
- a new
Streamof int values starting fromfrom
-
from
static Stream<java.lang.Long> from(long value)
Returns an infinitely long Stream oflongvalues starting fromfrom.The
Streamextends toInteger.MIN_VALUEwhen passingLong.MAX_VALUE.- Parameters:
value- a start long value- Returns:
- a new Stream of long values starting from
from
-
from
static Stream<java.lang.Long> from(long value, long step)
Returns an infinite long Stream oflongvalues starting fromvalueand spaced bystep.The
Streamextends toLong.MIN_VALUEwhen passingLong.MAX_VALUE.- Parameters:
value- a start long valuestep- the step by which to advance on each next value- Returns:
- a new
Streamof long values starting fromfrom
-
continually
static <T> Stream<T> continually(java.util.function.Supplier<? extends T> supplier)
Generates an (theoretically) infinitely long Stream using a value Supplier.- Type Parameters:
T- value type- Parameters:
supplier- A Supplier of Stream values- Returns:
- A new Stream
-
iterate
static <T> Stream<T> iterate(T seed, java.util.function.Function<? super T,? extends T> f)
Generates a (theoretically) infinitely long Stream using a function to calculate the next value based on the previous.- Type Parameters:
T- value type- Parameters:
seed- The first value in the Streamf- A function to calculate the next value based on the previous- Returns:
- A new Stream
-
iterate
static <T> Stream<T> iterate(java.util.function.Supplier<? extends Option<? extends T>> supplier)
Generates a (theoretically) infinitely long Stream using a repeatedly invoked supplier that provides aSomefor each next value and aNonefor the end. TheSupplierwill be invoked only that many times until it returnsNone, and repeated iteration over the stream will produce the same values in the same order, without any further invocations to theSupplier.- Type Parameters:
T- value type- Parameters:
supplier- A Supplier of iterator values- Returns:
- A new Stream
-
cons
static <T> Stream<T> cons(T head, java.util.function.Supplier<? extends Stream<? extends T>> tailSupplier)
Constructs a Stream of a head element and a tail supplier.- Type Parameters:
T- value type- Parameters:
head- The head element of the StreamtailSupplier- A supplier of the tail values. To end the stream, returnempty().- Returns:
- A new Stream
-
empty
static <T> Stream<T> empty()
Returns the single instance of Nil. Convenience method forNil.instance().Note: this method intentionally returns type
Streamand notNil. This comes handy when folding. If you explicitly need typeNiluse Stream.Empty.instance().- Type Parameters:
T- Component type of Nil, determined by type inference in the particular context.- Returns:
- The empty list.
-
narrow
static <T> Stream<T> narrow(Stream<? extends T> stream)
Narrows a widenedStream<? extends T>toStream<T>by performing a type-safe cast. This is eligible because immutable/read-only collections are covariant.- Type Parameters:
T- Component type of theStream.- Parameters:
stream- AStream.- Returns:
- the given
streaminstance as narrowed typeStream<T>.
-
of
static <T> Stream<T> of(T element)
Returns a singletonStream, i.e. aStreamof one element.- Type Parameters:
T- The component type- Parameters:
element- An element.- Returns:
- A new Stream instance containing the given element
-
of
@SafeVarargs static <T> Stream<T> of(T... elements)
Creates a Stream of the given elements.Stream.of(1, 2, 3, 4) = Nil.instance().prepend(4).prepend(3).prepend(2).prepend(1) = new Cons(1, new Cons(2, new Cons(3, new Cons(4, Nil.instance()))))- Type Parameters:
T- Component type of the Stream.- Parameters:
elements- Zero or more elements.- Returns:
- A list containing the given elements in the same order.
-
tabulate
static <T> Stream<T> tabulate(int n, java.util.function.Function<? super java.lang.Integer,? extends T> f)
Returns a Stream containingnvalues of a given Functionfover a range of integer values from 0 ton - 1.- Type Parameters:
T- Component type of the Stream- Parameters:
n- The number of elements in the Streamf- The Function computing element values- Returns:
- A Stream consisting of elements
f(0),f(1), ..., f(n - 1) - Throws:
java.lang.NullPointerException- iffis null
-
fill
static <T> Stream<T> fill(int n, java.util.function.Supplier<? extends T> s)
Returns a Stream containingnvalues supplied by a given Suppliers.- Type Parameters:
T- Component type of the Stream- Parameters:
n- The number of elements in the Streams- The Supplier computing element values- Returns:
- A Stream of size
n, where each element contains the result supplied bys. - Throws:
java.lang.NullPointerException- ifsis null
-
fill
static <T> Stream<T> fill(int n, T element)
Returns a Stream containingntimes the givenelement- Type Parameters:
T- Component type of the Stream- Parameters:
n- The number of elements in the Streamelement- The element- Returns:
- A Stream of size
n, where each element is the givenelement.
-
ofAll
static <T> Stream<T> ofAll(java.lang.Iterable<? extends T> elements)
Creates a Stream of the given elements.- Type Parameters:
T- Component type of the Stream.- Parameters:
elements- An Iterable of elements.- Returns:
- A Stream containing the given elements in the same order.
-
ofAll
static <T> Stream<T> ofAll(java.util.stream.Stream<? extends T> javaStream)
Creates a Stream that contains the elements of the givenStream.- Type Parameters:
T- Component type of the Stream.- Parameters:
javaStream- AStream- Returns:
- A Stream containing the given elements in the same order.
-
ofAll
static Stream<java.lang.Boolean> ofAll(boolean... elements)
Creates a Stream from boolean values.- Parameters:
elements- boolean values- Returns:
- A new Stream of Boolean values
- Throws:
java.lang.NullPointerException- if elements is null
-
ofAll
static Stream<java.lang.Byte> ofAll(byte... elements)
Creates a Stream from byte values.- Parameters:
elements- byte values- Returns:
- A new Stream of Byte values
- Throws:
java.lang.NullPointerException- if elements is null
-
ofAll
static Stream<java.lang.Character> ofAll(char... elements)
Creates a Stream from char values.- Parameters:
elements- char values- Returns:
- A new Stream of Character values
- Throws:
java.lang.NullPointerException- if elements is null
-
ofAll
static Stream<java.lang.Double> ofAll(double... elements)
Creates a Stream values double values.- Parameters:
elements- double values- Returns:
- A new Stream of Double values
- Throws:
java.lang.NullPointerException- if elements is null
-
ofAll
static Stream<java.lang.Float> ofAll(float... elements)
Creates a Stream from float values.- Parameters:
elements- float values- Returns:
- A new Stream of Float values
- Throws:
java.lang.NullPointerException- if elements is null
-
ofAll
static Stream<java.lang.Integer> ofAll(int... elements)
Creates a Stream from int values.- Parameters:
elements- int values- Returns:
- A new Stream of Integer values
- Throws:
java.lang.NullPointerException- if elements is null
-
ofAll
static Stream<java.lang.Long> ofAll(long... elements)
Creates a Stream from long values.- Parameters:
elements- long values- Returns:
- A new Stream of Long values
- Throws:
java.lang.NullPointerException- if elements is null
-
ofAll
static Stream<java.lang.Short> ofAll(short... elements)
Creates a Stream from short values.- Parameters:
elements- short values- Returns:
- A new Stream of Short values
- Throws:
java.lang.NullPointerException- if elements is null
-
range
static Stream<java.lang.Character> range(char from, char toExclusive)
-
rangeBy
static Stream<java.lang.Character> rangeBy(char from, char toExclusive, int step)
-
rangeBy
@GwtIncompatible static Stream<java.lang.Double> rangeBy(double from, double toExclusive, double step)
-
range
static Stream<java.lang.Integer> range(int from, int toExclusive)
Creates a Stream of int numbers starting fromfrom, extending totoExclusive - 1.Examples:
Stream.range(0, 0) // = Stream() Stream.range(2, 0) // = Stream() Stream.range(-2, 2) // = Stream(-2, -1, 0, 1)- Parameters:
from- the first numbertoExclusive- the last number + 1- Returns:
- a range of int values as specified or
Niliffrom >= toExclusive
-
rangeBy
static Stream<java.lang.Integer> rangeBy(int from, int toExclusive, int step)
Creates a Stream of int numbers starting fromfrom, extending totoExclusive - 1, withstep.Examples:
Stream.rangeBy(1, 3, 1) // = Stream(1, 2) Stream.rangeBy(1, 4, 2) // = Stream(1, 3) Stream.rangeBy(4, 1, -2) // = Stream(4, 2) Stream.rangeBy(4, 1, 2) // = Stream()- Parameters:
from- the first numbertoExclusive- the last number + 1step- the step- Returns:
- a range of long values as specified or
Nilif
from >= toInclusiveandstep > 0or
from <= toInclusiveandstep < 0 - Throws:
java.lang.IllegalArgumentException- ifstepis zero
-
range
static Stream<java.lang.Long> range(long from, long toExclusive)
Creates a Stream of long numbers starting fromfrom, extending totoExclusive - 1.Examples:
Stream.range(0L, 0L) // = Stream() Stream.range(2L, 0L) // = Stream() Stream.range(-2L, 2L) // = Stream(-2L, -1L, 0L, 1L)- Parameters:
from- the first numbertoExclusive- the last number + 1- Returns:
- a range of long values as specified or
Niliffrom >= toExclusive
-
rangeBy
static Stream<java.lang.Long> rangeBy(long from, long toExclusive, long step)
Creates a Stream of long numbers starting fromfrom, extending totoExclusive - 1, withstep.Examples:
Stream.rangeBy(1L, 3L, 1L) // = Stream(1L, 2L) Stream.rangeBy(1L, 4L, 2L) // = Stream(1L, 3L) Stream.rangeBy(4L, 1L, -2L) // = Stream(4L, 2L) Stream.rangeBy(4L, 1L, 2L) // = Stream()- Parameters:
from- the first numbertoExclusive- the last number + 1step- the step- Returns:
- a range of long values as specified or
Nilif
from >= toInclusiveandstep > 0or
from <= toInclusiveandstep < 0 - Throws:
java.lang.IllegalArgumentException- ifstepis zero
-
rangeClosed
static Stream<java.lang.Character> rangeClosed(char from, char toInclusive)
-
rangeClosedBy
static Stream<java.lang.Character> rangeClosedBy(char from, char toInclusive, int step)
-
rangeClosedBy
@GwtIncompatible static Stream<java.lang.Double> rangeClosedBy(double from, double toInclusive, double step)
-
rangeClosed
static Stream<java.lang.Integer> rangeClosed(int from, int toInclusive)
Creates a Stream of int numbers starting fromfrom, extending totoInclusive.Examples:
Stream.rangeClosed(0, 0) // = Stream(0) Stream.rangeClosed(2, 0) // = Stream() Stream.rangeClosed(-2, 2) // = Stream(-2, -1, 0, 1, 2)- Parameters:
from- the first numbertoInclusive- the last number- Returns:
- a range of int values as specified or
Niliffrom > toInclusive
-
rangeClosedBy
static Stream<java.lang.Integer> rangeClosedBy(int from, int toInclusive, int step)
Creates a Stream of int numbers starting fromfrom, extending totoInclusive, withstep.Examples:
Stream.rangeClosedBy(1, 3, 1) // = Stream(1, 2, 3) Stream.rangeClosedBy(1, 4, 2) // = Stream(1, 3) Stream.rangeClosedBy(4, 1, -2) // = Stream(4, 2) Stream.rangeClosedBy(4, 1, 2) // = Stream()- Parameters:
from- the first numbertoInclusive- the last numberstep- the step- Returns:
- a range of int values as specified or
Nilif
from > toInclusiveandstep > 0or
from < toInclusiveandstep < 0 - Throws:
java.lang.IllegalArgumentException- ifstepis zero
-
rangeClosed
static Stream<java.lang.Long> rangeClosed(long from, long toInclusive)
Creates a Stream of long numbers starting fromfrom, extending totoInclusive.Examples:
Stream.rangeClosed(0L, 0L) // = Stream(0L) Stream.rangeClosed(2L, 0L) // = Stream() Stream.rangeClosed(-2L, 2L) // = Stream(-2L, -1L, 0L, 1L, 2L)- Parameters:
from- the first numbertoInclusive- the last number- Returns:
- a range of long values as specified or
Niliffrom > toInclusive
-
rangeClosedBy
static Stream<java.lang.Long> rangeClosedBy(long from, long toInclusive, long step)
Creates a Stream of long numbers starting fromfrom, extending totoInclusive, withstep.Examples:
Stream.rangeClosedBy(1L, 3L, 1L) // = Stream(1L, 2L, 3L) Stream.rangeClosedBy(1L, 4L, 2L) // = Stream(1L, 3L) Stream.rangeClosedBy(4L, 1L, -2L) // = Stream(4L, 2L) Stream.rangeClosedBy(4L, 1L, 2L) // = Stream()- Parameters:
from- the first numbertoInclusive- the last numberstep- the step- Returns:
- a range of int values as specified or
Nilif
from > toInclusiveandstep > 0or
from < toInclusiveandstep < 0 - Throws:
java.lang.IllegalArgumentException- ifstepis zero
-
transpose
static <T> Stream<Stream<T>> transpose(Stream<Stream<T>> matrix)
Transposes the rows and columns of aStreammatrix.- Type Parameters:
T- matrix element type- Parameters:
matrix- to be transposed.- Returns:
- a transposed
Streammatrix. - Throws:
java.lang.IllegalArgumentException- if the row lengths ofmatrixdiffer.ex:
Stream.transpose(Stream(Stream(1,2,3), Stream(4,5,6))) → Stream(Stream(1,4), Stream(2,5), Stream(3,6))
-
unfoldRight
static <T,U> Stream<U> unfoldRight(T seed, java.util.function.Function<? super T,Option<Tuple2<? extends U,? extends T>>> f)
Creates a Stream from a seed value and a function. The function takes the seed at first. The function should returnNonewhen it's done generating the Stream, otherwiseSomeTupleof the element for the next call and the value to add to the resulting Stream.Example:
Stream.unfoldRight(10, x -> x == 0 ? Option.none() : Option.of(new Tuple2<>(x, x-1))); // Stream(10, 9, 8, 7, 6, 5, 4, 3, 2, 1))- Type Parameters:
T- type of seedsU- type of unfolded values- Parameters:
seed- the start value for the iterationf- the function to get the next step of the iteration- Returns:
- a Stream with the values built up by the iteration
- Throws:
java.lang.NullPointerException- iffis null
-
unfoldLeft
static <T,U> Stream<U> unfoldLeft(T seed, java.util.function.Function<? super T,Option<Tuple2<? extends T,? extends U>>> f)
Creates a Stream from a seed value and a function. The function takes the seed at first. The function should returnNonewhen it's done generating the Stream, otherwiseSomeTupleof the value to add to the resulting Stream and the element for the next call.Example:
Stream.unfoldLeft(10, x -> x == 0 ? Option.none() : Option.of(new Tuple2<>(x-1, x))); // Stream(1, 2, 3, 4, 5, 6, 7, 8, 9, 10))- Type Parameters:
T- type of seedsU- type of unfolded values- Parameters:
seed- the start value for the iterationf- the function to get the next step of the iteration- Returns:
- a Stream with the values built up by the iteration
- Throws:
java.lang.NullPointerException- iffis null
-
unfold
static <T> Stream<T> unfold(T seed, java.util.function.Function<? super T,Option<Tuple2<? extends T,? extends T>>> f)
Creates a Stream from a seed value and a function. The function takes the seed at first. The function should returnNonewhen it's done generating the Stream, otherwiseSomeTupleof the value to add to the resulting Stream and the element for the next call.Example:
Stream.unfold(10, x -> x == 0 ? Option.none() : Option.of(new Tuple2<>(x-1, x))); // Stream(1, 2, 3, 4, 5, 6, 7, 8, 9, 10))- Type Parameters:
T- type of seeds and unfolded values- Parameters:
seed- the start value for the iterationf- the function to get the next step of the iteration- Returns:
- a Stream with the values built up by the iteration
- Throws:
java.lang.NullPointerException- iffis null
-
continually
static <T> Stream<T> continually(T t)
Repeats an element infinitely often.- Type Parameters:
T- Element type- Parameters:
t- An element- Returns:
- A new Stream containing infinite
t's.
-
append
default Stream<T> append(T element)
Description copied from interface:SeqAppends an element to this.
-
appendAll
default Stream<T> appendAll(java.lang.Iterable<? extends T> elements)
Description copied from interface:SeqAppends all given elements to this.
-
appendSelf
default Stream<T> appendSelf(java.util.function.Function<? super Stream<T>,? extends Stream<T>> mapper)
Appends itself to the end of stream withmapperfunction.Example:
Well known Scala code for Fibonacci infinite sequence
can be transformed toval fibs:Stream[Int] = 0 #:: 1 #:: (fibs zip fibs.tail).map{ t => t._1 + t._2 }Stream.of(0, 1).appendSelf(self -> self.zip(self.tail()).map(t -> t._1 + t._2));- Parameters:
mapper- an mapper- Returns:
- a new Stream
-
asJava
@GwtIncompatible default java.util.List<T> asJava()
Description copied from interface:SeqCreates an immutableListview on top of thisSeq, i.e. calling mutators will result inUnsupportedOperationExceptionat runtime.The difference to conversion methods
toJava*()is that- A view is created in O(1) (constant time) whereas conversion takes O(n) (linear time), with n = collection size.
- The operations on a view have the same performance characteristics than the underlying persistent Vavr collection whereas the performance characteristics of a converted collection are those of the Java standard collections.
java.util.Listview throwsUnsupportedOperationExceptionbefore checking method arguments. Java does handle this case inconsistently.
-
asJava
@GwtIncompatible default Stream<T> asJava(java.util.function.Consumer<? super java.util.List<T>> action)
Description copied from interface:SeqCreates an immutableListview on top of thisSeqthat is passed to the givenaction.
-
asJavaMutable
@GwtIncompatible default java.util.List<T> asJavaMutable()
Description copied from interface:SeqCreates a mutableListview on top of thisSeq, i.e. all mutator methods of theListare implemented.- Specified by:
asJavaMutablein interfaceSeq<T>- Returns:
- A new mutable
Collectionview on thisTraversable. - See Also:
Seq.asJava()
-
asJavaMutable
@GwtIncompatible default Stream<T> asJavaMutable(java.util.function.Consumer<? super java.util.List<T>> action)
Description copied from interface:SeqCreates a mutableListview on top of thisSeqthat is passed to the givenaction.- Specified by:
asJavaMutablein interfaceLinearSeq<T>- Specified by:
asJavaMutablein interfaceSeq<T>- Parameters:
action- A side-effecting unit of work that operates on a mutablejava.util.Listview.- Returns:
- this instance, if only read operations are performed on the
java.util.Listview or a new instance of this type, if write operations are performed on thejava.util.Listview. - See Also:
Seq.asJavaMutable()
-
collect
default <R> Stream<R> collect(PartialFunction<? super T,? extends R> partialFunction)
Description copied from interface:TraversableCollects all elements that are in the domain of the givenpartialFunctionby mapping the elements to typeR.More specifically, for each of this elements in iteration order first it is checked
If the elements makes it through that filter, the mapped instance is added to the result collectionpartialFunction.isDefinedAt(element)
Note:If thisR newElement = partialFunction.apply(element)Traversableis ordered (i.e. extendsOrdered, the caller ofcollecthas to ensure that the elements are comparable (i.e. extendComparable).- Specified by:
collectin interfaceLinearSeq<T>- Specified by:
collectin interfaceSeq<T>- Specified by:
collectin interfaceTraversable<T>- Type Parameters:
R- The new element type- Parameters:
partialFunction- A function that is not necessarily defined of all elements of this traversable.- Returns:
- A new
Traversableinstance containing elements of typeR
-
combinations
default Stream<Stream<T>> combinations()
Description copied from interface:SeqReturns the union of all combinations from k = 0 to length().Examples:
[].combinations() = [[]] [1,2,3].combinations() = [ [], // k = 0 [1], [2], [3], // k = 1 [1,2], [1,3], [2,3], // k = 2 [1,2,3] // k = 3 ]- Specified by:
combinationsin interfaceLinearSeq<T>- Specified by:
combinationsin interfaceSeq<T>- Returns:
- the combinations of this
-
combinations
default Stream<Stream<T>> combinations(int k)
Description copied from interface:SeqReturns the k-combination of this traversable, i.e. all subset of this of k distinct elements.- Specified by:
combinationsin interfaceLinearSeq<T>- Specified by:
combinationsin interfaceSeq<T>- Parameters:
k- Size of subsets- Returns:
- the k-combination of this elements
- See Also:
- Combination
-
crossProduct
default Iterator<Stream<T>> crossProduct(int power)
Description copied from interface:SeqCalculates the n-ary cartesian power (or cross product or simply product) of this.Example:
// = ((A,A), (A,B), (A,C), ..., (B,A), (B,B), ..., (Z,Y), (Z,Z)) CharSeq.rangeClosed('A', 'Z').crossProduct(2);Cartesian power of negative value will return empty iterator.
Example:
// = () CharSeq.rangeClosed('A', 'Z').crossProduct(-1);- Specified by:
crossProductin interfaceLinearSeq<T>- Specified by:
crossProductin interfaceSeq<T>- Parameters:
power- the number of cartesian multiplications- Returns:
- A new Iterator representing the n-ary cartesian power of this
-
cycle
default Stream<T> cycle()
Repeat the elements of this Stream infinitely.Example:
// = 1, 2, 3, 1, 2, 3, 1, 2, 3, ... Stream.of(1, 2, 3).cycle();- Returns:
- A new Stream containing this elements cycled.
-
cycle
default Stream<T> cycle(int count)
Repeat the elements of this Streamcounttimes.Example:
// = empty Stream.of(1, 2, 3).cycle(0); // = 1, 2, 3 Stream.of(1, 2, 3).cycle(1); // = 1, 2, 3, 1, 2, 3, 1, 2, 3 Stream.of(1, 2, 3).cycle(3);- Parameters:
count- the number of cycles to be performed- Returns:
- A new Stream containing this elements cycled
counttimes.
-
distinct
default Stream<T> distinct()
Description copied from interface:TraversableReturns a new version of this which contains no duplicates. Elements are compared usingequals.
-
distinctBy
default Stream<T> distinctBy(java.util.Comparator<? super T> comparator)
Description copied from interface:TraversableReturns a new version of this which contains no duplicates. Elements are compared using the givencomparator.- Specified by:
distinctByin interfaceLinearSeq<T>- Specified by:
distinctByin interfaceSeq<T>- Specified by:
distinctByin interfaceTraversable<T>- Parameters:
comparator- A comparator- Returns:
- a new
Traversablecontaining this elements without duplicates
-
distinctBy
default <U> Stream<T> distinctBy(java.util.function.Function<? super T,? extends U> keyExtractor)
Description copied from interface:TraversableReturns a new version of this which contains no duplicates. Elements mapped to keys which are compared usingequals.The elements of the result are determined in the order of their occurrence - first match wins.
- Specified by:
distinctByin interfaceLinearSeq<T>- Specified by:
distinctByin interfaceSeq<T>- Specified by:
distinctByin interfaceTraversable<T>- Type Parameters:
U- key type- Parameters:
keyExtractor- A key extractor- Returns:
- a new
Traversablecontaining this elements without duplicates
-
drop
default Stream<T> drop(int n)
Description copied from interface:TraversableDrops the first n elements of this or all elements, if this length < n.- Specified by:
dropin interfaceLinearSeq<T>- Specified by:
dropin interfaceSeq<T>- Specified by:
dropin interfaceTraversable<T>- Parameters:
n- The number of elements to drop.- Returns:
- a new instance consisting of all elements of this except the first n ones, or else the empty instance, if this has less than n elements.
-
dropUntil
default Stream<T> dropUntil(java.util.function.Predicate<? super T> predicate)
Description copied from interface:TraversableDrops elements until the predicate holds for the current element.- Specified by:
dropUntilin interfaceLinearSeq<T>- Specified by:
dropUntilin interfaceSeq<T>- Specified by:
dropUntilin interfaceTraversable<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 Stream<T> dropWhile(java.util.function.Predicate<? super T> predicate)
Description copied from interface:TraversableDrops elements while the predicate holds for the current element.Note: This is essentially the same as
dropUntil(predicate.negate()). It is intended to be used with method references, which cannot be negated directly.- Specified by:
dropWhilein interfaceLinearSeq<T>- Specified by:
dropWhilein interfaceSeq<T>- Specified by:
dropWhilein interfaceTraversable<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 not satisfy the given predicate.
-
dropRight
default Stream<T> dropRight(int n)
Description copied from interface:TraversableDrops the last n elements of this or all elements, if this length < n.- Specified by:
dropRightin interfaceLinearSeq<T>- Specified by:
dropRightin interfaceSeq<T>- Specified by:
dropRightin interfaceTraversable<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.
-
dropRightUntil
default Stream<T> dropRightUntil(java.util.function.Predicate<? super T> predicate)
Description copied from interface:SeqDrops elements until the predicate holds for the current element, starting from the end.- Specified by:
dropRightUntilin interfaceLinearSeq<T>- Specified by:
dropRightUntilin interfaceSeq<T>- Parameters:
predicate- A condition tested subsequently for this elements, starting from the end.- Returns:
- a new instance consisting of all elements until and including the last one which does satisfy the given predicate.
-
dropRightWhile
default Stream<T> dropRightWhile(java.util.function.Predicate<? super T> predicate)
Description copied from interface:SeqDrops elements while the predicate holds for the current element, starting from the end.Note: This is essentially the same as
dropRightUntil(predicate.negate()). It is intended to be used with method references, which cannot be negated directly.- Specified by:
dropRightWhilein interfaceLinearSeq<T>- Specified by:
dropRightWhilein interfaceSeq<T>- Parameters:
predicate- A condition tested subsequently for this elements, starting from the end.- Returns:
- a new instance consisting of all elements until and including the last one which does not satisfy the given predicate.
-
filter
default Stream<T> filter(java.util.function.Predicate<? super T> predicate)
Description copied from interface:TraversableReturns a new traversable consisting of all elements which satisfy the given predicate.
-
reject
default Stream<T> reject(java.util.function.Predicate<? super T> predicate)
Description copied from interface:TraversableReturns a new traversable consisting of all elements which do not satisfy the given predicate.The default implementation is equivalent to
filter(predicate.negate()
-
flatMap
default <U> Stream<U> flatMap(java.util.function.Function<? super T,? extends java.lang.Iterable<? extends U>> mapper)
Description copied from interface:TraversableFlatMaps this Traversable.
-
get
default T get(int index)
Description copied from interface:SeqReturns the element at the specified index.
-
groupBy
default <C> Map<C,Stream<T>> groupBy(java.util.function.Function<? super T,? extends C> classifier)
Description copied from interface:TraversableGroups this elements by classifying the elements.- Specified by:
groupByin interfaceLinearSeq<T>- Specified by:
groupByin interfaceSeq<T>- Specified by:
groupByin interfaceTraversable<T>- Type Parameters:
C- classified class type- Parameters:
classifier- A function which classifies elements into classes- Returns:
- A Map containing the grouped elements
- See Also:
Traversable.arrangeBy(Function)
-
grouped
default Iterator<Stream<T>> grouped(int size)
Description copied from interface:TraversableGroups thisTraversableinto fixed size blocks.Let length be the length of this Iterable. Then grouped is defined as follows:
- If
this.isEmpty(), the resultingIteratoris empty. - If
size <= length, the resultingIteratorwill containlength / sizeblocks of sizesizeand maybe a non-empty block of sizelength % size, if there are remaining elements. - If
size > length, the resultingIteratorwill contain one block of sizelength.
Please note that[].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]]grouped(int)is a special case of Traversable.sliding(int, int), i.e.grouped(size)is the same assliding(size, size). - If
-
hasDefiniteSize
default boolean hasDefiniteSize()
Description copied from interface:TraversableChecks 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:
hasDefiniteSizein interfaceTraversable<T>- Returns:
- true, if this Traversable is known to have a finite size, false otherwise.
-
indexOf
default int indexOf(T element, int from)
Description copied from interface:SeqReturns the index of the first occurrence of the given element after or at some start index or -1 if this does not contain the given element.
-
init
default Stream<T> init()
Description copied from interface:TraversableDual of Traversable.tail(), returning all elements except the last.
-
initOption
default Option<Stream<T>> initOption()
Description copied from interface:TraversableDual of Traversable.tailOption(), returning all elements except the last asOption.- Specified by:
initOptionin interfaceLinearSeq<T>- Specified by:
initOptionin interfaceSeq<T>- Specified by:
initOptionin interfaceTraversable<T>- Returns:
Some(traversable)orNoneif this is empty.
-
insert
default Stream<T> insert(int index, T element)
Description copied from interface:SeqInserts the given element at the specified index.
-
insertAll
default Stream<T> insertAll(int index, java.lang.Iterable<? extends T> elements)
Description copied from interface:SeqInserts the given elements at the specified index.
-
intersperse
default Stream<T> intersperse(T element)
Description copied from interface:SeqInserts an element between all elements of this Traversable.- Specified by:
interspersein interfaceLinearSeq<T>- Specified by:
interspersein interfaceSeq<T>- Parameters:
element- An element.- Returns:
- an interspersed version of this
-
isAsync
default boolean isAsync()
AStreamis computed synchronously.
-
isLazy
default boolean isLazy()
AStreamis computed lazily.
-
isTraversableAgain
default boolean isTraversableAgain()
Description copied from interface:TraversableChecks if this Traversable can be repeatedly traversed.This method should be implemented by classes only, i.e. not by interfaces.
- Specified by:
isTraversableAgainin interfaceTraversable<T>- Returns:
- true, if this Traversable is known to be traversable repeatedly, false otherwise.
-
last
default T last()
Description copied from interface:TraversableDual of Traversable.head(), returning the last element.- Specified by:
lastin interfaceTraversable<T>- Returns:
- the last element.
-
lastIndexOf
default int lastIndexOf(T element, int end)
Description copied from interface:SeqReturns the index of the last occurrence of the given element before or at a given end index or -1 if this does not contain the given element.- Specified by:
lastIndexOfin interfaceSeq<T>- Parameters:
element- an elementend- the end index- Returns:
- the index of the last occurrence of the given element
-
length
default int length()
Description copied from interface:TraversableComputes the number of elements of this Traversable.Same as
Traversable.size().- Specified by:
lengthin interfaceTraversable<T>- Returns:
- the number of elements
-
map
default <U> Stream<U> map(java.util.function.Function<? super T,? extends U> mapper)
Description copied from interface:TraversableMaps the elements of thisTraversableto elements of a new type preserving their order, if any.
-
padTo
default Stream<T> padTo(int length, T element)
Description copied from interface:SeqA copy of this sequence with an element appended until a given target length is reached.Note: lazily-evaluated Seq implementations need to process all elements in order to gather the overall length.
- Specified by:
padToin interfaceLinearSeq<T>- Specified by:
padToin interfaceSeq<T>- Parameters:
length- the target lengthelement- the padding element- Returns:
- a new sequence consisting of all elements of this sequence followed by the minimal number
of occurrences of
elementso that the resulting sequence has a length of at leastlength.
-
leftPadTo
default Stream<T> leftPadTo(int length, T element)
Description copied from interface:SeqA copy of this sequence with an element prepended until a given target length is reached.Note: lazily-evaluated Seq implementations need to process all elements in order to gather the overall length.
- Specified by:
leftPadToin interfaceSeq<T>- Parameters:
length- the target lengthelement- the padding element- Returns:
- a new sequence consisting of all elements of this sequence prepended by the minimal number
of occurrences of
elementso that the resulting sequence has a length of at leastlength.
-
orElse
default Stream<T> orElse(java.lang.Iterable<? extends T> other)
Description copied from interface:TraversableReturns thisTraversableif it is nonempty, otherwise return the alternative.
-
orElse
default Stream<T> orElse(java.util.function.Supplier<? extends java.lang.Iterable<? extends T>> supplier)
Description copied from interface:TraversableReturns thisTraversableif it is nonempty, otherwise return the result of evaluating supplier.
-
patch
default Stream<T> patch(int from, java.lang.Iterable<? extends T> that, int replaced)
Description copied from interface:SeqProduces a new list where a slice of elements in this list is replaced by another sequence.
-
partition
default Tuple2<Stream<T>,Stream<T>> partition(java.util.function.Predicate<? super T> predicate)
Description copied from interface:TraversableCreates a partition of thisTraversableby splitting this elements in two in distinct traversables according to a predicate.- Specified by:
partitionin interfaceLinearSeq<T>- Specified by:
partitionin interfaceSeq<T>- Specified by:
partitionin interfaceTraversable<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
Traversablecontains all elements that satisfy the givenpredicate, the secondTraversablecontains all elements that don't. The original order of elements is preserved.
-
peek
default Stream<T> peek(java.util.function.Consumer<? super T> action)
Description copied from interface:ValuePerforms the givenactionon the first element if this is an eager implementation. Performs the givenactionon all elements (the first immediately, successive deferred), if this is a lazy implementation.
-
permutations
default Stream<Stream<T>> permutations()
Description copied from interface:SeqComputes all unique permutations.Example:
[].permutations() = [] [1,2,3].permutations() = [ [1,2,3], [1,3,2], [2,1,3], [2,3,1], [3,1,2], [3,2,1] ]- Specified by:
permutationsin interfaceLinearSeq<T>- Specified by:
permutationsin interfaceSeq<T>- Returns:
- this unique permutations
-
prepend
default Stream<T> prepend(T element)
Description copied from interface:SeqPrepends an element to this.
-
prependAll
default Stream<T> prependAll(java.lang.Iterable<? extends T> elements)
Description copied from interface:SeqPrepends all given elements to this.- Specified by:
prependAllin interfaceLinearSeq<T>- Specified by:
prependAllin interfaceSeq<T>- Parameters:
elements- An Iterable of elements- Returns:
- A new Seq containing the given elements prepended to this elements
-
remove
default Stream<T> remove(T element)
Description copied from interface:SeqRemoves the first occurrence of the given element.
-
removeFirst
default Stream<T> removeFirst(java.util.function.Predicate<T> predicate)
Description copied from interface:SeqRemoves the first occurrence that satisfy predicate- Specified by:
removeFirstin interfaceLinearSeq<T>- Specified by:
removeFirstin interfaceSeq<T>- Parameters:
predicate- an predicate- Returns:
- a new Seq
-
removeLast
default Stream<T> removeLast(java.util.function.Predicate<T> predicate)
Description copied from interface:SeqRemoves the last occurrence that satisfy predicate- Specified by:
removeLastin interfaceLinearSeq<T>- Specified by:
removeLastin interfaceSeq<T>- Parameters:
predicate- an predicate- Returns:
- a new Seq
-
removeAt
default Stream<T> removeAt(int index)
Description copied from interface:SeqRemoves the element at the specified position in this sequence. Shifts any subsequent elements to the left (subtracts one from their indices).
-
removeAll
default Stream<T> removeAll(T element)
Description copied from interface:SeqRemoves all occurrences of the given element.
-
removeAll
default Stream<T> removeAll(java.lang.Iterable<? extends T> elements)
Description copied from interface:SeqRemoves all occurrences of the given elements.
-
removeAll
@Deprecated default Stream<T> removeAll(java.util.function.Predicate<? super T> predicate)
Deprecated.Description copied from interface:SeqReturns a new Seq consisting of all elements which do not satisfy the given predicate.
-
replace
default Stream<T> replace(T currentElement, T newElement)
Description copied from interface:TraversableReplaces the first occurrence (if exists) of the given currentElement with newElement.- Specified by:
replacein interfaceLinearSeq<T>- Specified by:
replacein interfaceSeq<T>- Specified by:
replacein interfaceTraversable<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 Stream<T> replaceAll(T currentElement, T newElement)
Description copied from interface:TraversableReplaces all occurrences of the given currentElement with newElement.- Specified by:
replaceAllin interfaceLinearSeq<T>- Specified by:
replaceAllin interfaceSeq<T>- Specified by:
replaceAllin interfaceTraversable<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 Stream<T> retainAll(java.lang.Iterable<? extends T> elements)
Description copied from interface:TraversableKeeps all occurrences of the given elements from this.
-
reverse
default Stream<T> reverse()
Description copied from interface:SeqReverses the order of elements.
-
rotateLeft
default Stream<T> rotateLeft(int n)
Description copied from interface:SeqCircular rotates the elements by the specified distance to the left direction.// = List(3, 4, 5, 1, 2) List.of(1, 2, 3, 4, 5).rotateLeft(2);- Specified by:
rotateLeftin interfaceLinearSeq<T>- Specified by:
rotateLeftin interfaceSeq<T>- Parameters:
n- distance of left rotation- Returns:
- the rotated elements.
-
rotateRight
default Stream<T> rotateRight(int n)
Description copied from interface:SeqCircular rotates the elements by the specified distance to the right direction.// = List(4, 5, 1, 2, 3) List.of(1, 2, 3, 4, 5).rotateRight(2);- Specified by:
rotateRightin interfaceLinearSeq<T>- Specified by:
rotateRightin interfaceSeq<T>- Parameters:
n- distance of right rotation- Returns:
- the rotated elements.
-
scan
default Stream<T> scan(T zero, java.util.function.BiFunction<? super T,? super T,? extends T> operation)
Description copied from interface:TraversableComputes a prefix scan of the elements of the collection. Note: The neutral element z may be applied more than once.- Specified by:
scanin interfaceLinearSeq<T>- Specified by:
scanin interfaceSeq<T>- Specified by:
scanin interfaceTraversable<T>- Parameters:
zero- neutral element for the operator opoperation- the associative operator for the scan- Returns:
- a new traversable collection containing the prefix scan of the elements in this traversable collection
-
scanLeft
default <U> Stream<U> scanLeft(U zero, java.util.function.BiFunction<? super U,? super T,? extends U> operation)
Description copied from interface:TraversableProduces 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:
scanLeftin interfaceLinearSeq<T>- Specified by:
scanLeftin interfaceSeq<T>- Specified by:
scanLeftin interfaceTraversable<T>- Type Parameters:
U- the type of the elements in the resulting collection- Parameters:
zero- the initial valueoperation- the binary operator applied to the intermediate result and the element- Returns:
- collection with intermediate results
-
scanRight
default <U> Stream<U> scanRight(U zero, java.util.function.BiFunction<? super T,? super U,? extends U> operation)
Description copied from interface:TraversableProduces 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:
scanRightin interfaceLinearSeq<T>- Specified by:
scanRightin interfaceSeq<T>- Specified by:
scanRightin interfaceTraversable<T>- Type Parameters:
U- the type of the elements in the resulting collection- Parameters:
zero- the initial valueoperation- the binary operator applied to the intermediate result and the element- Returns:
- collection with intermediate results
-
shuffle
default Stream<T> shuffle()
Description copied from interface:SeqRandomize the order of the elements in the current sequence.
-
slice
default Stream<T> slice(int beginIndex, int endIndex)
Description copied from interface:SeqReturns a Seq that is a slice of this. The slice begins with the element at the specifiedbeginIndexand extends to the element at indexendIndex - 1.Examples:
See alsoList.of(1, 2, 3, 4).slice(1, 3); // = (2, 3) List.of(1, 2, 3, 4).slice(0, 4); // = (1, 2, 3, 4) List.of(1, 2, 3, 4).slice(2, 2); // = () List.of(1, 2).slice(1, 0); // = () List.of(1, 2).slice(-10, 10); // = (1, 2)Seq.subSequence(int, int)which throws in some cases instead of returning a sequence.
-
slideBy
default Iterator<Stream<T>> slideBy(java.util.function.Function<? super T,?> classifier)
Description copied from interface:TraversableSlides a non-overlapping window of a variable size over thisTraversable.Each window contains elements with the same class, as determined by
classifier. Two consecutive values in thisTraversablewill be in the same window only ifclassifierreturns equal values for them. Otherwise, the values will constitute the last element of the previous window and the first element of the next window.Examples:
[].slideBy(Function.identity()) = [] [1,2,3,4,4,5].slideBy(Function.identity()) = [[1],[2],[3],[4,4],[5]] [1,2,3,10,12,5,7,20,29].slideBy(x -> x/10) = [[1,2,3],[10,12],[5,7],[20,29]]
-
sliding
default Iterator<Stream<T>> sliding(int size)
Description copied from interface:TraversableSlides a window of a specificsizeand step size 1 over thisTraversableby callingTraversable.sliding(int, int).
-
sliding
default Iterator<Stream<T>> sliding(int size, int step)
Description copied from interface:TraversableSlides a window of a specificsizeandstepsize over thisTraversable.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]]
-
sorted
default Stream<T> sorted()
Description copied from interface:SeqSorts this elements according to their natural order. If this elements are notComparable, ajava.lang.ClassCastExceptionmay be thrown.
-
sorted
default Stream<T> sorted(java.util.Comparator<? super T> comparator)
Description copied from interface:SeqSorts this elements according to the providedComparator. If this elements are notComparable, ajava.lang.ClassCastExceptionmay be thrown.
-
sortBy
default <U extends java.lang.Comparable<? super U>> Stream<T> sortBy(java.util.function.Function<? super T,? extends U> mapper)
Description copied from interface:SeqSorts this elements by comparing the elements in a different domain, using the givenmapper.
-
sortBy
default <U> Stream<T> sortBy(java.util.Comparator<? super U> comparator, java.util.function.Function<? super T,? extends U> mapper)
Description copied from interface:SeqSorts this elements by comparing the elements in a different domain, using the givenmapper.
-
span
default Tuple2<Stream<T>,Stream<T>> span(java.util.function.Predicate<? super T> predicate)
Description copied from interface:TraversableReturns a tuple where the first element is the longest prefix of elements that satisfy the givenpredicateand the second element is the remainder.
-
splitAt
default Tuple2<Stream<T>,Stream<T>> splitAt(int n)
Description copied from interface:SeqSplits a Seq at the specified index. The result ofsplitAt(n)is equivalent toTuple.of(take(n), drop(n)).
-
splitAt
default Tuple2<Stream<T>,Stream<T>> splitAt(java.util.function.Predicate<? super T> predicate)
Description copied from interface:SeqSplits a sequence at the first element which satisfies thePredicate, e.g. Tuple(init, element+tail).
-
splitAtInclusive
default Tuple2<Stream<T>,Stream<T>> splitAtInclusive(java.util.function.Predicate<? super T> predicate)
Description copied from interface:SeqSplits a sequence at the first element which satisfies thePredicate, e.g. Tuple(init+element, tail).- Specified by:
splitAtInclusivein interfaceSeq<T>- Parameters:
predicate- An predicate- Returns:
- A
Tuplecontaining divided sequences
-
stringPrefix
default java.lang.String stringPrefix()
Description copied from interface:ValueReturns the name of this Value type, which is used by toString().- Specified by:
stringPrefixin interfaceValue<T>- Returns:
- This type name.
-
subSequence
default Stream<T> subSequence(int beginIndex)
Description copied from interface:SeqReturns a Seq that is a subsequence of this. The subsequence begins with the element at the specifiedbeginIndexand extends to the end of this Seq.Examples:
See alsoList.of(1, 2).subSequence(0); // = (1, 2) List.of(1, 2).subSequence(1); // = (2) List.of(1, 2).subSequence(2); // = () List.of(1, 2).subSequence(10); // throws IndexOutOfBoundsException List.of(1, 2).subSequence(-10); // throws IndexOutOfBoundsExceptionSeq.drop(int)which is similar but does not throw.- Specified by:
subSequencein interfaceLinearSeq<T>- Specified by:
subSequencein interfaceSeq<T>- Parameters:
beginIndex- the beginning index, inclusive- Returns:
- the specified subsequence
-
subSequence
default Stream<T> subSequence(int beginIndex, int endIndex)
Description copied from interface:SeqReturns a Seq that is a subsequence of this. The subsequence begins with the element at the specifiedbeginIndexand extends to the element at indexendIndex - 1.Examples:
See alsoList.of(1, 2, 3, 4).subSequence(1, 3); // = (2, 3) List.of(1, 2, 3, 4).subSequence(0, 4); // = (1, 2, 3, 4) List.of(1, 2, 3, 4).subSequence(2, 2); // = () List.of(1, 2).subSequence(1, 0); // throws IndexOutOfBoundsException List.of(1, 2).subSequence(-10, 1); // throws IndexOutOfBoundsException List.of(1, 2).subSequence(0, 10); // throws IndexOutOfBoundsExceptionSeq.slice(int, int)which returns an empty sequence instead of throwing.- Specified by:
subSequencein interfaceLinearSeq<T>- Specified by:
subSequencein interfaceSeq<T>- Parameters:
beginIndex- the beginning index, inclusiveendIndex- the end index, exclusive- Returns:
- the specified subsequence
-
tail
Stream<T> tail()
Description copied from interface:TraversableDrops the first element of a non-empty Traversable.
-
tailOption
default Option<Stream<T>> tailOption()
Description copied from interface:TraversableDrops the first element of a non-empty Traversable and returns anOption.- Specified by:
tailOptionin interfaceLinearSeq<T>- Specified by:
tailOptionin interfaceSeq<T>- Specified by:
tailOptionin interfaceTraversable<T>- Returns:
Some(traversable)orNoneif this is empty.
-
take
default Stream<T> take(int n)
Description copied from interface:TraversableTakes the first n elements of this or all elements, if this length < n.The result is equivalent to
sublist(0, max(0, min(length(), n)))but does not throw ifn < 0orn > length().In the case of
n < 0the empty instance is returned, in the case ofn > length()this is returned.
-
takeUntil
default Stream<T> takeUntil(java.util.function.Predicate<? super T> predicate)
Description copied from interface:TraversableTakes 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:
takeUntilin interfaceLinearSeq<T>- Specified by:
takeUntilin interfaceSeq<T>- Specified by:
takeUntilin interfaceTraversable<T>- Parameters:
predicate- A condition tested subsequently for this elements.- Returns:
- a new instance consisting of all elements before the first one which does satisfy the given predicate.
-
takeWhile
default Stream<T> takeWhile(java.util.function.Predicate<? super T> predicate)
Description copied from interface:TraversableTakes elements while the predicate holds for the current element.- Specified by:
takeWhilein interfaceLinearSeq<T>- Specified by:
takeWhilein interfaceSeq<T>- Specified by:
takeWhilein interfaceTraversable<T>- Parameters:
predicate- A condition tested subsequently for the contained elements.- Returns:
- a new instance consisting of all elements before the first one which does not satisfy the given predicate.
-
takeRight
default Stream<T> takeRight(int n)
Description copied from interface:TraversableTakes 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 ifn < 0orn > length().In the case of
n < 0the empty instance is returned, in the case ofn > length()this is returned.- Specified by:
takeRightin interfaceLinearSeq<T>- Specified by:
takeRightin interfaceSeq<T>- Specified by:
takeRightin interfaceTraversable<T>- Parameters:
n- The number of elements to take.- Returns:
- A new instance consisting of the last n elements of this or all elements, if this has less than n elements.
-
takeRightUntil
default Stream<T> takeRightUntil(java.util.function.Predicate<? super T> predicate)
Description copied from interface:SeqTakes elements until the predicate holds for the current element, starting from the end.- Specified by:
takeRightUntilin interfaceLinearSeq<T>- Specified by:
takeRightUntilin interfaceSeq<T>- Parameters:
predicate- A condition tested subsequently for this elements, starting from the end.- Returns:
- a new instance consisting of all elements after the last one which does satisfy the given predicate.
-
takeRightWhile
default Stream<T> takeRightWhile(java.util.function.Predicate<? super T> predicate)
Description copied from interface:SeqTakes elements while the predicate holds for the current element, starting from the end.Note: This is essentially the same as
takeRightUntil(predicate.negate()). It is intended to be used with method references, which cannot be negated directly.- Specified by:
takeRightWhilein interfaceLinearSeq<T>- Specified by:
takeRightWhilein interfaceSeq<T>- Parameters:
predicate- A condition tested subsequently for this elements, starting from the end.- Returns:
- a new instance consisting of all elements after the last one which does not satisfy the given predicate.
-
transform
default <U> U transform(java.util.function.Function<? super Stream<T>,? extends U> f)
Transforms thisStream.- Type Parameters:
U- Type of transformation result- Parameters:
f- A transformation- Returns:
- An instance of type
U - Throws:
java.lang.NullPointerException- iffis null
-
unzip
default <T1,T2> Tuple2<Stream<T1>,Stream<T2>> unzip(java.util.function.Function<? super T,Tuple2<? extends T1,? extends T2>> unzipper)
Description copied from interface:TraversableUnzips this elements by mapping this elements to pairs which are subsequently split into two distinct sets.- Specified by:
unzipin interfaceLinearSeq<T>- Specified by:
unzipin interfaceSeq<T>- Specified by:
unzipin interfaceTraversable<T>- Type Parameters:
T1- 1st element type of a pair returned by unzipperT2- 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<Stream<T1>,Stream<T2>,Stream<T3>> unzip3(java.util.function.Function<? super T,Tuple3<? extends T1,? extends T2,? extends T3>> unzipper)
Description copied from interface:TraversableUnzips this elements by mapping this elements to triples which are subsequently split into three distinct sets.- Specified by:
unzip3in interfaceSeq<T>- Specified by:
unzip3in interfaceTraversable<T>- Type Parameters:
T1- 1st element type of a triplet returned by unzipperT2- 2nd element type of a triplet returned by unzipperT3- 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
-
update
default Stream<T> update(int index, T element)
Description copied from interface:SeqUpdates the given element at the specified index.
-
update
default Stream<T> update(int index, java.util.function.Function<? super T,? extends T> updater)
Description copied from interface:SeqUpdates the given element at the specified index using the specified function.
-
zip
default <U> Stream<Tuple2<T,U>> zip(java.lang.Iterable<? extends U> that)
Description copied from interface:TraversableReturns a traversable formed from this traversable and another 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
thatiterable.- Specified by:
zipin interfaceLinearSeq<T>- Specified by:
zipin interfaceSeq<T>- Specified by:
zipin interfaceTraversable<T>- Type Parameters:
U- The type of the second half of the returned pairs.- Parameters:
that- The Iterable providing the second half of each result pair.- Returns:
- a new traversable containing pairs consisting of corresponding elements of this traversable and
thatiterable.
-
zipWith
default <U,R> Stream<R> zipWith(java.lang.Iterable<? extends U> that, java.util.function.BiFunction<? super T,? super U,? extends R> mapper)
Description copied from interface:TraversableReturns a traversable formed from this traversable and another Iterable collection by mapping elements. 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
thatiterable.- Specified by:
zipWithin interfaceLinearSeq<T>- Specified by:
zipWithin interfaceSeq<T>- Specified by:
zipWithin interfaceTraversable<T>- Type Parameters:
U- The type of the second parameter of the mapper.R- The type of the mapped elements.- Parameters:
that- The Iterable providing the second parameter of the mapper.mapper- a mapper.- Returns:
- a new traversable containing mapped elements of this traversable and
thatiterable.
-
zipAll
default <U> Stream<Tuple2<T,U>> zipAll(java.lang.Iterable<? extends U> iterable, T thisElem, U thatElem)
Description copied from interface:TraversableReturns a traversable formed from this traversable and another 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
thatiterable.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:
zipAllin interfaceLinearSeq<T>- Specified by:
zipAllin interfaceSeq<T>- Specified by:
zipAllin interfaceTraversable<T>- Type Parameters:
U- The type of the second half of the returned pairs.- Parameters:
iterable- The 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 Stream<Tuple2<T,java.lang.Integer>> zipWithIndex()
Description copied from interface:TraversableZips this traversable with its indices.- Specified by:
zipWithIndexin interfaceLinearSeq<T>- Specified by:
zipWithIndexin interfaceSeq<T>- Specified by:
zipWithIndexin interfaceTraversable<T>- Returns:
- A new traversable containing all elements of this traversable paired with their index, starting with 0.
-
zipWithIndex
default <U> Stream<U> zipWithIndex(java.util.function.BiFunction<? super T,? super java.lang.Integer,? extends U> mapper)
Description copied from interface:TraversableZips this traversable with its indices by applying mapper provided.- Specified by:
zipWithIndexin interfaceLinearSeq<T>- Specified by:
zipWithIndexin interfaceSeq<T>- Specified by:
zipWithIndexin interfaceTraversable<T>- Type Parameters:
U- The type of the mapped elements.- Parameters:
mapper- a mapper.- Returns:
- a new traversable containing elements of this traversable, zipped with indices, and mapped with mapper provided.
-
extend
default Stream<T> extend(T next)
Extends (continues) thisStreamwith a constantly repeated value.- Parameters:
next- value with which the stream should be extended- Returns:
- new
Streamcomposed from this stream extended with a Stream of provided value
-
extend
default Stream<T> extend(java.util.function.Supplier<? extends T> nextSupplier)
Extends (continues) thisStreamwith values provided by aSupplier- Parameters:
nextSupplier- a supplier which will provide values for extending a stream- Returns:
- new
Streamcomposed from this stream extended with values provided by the supplier
-
extend
default Stream<T> extend(java.util.function.Function<? super T,? extends T> nextFunction)
Extends (continues) thisStreamwith a Stream of values created by applying consecutively providedFunctionto the last element of the original Stream.- Parameters:
nextFunction- a function which calculates the next value basing on the previous value- Returns:
- new
Streamcomposed from this stream extended with values calculated by the provided function
-
-