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() = Empty.instance() Stream.of(x) // = new Cons<>(x, Empty.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 longserialVersionUIDThe serial version UID for serialization.
-
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)Returns a new sequence with the given element appended at the end.default Stream<T>appendAll(@NonNull java.lang.Iterable<? extends T> elements)Returns a new sequence with all elements from the givenIterableappended at the end of this sequence.default Stream<T>appendSelf(@NonNull 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()Returns an immutableListview of thisSeq.default Stream<T>asJava(@NonNull java.util.function.Consumer<? super java.util.List<T>> action)Creates an immutableListview of thisSeqand passes it to the givenaction.default java.util.List<T>asJavaMutable()Returns a mutableListview of thisSeq.default Stream<T>asJavaMutable(@NonNull java.util.function.Consumer<? super java.util.List<T>> action)Creates a mutableListview of thisSeqand passes it to the givenaction.default <R> Stream<R>collect(@NonNull PartialFunction<? super T,? extends R> partialFunction)Applies aPartialFunctionto all elements that are defined for it and collects the results.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 a sequence containing all combinations of elements from this sequence, for all sizes from0tolength().default Stream<Stream<T>>combinations(int k)Returns all subsets of this sequence containing exactlykdistinct elements, i.e., the k-combinations of this sequence.static <T> Stream<T>concat(@NonNull 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(@NonNull java.lang.Iterable<? extends T> @NonNull ... iterables)Lazily creates a Stream in O(1) which traverses along the concatenation of the given iterables.static <T> Stream<T>cons(T head, @NonNull 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(@NonNull 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)Returns the n-ary Cartesian power (cross product) of this sequence.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 newTraversablecontaining the elements of this instance with all duplicates removed.default Stream<T>distinctBy(@NonNull java.util.Comparator<? super T> comparator)Returns a newTraversablecontaining the elements of this instance without duplicates, as determined by the givencomparator.default <U> Stream<T>distinctBy(@NonNull java.util.function.Function<? super T,? extends U> keyExtractor)Returns a newTraversablecontaining the elements of this instance without duplicates, based on keys extracted from elements usingkeyExtractor.default Stream<T>distinctByKeepLast(@NonNull java.util.Comparator<? super T> comparator)Returns a sequence with duplicate elements removed, as determined by the provided comparator.default <U> Stream<T>distinctByKeepLast(@NonNull java.util.function.Function<? super T,? extends U> keyExtractor)Returns a sequence with duplicates removed based on a key extracted from each element.default Stream<T>drop(int n)Returns a newTraversablewithout the firstnelements, or an empty instance if this contains fewer thannelements.default Stream<T>dropRight(int n)Returns a newTraversablewithout the lastnelements, or an empty instance if this contains fewer thannelements.default Stream<T>dropRightUntil(@NonNull java.util.function.Predicate<? super T> predicate)Drops elements from the end of the sequence until an element satisfies the given predicate.default Stream<T>dropRightWhile(@NonNull java.util.function.Predicate<? super T> predicate)Drops elements from the end of the sequence while the given predicate holds.default Stream<T>dropUntil(@NonNull java.util.function.Predicate<? super T> predicate)Returns a newTraversablestarting from the first element that satisfies the givenpredicate, dropping all preceding elements.default Stream<T>dropWhile(@NonNull java.util.function.Predicate<? super T> predicate)Returns a newTraversablestarting from the first element that does not satisfy the givenpredicate, dropping all preceding elements.static <T> Stream<T>empty()Returns the single instance of Empty.default Stream<T>extend(@NonNull 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(@NonNull 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, @NonNull 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(@NonNull java.util.function.Predicate<? super T> predicate)Returns a new traversable containing only the elements that satisfy the given predicate.default <U> Stream<U>flatMap(@NonNull java.util.function.Function<? super T,? extends java.lang.Iterable<? extends U>> mapper)Transforms each element of this Traversable into anIterableof elements and flattens the resulting iterables into a single 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(@NonNull java.util.function.Function<? super T,? extends C> classifier)Groups elements of thisTraversablebased on a classifier function.default Iterator<Stream<T>>grouped(int size)Splits thisTraversableinto consecutive blocks of the given size.default booleanhasDefiniteSize()Indicates whether thisTraversablehas a known finite size.default intindexOf(T element, int from)Returns the index of the first occurrence of the given element, starting at the specified index, or-1if this sequence does not contain the element.default Stream<T>init()Returns all elements of this Traversable except the last one.default Option<Stream<T>>initOption()Returns all elements of this Traversable except the last one, wrapped in anOption.default Stream<T>insert(int index, T element)Returns a new sequence with the given element inserted at the specified index.default Stream<T>insertAll(int index, @NonNull java.lang.Iterable<? extends T> elements)Returns a new sequence with the given elements inserted at the specified index.default Stream<T>intersperse(T element)Returns a new sequence where the given element is inserted between all elements of this sequence.default booleanisAsync()AStreamis computed synchronously.default booleanisLazy()AStreamis computed lazily.default booleanisTraversableAgain()Checks if this Traversable can be traversed multiple times without side effects.static <T> Stream<T>iterate(@NonNull 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, @NonNull 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()Returns the last element of this Traversable.default intlastIndexOf(T element, int end)Returns the index of the last occurrence of the given element at or before the specified end index, or-1if this sequence does not contain the element.default Stream<T>leftPadTo(int length, T element)Returns a new sequence with this sequence padded on the left with the given element until the specified target length is reached.default intlength()Returns the number of elements in this Traversable.default <U> Stream<U>map(@NonNull java.util.function.Function<? super T,? extends U> mapper)Transforms the elements of this Traversable to a new type, preserving order if defined.default <U> Stream<U>mapTo(U value)Maps the underlying value to another fixed value.default Stream<java.lang.Void>mapToVoid()Maps the underlying value to Voidstatic <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 @NonNull ... elements)Creates a Stream of the given elements.static Stream<java.lang.Boolean>ofAll(boolean @NonNull ... elements)Creates a Stream from boolean values.static Stream<java.lang.Byte>ofAll(byte @NonNull ... elements)Creates a Stream from byte values.static Stream<java.lang.Character>ofAll(char @NonNull ... elements)Creates a Stream from char values.static Stream<java.lang.Double>ofAll(double @NonNull ... elements)Creates a Stream values double values.static Stream<java.lang.Float>ofAll(float @NonNull ... elements)Creates a Stream from float values.static Stream<java.lang.Integer>ofAll(int @NonNull ... elements)Creates a Stream from int values.static Stream<java.lang.Long>ofAll(long @NonNull ... elements)Creates a Stream from long values.static Stream<java.lang.Short>ofAll(short @NonNull ... elements)Creates a Stream from short values.static <T> Stream<T>ofAll(@NonNull java.lang.Iterable<? extends T> elements)Creates a Stream of the given elements.static <T> Stream<T>ofAll(@NonNull java.util.stream.Stream<? extends T> javaStream)Creates a Stream that contains the elements of the givenStream.default Stream<T>orElse(@NonNull java.lang.Iterable<? extends T> other)Returns thisTraversableif it is non-empty; otherwise, returns the given alternative.default Stream<T>orElse(@NonNull java.util.function.Supplier<? extends java.lang.Iterable<? extends T>> supplier)Returns thisTraversableif it is non-empty; otherwise, returns the result of evaluating the given supplier.default Stream<T>padTo(int length, T element)Returns a new sequence with this sequence padded on the right with the given element until the specified target length is reached.default Tuple2<Stream<T>,Stream<T>>partition(@NonNull java.util.function.Predicate<? super T> predicate)Splits thisTraversableinto two partitions according to a predicate.default Stream<T>patch(int from, @NonNull java.lang.Iterable<? extends T> that, int replaced)Returns a new sequence in which a slice of elements in this sequence is replaced by the elements of another sequence.default Stream<T>peek(@NonNull java.util.function.Consumer<? super T> action)Performs the givenactionon the first element if this is an eager implementation.default Stream<Stream<T>>permutations()Returns all unique permutations of this sequence.default Stream<T>prepend(T element)Returns a new sequence with the given element prepended to this sequence.default Stream<T>prependAll(@NonNull java.lang.Iterable<? extends T> elements)Returns a new sequence with all given elements prepended to this sequence.static Stream<java.lang.Character>range(char from, char toExclusive)Creates a Stream of char numbers starting fromfrom, extending totoExclusive - 1.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)Creates a Stream of char numbers starting fromfrom, extending totoExclusive - 1, withstep.static Stream<java.lang.Double>rangeBy(double from, double toExclusive, double step)Creates a Stream of double numbers starting fromfrom, extending up to but not includingtoExclusive, withstep.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)Creates a Stream of char numbers starting fromfrom, extending totoInclusive.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)Creates a Stream of char values starting fromfrom, extending totoInclusive, withstep.static Stream<java.lang.Double>rangeClosedBy(double from, double toInclusive, double step)Creates a Stream of double values starting fromfrom, extending totoInclusive, withstep.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(@NonNull java.util.function.Predicate<? super T> predicate)Returns a new traversable containing only the elements that do not satisfy the given predicate.default Stream<T>remove(T element)Returns a new sequence with the first occurrence of the given element removed.default Stream<T>removeAll(@NonNull java.lang.Iterable<? extends T> elements)Returns a new sequence with all occurrences of the given elements removed.default Stream<T>removeAll(@NonNull java.util.function.Predicate<? super T> predicate)Deprecated.default Stream<T>removeAll(T element)Returns a new sequence with all occurrences of the given element removed.default Stream<T>removeAt(int index)Returns a new sequence with the element at the specified position removed.default Stream<T>removeFirst(@NonNull java.util.function.Predicate<T> predicate)Returns a new sequence with the first element that satisfies the given predicate removed.default Stream<T>removeLast(@NonNull java.util.function.Predicate<T> predicate)Returns a new sequence with the last element that satisfies the given predicate removed.default Stream<T>replace(T currentElement, T newElement)Replaces the first occurrence ofcurrentElementwithnewElement, if it exists.default Stream<T>replaceAll(T currentElement, T newElement)Replaces all occurrences ofcurrentElementwithnewElement.default Stream<T>retainAll(@NonNull java.lang.Iterable<? extends T> elements)Retains only the elements from this Traversable that are contained in the givenelements.default Stream<T>reverse()Returns a new sequence with the order of elements reversed.default Stream<T>rotateLeft(int n)Returns a new sequence with the elements circularly rotated to the left by the specified distance.default Stream<T>rotateRight(int n)Returns a new sequence with the elements circularly rotated to the right by the specified distance.default Stream<T>scan(T zero, @NonNull java.util.function.BiFunction<? super T,? super T,? extends T> operation)Computes a prefix scan of the elements of this Traversable.default <U> Stream<U>scanLeft(U zero, @NonNull java.util.function.BiFunction<? super U,? super T,? extends U> operation)Produces a collection containing cumulative results of applying the operator from left to right.default <U> Stream<U>scanRight(U zero, @NonNull java.util.function.BiFunction<? super T,? super U,? extends U> operation)Produces a collection containing cumulative results of applying the operator from right to left.default Stream<T>shuffle()Returns a new sequence with the elements randomly shuffled.default Stream<T>slice(int beginIndex, int endIndex)Returns a subsequence (slice) of this sequence, starting atbeginIndex(inclusive) and ending atendIndex(exclusive).default Iterator<Stream<T>>slideBy(@NonNull java.util.function.Function<? super T,?> classifier)Partitions thisTraversableinto consecutive non-overlapping windows according to a classification function.default Iterator<Stream<T>>sliding(int size)Slides a window of a givensizeover thisTraversablewith a step size of 1.default Iterator<Stream<T>>sliding(int size, int step)Slides a window of a specificsizewith a givenstepover thisTraversable.default <U> Stream<T>sortBy(@NonNull java.util.Comparator<? super U> comparator, java.util.function.Function<? super T,? extends U> mapper)Returns a new sequence sorted by comparing elements in a different domain defined by the givenmapper, using the providedcomparator.default <U extends java.lang.Comparable<? super U>>
Stream<T>sortBy(@NonNull java.util.function.Function<? super T,? extends U> mapper)Returns a new sequence sorted by comparing elements in a different domain defined by the givenmapper.default Stream<T>sorted()Returns a new sequence with elements sorted according to their natural order.default Stream<T>sorted(@NonNull java.util.Comparator<? super T> comparator)Returns a new sequence with elements sorted according to the givenComparator.default Tuple2<Stream<T>,Stream<T>>span(@NonNull java.util.function.Predicate<? super T> predicate)Splits thisTraversableinto a prefix and remainder according to the givenpredicate.default Tuple2<Stream<T>,Stream<T>>splitAt(int n)Splits this sequence at the specified index.default Tuple2<Stream<T>,Stream<T>>splitAt(@NonNull java.util.function.Predicate<? super T> predicate)Splits this sequence at the first element satisfying the given predicate.default Tuple2<Stream<T>,Stream<T>>splitAtInclusive(@NonNull java.util.function.Predicate<? super T> predicate)Splits this sequence at the first element satisfying the given predicate, including the element in the first part.default java.lang.StringstringPrefix()Returns the name of this Value type, which is used by toString().default Stream<T>subSequence(int beginIndex)Returns aSeqthat is a subsequence of this sequence, starting from the specifiedbeginIndexand extending to the end of this sequence.default Stream<T>subSequence(int beginIndex, int endIndex)Returns aSeqthat is a subsequence of this sequence, starting from the specifiedbeginIndex(inclusive) and ending atendIndex(exclusive).static <T> Stream<T>tabulate(int n, @NonNull 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()Returns a newTraversablewithout its first element.default Option<Stream<T>>tailOption()Returns a newTraversablewithout its first element as anOption.default Stream<T>take(int n)Returns the firstnelements of thisTraversable, or all elements ifnexceeds the length.default Stream<T>takeRight(int n)Returns the lastnelements of thisTraversable, or all elements ifnexceeds the length.default Stream<T>takeRightUntil(@NonNull java.util.function.Predicate<? super T> predicate)Takes elements from the end of the sequence until an element satisfies the given predicate.default Stream<T>takeRightWhile(@NonNull java.util.function.Predicate<? super T> predicate)Takes elements from the end of the sequence while the given predicate holds.default Stream<T>takeUntil(@NonNull java.util.function.Predicate<? super T> predicate)Takes elements from thisTraversableuntil the given predicate holds for an element.default Stream<T>takeWhile(@NonNull java.util.function.Predicate<? super T> predicate)Takes elements from thisTraversablewhile the given predicate holds.default <U> Utransform(@NonNull java.util.function.Function<? super Stream<T>,? extends U> f)Transforms thisStream.static <T> Stream<Stream<T>>transpose(@NonNull Stream<Stream<T>> matrix)Transposes the rows and columns of aStreammatrix.static <T> Stream<T>unfold(T seed, @NonNull 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, @NonNull 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, @NonNull 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(@NonNull java.util.function.Function<? super T,Tuple2<? extends T1,? extends T2>> unzipper)Unzips the elements of thisTraversableby mapping each element to a pair and splitting them into two separateTraversablecollections.default <T1,T2,T3>
Tuple3<Stream<T1>,Stream<T2>,Stream<T3>>unzip3(@NonNull java.util.function.Function<? super T,Tuple3<? extends T1,? extends T2,? extends T3>> unzipper)Unzips the elements of thisTraversableby mapping each element to a triple and splitting them into three separateTraversablecollections.default Stream<T>update(int index, @NonNull java.util.function.Function<? super T,? extends T> updater)Returns a newSeqwith the element at the specified index updated using the given function.default Stream<T>update(int index, T element)Returns a newSeqwith the element at the specified index replaced by the given value.default <U> Stream<Tuple2<T,U>>zip(@NonNull java.lang.Iterable<? extends U> that)Returns aTraversableformed by pairing elements of thisTraversablewith elements of anotherIterable.default <U> Stream<Tuple2<T,U>>zipAll(@NonNull java.lang.Iterable<? extends U> iterable, T thisElem, U thatElem)Returns aTraversableformed by pairing elements of thisTraversablewith elements of anotherIterable, filling in placeholder elements when one collection is shorter than the other.default <U,R>
Stream<R>zipWith(@NonNull java.lang.Iterable<? extends U> that, java.util.function.BiFunction<? super T,? super U,? extends R> mapper)Returns aTraversableby combining elements of thisTraversablewith elements of anotherIterableusing a mapping function.default Stream<Tuple2<T,java.lang.Integer>>zipWithIndex()Zips thisTraversablewith its indices, starting at 0.default <U> Stream<U>zipWithIndex(@NonNull java.util.function.BiFunction<? super T,? super java.lang.Integer,? extends U> mapper)Zips thisTraversablewith its indices and maps the resulting pairs using the provided mapper.-
Methods inherited from interface io.vavr.collection.Foldable
fold, reduce, reduceOption
-
Methods inherited from interface io.vavr.Function1
andThen, arity, compose, compose1, 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
The serial version UID for serialization.- 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(@NonNull java.lang.Iterable<? extends T> @NonNull ... 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(@NonNull 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(@NonNull 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, @NonNull 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(@NonNull 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, @NonNull 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 Empty. Convenience method forEmpty.instance().Note: this method intentionally returns type
Streamand notEmpty. This comes in handy when folding. If you explicitly need typeEmptyuse Stream.Empty.instance().- Type Parameters:
T- Component type of Empty, 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 @NonNull ... elements)
Creates a Stream of the given elements.Stream.of(1, 2, 3, 4) = Empty.instance().prepend(4).prepend(3).prepend(2).prepend(1) = new Cons(1, new Cons(2, new Cons(3, new Cons(4, Empty.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, @NonNull 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, @NonNull 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(@NonNull 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(@NonNull 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 @NonNull ... 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 @NonNull ... 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 @NonNull ... 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 @NonNull ... 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 @NonNull ... 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 @NonNull ... 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 @NonNull ... 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 @NonNull ... 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)
Creates a Stream of char numbers starting fromfrom, extending totoExclusive - 1.Examples:
Stream.range('a', 'a') // = Stream() Stream.range('c', 'a') // = Stream() Stream.range('a', 'd') // = Stream('a', 'b', 'c')- Parameters:
from- the first chartoExclusive- the last char + 1- Returns:
- a range of char values as specified or
Niliffrom >= toExclusive
-
rangeBy
static Stream<java.lang.Character> rangeBy(char from, char toExclusive, int step)
Creates a Stream of char numbers starting fromfrom, extending totoExclusive - 1, withstep.Examples:
Stream.rangeBy('a', 'c', 1) // = Stream('a', 'b') Stream.rangeBy('a', 'd', 2) // = Stream('a', 'c') Stream.rangeBy('d', 'a', -2) // = Stream('d', 'b') Stream.rangeBy('d', 'a', 2) // = Stream()- Parameters:
from- the first chartoExclusive- the last char + 1step- the step- Returns:
- a range of char values as specified or
Nilif
from >= toExclusiveandstep > 0or
from <= toExclusiveandstep < 0 - Throws:
java.lang.IllegalArgumentException- ifstepis zero
-
rangeBy
@GwtIncompatible static Stream<java.lang.Double> rangeBy(double from, double toExclusive, double step)
Creates a Stream of double numbers starting fromfrom, extending up to but not includingtoExclusive, withstep.Examples:
Stream.rangeBy(1.0, 3.0, 1.0) // = Stream(1.0, 2.0) Stream.rangeBy(1.0, 4.0, 2.0) // = Stream(1.0, 3.0) Stream.rangeBy(4.0, 1.0, -2.0) // = Stream(4.0, 2.0) Stream.rangeBy(4.0, 1.0, 2.0) // = Stream()- Parameters:
from- the first doubletoExclusive- the upper bound (exclusive)step- the step- Returns:
- a range of double values as specified or
Nilif
from >= toExclusiveandstep > 0or
from <= toExclusiveandstep < 0 - Throws:
java.lang.IllegalArgumentException- ifstepis zero
-
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)
Creates a Stream of char numbers starting fromfrom, extending totoInclusive.Examples:
Stream.rangeClosed('a', 'a') // = Stream('a') Stream.rangeClosed('c', 'a') // = Stream() Stream.rangeClosed('a', 'd') // = Stream('a', 'b', 'c', 'd')- Parameters:
from- the first chartoInclusive- the last char- Returns:
- a range of char values as specified or
Niliffrom > toInclusive
-
rangeClosedBy
static Stream<java.lang.Character> rangeClosedBy(char from, char toInclusive, int step)
Creates a Stream of char values starting fromfrom, extending totoInclusive, withstep.- Parameters:
from- the first chartoInclusive- the last char (inclusive)step- the step- Returns:
- a range of char values as specified or
Nilif
from >= toInclusiveandstep > 0or
from <= toInclusiveandstep < 0 - Throws:
java.lang.IllegalArgumentException- ifstepis zero
-
rangeClosedBy
@GwtIncompatible static Stream<java.lang.Double> rangeClosedBy(double from, double toInclusive, double step)
Creates a Stream of double values starting fromfrom, extending totoInclusive, withstep.- Parameters:
from- the first doubletoInclusive- the last double (inclusive)step- the step- Returns:
- a range of double values as specified or
Nilif
from >= toInclusiveandstep > 0or
from <= toInclusiveandstep < 0 - Throws:
java.lang.IllegalArgumentException- ifstepis zero
-
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(@NonNull 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, @NonNull 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, @NonNull 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, @NonNull 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:SeqReturns a new sequence with the given element appended at the end.
-
appendAll
default Stream<T> appendAll(@NonNull java.lang.Iterable<? extends T> elements)
Description copied from interface:SeqReturns a new sequence with all elements from the givenIterableappended at the end of this sequence.
-
appendSelf
default Stream<T> appendSelf(@NonNull 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:SeqReturns an immutableListview of thisSeq. Any attempt to modify the view (e.g., via mutator methods) will throwUnsupportedOperationExceptionat runtime.This is a view, not a copy. Compared to conversion methods like
toJava*():- Creating the view is O(1) (constant time), whereas conversions take O(n), with n = collection size.
- Operations on the view have the same performance characteristics as the underlying persistent Vavr collection, while converted collections behave like standard Java collections.
Note: the immutable Java list view throws
UnsupportedOperationExceptionbefore checking method arguments, which may differ from standard Java behavior.
-
asJava
@GwtIncompatible default Stream<T> asJava(@NonNull java.util.function.Consumer<? super java.util.List<T>> action)
Description copied from interface:SeqCreates an immutableListview of thisSeqand passes it to the givenaction.The view is immutable: any attempt to modify it will throw
UnsupportedOperationExceptionat runtime.
-
asJavaMutable
@GwtIncompatible default java.util.List<T> asJavaMutable()
Description copied from interface:SeqReturns a mutableListview of thisSeq. All standard mutator methods of theListinterface are supported and modify the underlying view.Unlike
Seq.asJava(), this view allows modifications, but the performance characteristics correspond to the underlying persistent Vavr collection.- Specified by:
asJavaMutablein interfaceSeq<T>- Returns:
- a mutable
Listview of this sequence - See Also:
Seq.asJava()
-
asJavaMutable
@GwtIncompatible default Stream<T> asJavaMutable(@NonNull java.util.function.Consumer<? super java.util.List<T>> action)
Description copied from interface:SeqCreates a mutableListview of thisSeqand passes it to the givenaction.The view supports all standard mutator methods. The result of the action determines what is returned:
- If only read operations are performed, this instance is returned.
- If any write operations are performed, a new
Seqreflecting those changes is returned.
- Specified by:
asJavaMutablein interfaceLinearSeq<T>- Specified by:
asJavaMutablein interfaceSeq<T>- Parameters:
action- a side-effecting operation that receives a mutablejava.util.Listview- Returns:
- this sequence or a new sequence reflecting modifications made through the view
- See Also:
Seq.asJavaMutable()
-
collect
default <R> Stream<R> collect(@NonNull PartialFunction<? super T,? extends R> partialFunction)
Description copied from interface:TraversableApplies aPartialFunctionto all elements that are defined for it and collects the results.For each element in iteration order, the function is first tested:
IfpartialFunction.isDefinedAt(element)true, the element is mapped to typeR:R newElement = partialFunction.apply(element)Note: If this
Traversableis ordered (i.e., extendsOrdered), the caller must ensure that the resulting elements are comparable (i.e., implementComparable).- Specified by:
collectin interfaceLinearSeq<T>- Specified by:
collectin interfaceSeq<T>- Specified by:
collectin interfaceTraversable<T>- Type Parameters:
R- the type of elements in the resultingTraversable- Parameters:
partialFunction- a function that may not be defined for all elements of this traversable- Returns:
- a new
Traversablecontaining the results of applying the partial function
-
combinations
default Stream<Stream<T>> combinations()
Description copied from interface:SeqReturns a sequence containing all combinations of elements from this sequence, for all sizes from0tolength().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:
- a sequence of sequences representing all combinations of this sequence's elements
-
combinations
default Stream<Stream<T>> combinations(int k)
Description copied from interface:SeqReturns all subsets of this sequence containing exactlykdistinct elements, i.e., the k-combinations of this sequence.- Specified by:
combinationsin interfaceLinearSeq<T>- Specified by:
combinationsin interfaceSeq<T>- Parameters:
k- the size of each subset- Returns:
- a sequence of sequences representing all k-element combinations
- See Also:
- Combination
-
crossProduct
default Iterator<Stream<T>> crossProduct(int power)
Description copied from interface:SeqReturns the n-ary Cartesian power (cross product) of this sequence. Each element of the resulting iterator is a sequence of lengthpower, containing all possible combinations of elements from this sequence.Example for power = 2:
// Result: [(A,A), (A,B), (A,C), ..., (B,A), (B,B), ..., (Z,Y), (Z,Z)] CharSeq.rangeClosed('A', 'Z').crossProduct(2);If
poweris negative, the result is an empty iterator:// Result: () CharSeq.rangeClosed('A', 'Z').crossProduct(-1);- Specified by:
crossProductin interfaceLinearSeq<T>- Specified by:
crossProductin interfaceSeq<T>- Parameters:
power- the number of Cartesian multiplications- Returns:
- an
Iteratorover sequences representing the Cartesian power of this sequence
-
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 newTraversablecontaining the elements of this instance with all duplicates removed. Element equality is determined usingequals.
-
distinctBy
default Stream<T> distinctBy(@NonNull java.util.Comparator<? super T> comparator)
Description copied from interface:TraversableReturns a newTraversablecontaining the elements of this instance without duplicates, as determined by the givencomparator.- Specified by:
distinctByin interfaceLinearSeq<T>- Specified by:
distinctByin interfaceSeq<T>- Specified by:
distinctByin interfaceTraversable<T>- Parameters:
comparator- a comparator used to determine equality of elements- Returns:
- a new
Traversablewith duplicates removed
-
distinctBy
default <U> Stream<T> distinctBy(@NonNull java.util.function.Function<? super T,? extends U> keyExtractor)
Description copied from interface:TraversableReturns a newTraversablecontaining the elements of this instance without duplicates, based on keys extracted from elements usingkeyExtractor.The first occurrence of each key is retained in the resulting sequence.
- Specified by:
distinctByin interfaceLinearSeq<T>- Specified by:
distinctByin interfaceSeq<T>- Specified by:
distinctByin interfaceTraversable<T>- Type Parameters:
U- the type of key- Parameters:
keyExtractor- a function to extract keys for determining uniqueness- Returns:
- a new
Traversablewith duplicates removed based on keys
-
distinctByKeepLast
default Stream<T> distinctByKeepLast(@NonNull java.util.Comparator<? super T> comparator)
Description copied from interface:SeqReturns a sequence with duplicate elements removed, as determined by the provided comparator. When duplicates are found, the **last occurrence** of each element is retained.- Specified by:
distinctByKeepLastin interfaceLinearSeq<T>- Specified by:
distinctByKeepLastin interfaceSeq<T>- Parameters:
comparator- a comparator defining equality between elements- Returns:
- a new sequence with duplicates removed, keeping the last occurrence of each element
-
distinctByKeepLast
default <U> Stream<T> distinctByKeepLast(@NonNull java.util.function.Function<? super T,? extends U> keyExtractor)
Description copied from interface:SeqReturns a sequence with duplicates removed based on a key extracted from each element. The key is obtained via the providedkeyExtractorfunction. When duplicates are found, the **last occurrence** of each element for a given key is retained.- Specified by:
distinctByKeepLastin interfaceLinearSeq<T>- Specified by:
distinctByKeepLastin interfaceSeq<T>- Type Parameters:
U- the type of the key used for determining uniqueness- Parameters:
keyExtractor- a function extracting a key from each element for uniqueness comparison- Returns:
- a new sequence of elements distinct by the extracted key, keeping the last occurrence
-
drop
default Stream<T> drop(int n)
Description copied from interface:TraversableReturns a newTraversablewithout the firstnelements, or an empty instance if this contains fewer thannelements.
-
dropUntil
default Stream<T> dropUntil(@NonNull java.util.function.Predicate<? super T> predicate)
Description copied from interface:TraversableReturns a newTraversablestarting from the first element that satisfies the givenpredicate, dropping all preceding elements.
-
dropWhile
default Stream<T> dropWhile(@NonNull java.util.function.Predicate<? super T> predicate)
Description copied from interface:TraversableReturns a newTraversablestarting from the first element that does not satisfy the givenpredicate, dropping all preceding elements.This is equivalent to
dropUntil(predicate.negate()), which is useful for method references that cannot be negated directly.
-
dropRight
default Stream<T> dropRight(int n)
Description copied from interface:TraversableReturns a newTraversablewithout the lastnelements, or an empty instance if this contains fewer thannelements.
-
dropRightUntil
default Stream<T> dropRightUntil(@NonNull java.util.function.Predicate<? super T> predicate)
Description copied from interface:SeqDrops elements from the end of the sequence until an element satisfies the given predicate. The returned sequence includes the last element that satisfies the predicate.- Specified by:
dropRightUntilin interfaceLinearSeq<T>- Specified by:
dropRightUntilin interfaceSeq<T>- Parameters:
predicate- a condition to test elements, starting from the end- Returns:
- a new sequence containing all elements up to and including the last element that satisfies the predicate
-
dropRightWhile
default Stream<T> dropRightWhile(@NonNull java.util.function.Predicate<? super T> predicate)
Description copied from interface:SeqDrops elements from the end of the sequence while the given predicate holds.This is equivalent to
dropRightUntil(predicate.negate()). Useful when using method references that cannot be negated directly.- Specified by:
dropRightWhilein interfaceLinearSeq<T>- Specified by:
dropRightWhilein interfaceSeq<T>- Parameters:
predicate- a condition to test elements, starting from the end- Returns:
- a new sequence containing all elements up to and including the last element that does not satisfy the predicate
-
filter
default Stream<T> filter(@NonNull java.util.function.Predicate<? super T> predicate)
Description copied from interface:TraversableReturns a new traversable containing only the elements that satisfy the given predicate.
-
reject
default Stream<T> reject(@NonNull java.util.function.Predicate<? super T> predicate)
Description copied from interface:TraversableReturns a new traversable containing only the elements that do not satisfy the given predicate.This is equivalent to
filter(predicate.negate()).
-
flatMap
default <U> Stream<U> flatMap(@NonNull java.util.function.Function<? super T,? extends java.lang.Iterable<? extends U>> mapper)
Description copied from interface:TraversableTransforms each element of this Traversable into anIterableof elements and flattens the resulting iterables into a single Traversable.- Specified by:
flatMapin interfaceLinearSeq<T>- Specified by:
flatMapin interfaceSeq<T>- Specified by:
flatMapin interfaceTraversable<T>- Type Parameters:
U- the type of elements in the resulting Traversable- Parameters:
mapper- a function mapping elements to iterables- Returns:
- a new Traversable containing all elements produced by applying
mapperand flattening
-
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(@NonNull java.util.function.Function<? super T,? extends C> classifier)
Description copied from interface:TraversableGroups elements of thisTraversablebased on a classifier function.- Specified by:
groupByin interfaceLinearSeq<T>- Specified by:
groupByin interfaceSeq<T>- Specified by:
groupByin interfaceTraversable<T>- Type Parameters:
C- The type of the group keys- Parameters:
classifier- A function that assigns each element to a group- Returns:
- A map where each key corresponds to a group of elements
- See Also:
Traversable.arrangeBy(Function)
-
grouped
default Iterator<Stream<T>> grouped(int size)
Description copied from interface:TraversableSplits thisTraversableinto consecutive blocks of the given size.Let
lengthbe the number of elements in thisTraversable:- If empty, the resulting
Iteratoris empty. - If
size <= length, the resultingIteratorcontainslength / sizeblocks of sizesizeand possibly a final smaller block of sizelength % size. - If
size > length, the resultingIteratorcontains a single block of sizelength.
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]]Note:
grouped(size)is equivalent tosliding(size, size). - If empty, the resulting
-
hasDefiniteSize
default boolean hasDefiniteSize()
Description copied from interface:TraversableIndicates whether thisTraversablehas a known finite size.This should typically be implemented by concrete classes, not interfaces.
- Specified by:
hasDefiniteSizein interfaceTraversable<T>- Returns:
trueif the number of elements is finite and known,falseotherwise.
-
indexOf
default int indexOf(T element, int from)
Description copied from interface:SeqReturns the index of the first occurrence of the given element, starting at the specified index, or-1if this sequence does not contain the element.
-
init
default Stream<T> init()
Description copied from interface:TraversableReturns all elements of this Traversable except the last one.This is the dual of
Traversable.tail().
-
initOption
default Option<Stream<T>> initOption()
Description copied from interface:TraversableReturns all elements of this Traversable except the last one, wrapped in anOption.This is the dual of
Traversable.tailOption().- Specified by:
initOptionin interfaceLinearSeq<T>- Specified by:
initOptionin interfaceSeq<T>- Specified by:
initOptionin interfaceTraversable<T>- Returns:
Some(traversable)if non-empty, orNoneif this Traversable is empty
-
insert
default Stream<T> insert(int index, T element)
Description copied from interface:SeqReturns a new sequence with the given element inserted at the specified index.
-
insertAll
default Stream<T> insertAll(int index, @NonNull java.lang.Iterable<? extends T> elements)
Description copied from interface:SeqReturns a new sequence with the given elements inserted at the specified index.
-
intersperse
default Stream<T> intersperse(T element)
Description copied from interface:SeqReturns a new sequence where the given element is inserted between all elements of this sequence.- Specified by:
interspersein interfaceLinearSeq<T>- Specified by:
interspersein interfaceSeq<T>- Parameters:
element- the element to intersperse- Returns:
- a new
Seqwith the element interspersed
-
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 traversed multiple times without side effects.Implementations should provide the correct behavior; this is not meant for interfaces alone.
- Specified by:
isTraversableAgainin interfaceTraversable<T>- Returns:
trueif this Traversable is guaranteed to be repeatably traversable,falseotherwise
-
last
default T last()
Description copied from interface:TraversableReturns the last element of this Traversable.- 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 at or before the specified end index, or-1if this sequence does not contain the element.- Specified by:
lastIndexOfin interfaceSeq<T>- Parameters:
element- the element to search forend- the maximum index to consider- Returns:
- the index of the last occurrence at or before
end, or-1if not found
-
length
default int length()
Description copied from interface:TraversableReturns the number of elements in this Traversable.Equivalent to
Traversable.size().- Specified by:
lengthin interfaceTraversable<T>- Returns:
- the number of elements
-
map
default <U> Stream<U> map(@NonNull java.util.function.Function<? super T,? extends U> mapper)
Description copied from interface:TraversableTransforms the elements of this Traversable to a new type, preserving order if defined.- Specified by:
mapin interfaceLinearSeq<T>- Specified by:
mapin interfaceSeq<T>- Specified by:
mapin interfaceTraversable<T>- Specified by:
mapin interfaceValue<T>- Type Parameters:
U- the target element type- Parameters:
mapper- a mapping function- Returns:
- a new Traversable containing the mapped elements
-
mapTo
default <U> Stream<U> mapTo(U value)
Description copied from interface:ValueMaps the underlying value to another fixed value.
-
mapToVoid
default Stream<java.lang.Void> mapToVoid()
Description copied from interface:ValueMaps the underlying value to Void
-
padTo
default Stream<T> padTo(int length, T element)
Description copied from interface:SeqReturns a new sequence with this sequence padded on the right with the given element until the specified target length is reached.Note: Lazily-evaluated sequences may need to process all elements to determine the overall length.
- Specified by:
padToin interfaceLinearSeq<T>- Specified by:
padToin interfaceSeq<T>- Parameters:
length- the target length of the resulting sequenceelement- the element to append as padding- Returns:
- a new
Seqconsisting of this sequence followed by the minimal number of occurrences ofelementto reach at leastlength
-
leftPadTo
default Stream<T> leftPadTo(int length, T element)
Description copied from interface:SeqReturns a new sequence with this sequence padded on the left with the given element until the specified target length is reached.Note: Lazily-evaluated sequences may need to process all elements to determine the overall length.
-
orElse
default Stream<T> orElse(@NonNull java.lang.Iterable<? extends T> other)
Description copied from interface:TraversableReturns thisTraversableif it is non-empty; otherwise, returns the given alternative.
-
orElse
default Stream<T> orElse(@NonNull java.util.function.Supplier<? extends java.lang.Iterable<? extends T>> supplier)
Description copied from interface:TraversableReturns thisTraversableif it is non-empty; otherwise, returns the result of evaluating the given supplier.
-
patch
default Stream<T> patch(int from, @NonNull java.lang.Iterable<? extends T> that, int replaced)
Description copied from interface:SeqReturns a new sequence in which a slice of elements in this sequence is replaced by the elements of another sequence.- Specified by:
patchin interfaceLinearSeq<T>- Specified by:
patchin interfaceSeq<T>- Parameters:
from- the starting index of the slice to be replacedthat- the sequence of elements to insert; must not benullreplaced- the number of elements to remove from this sequence starting atfrom- Returns:
- a new
Seqwith the specified slice replaced
-
partition
default Tuple2<Stream<T>,Stream<T>> partition(@NonNull java.util.function.Predicate<? super T> predicate)
Description copied from interface:TraversableSplits thisTraversableinto two partitions according to a predicate.The first partition contains all elements that satisfy the predicate, and the second contains all elements that do not. The original iteration order is preserved.
-
peek
default Stream<T> peek(@NonNull 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:SeqReturns all unique permutations of this sequence.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:
- a sequence of all unique permutations of this sequence
-
prepend
default Stream<T> prepend(T element)
Description copied from interface:SeqReturns a new sequence with the given element prepended to this sequence.
-
prependAll
default Stream<T> prependAll(@NonNull java.lang.Iterable<? extends T> elements)
Description copied from interface:SeqReturns a new sequence with all given elements prepended to this sequence.- Specified by:
prependAllin interfaceLinearSeq<T>- Specified by:
prependAllin interfaceSeq<T>- Parameters:
elements- the elements to prepend; must not benull- Returns:
- a new
Seqwith the elements added at the front
-
remove
default Stream<T> remove(T element)
Description copied from interface:SeqReturns a new sequence with the first occurrence of the given element removed.
-
removeFirst
default Stream<T> removeFirst(@NonNull java.util.function.Predicate<T> predicate)
Description copied from interface:SeqReturns a new sequence with the first element that satisfies the given predicate removed.- Specified by:
removeFirstin interfaceLinearSeq<T>- Specified by:
removeFirstin interfaceSeq<T>- Parameters:
predicate- the predicate used to identify the element to remove; must not benull- Returns:
- a new
Seqwithout the first matching element
-
removeLast
default Stream<T> removeLast(@NonNull java.util.function.Predicate<T> predicate)
Description copied from interface:SeqReturns a new sequence with the last element that satisfies the given predicate removed.- Specified by:
removeLastin interfaceLinearSeq<T>- Specified by:
removeLastin interfaceSeq<T>- Parameters:
predicate- the predicate used to identify the element to remove; must not benull- Returns:
- a new
Seqwithout the last matching element
-
removeAt
default Stream<T> removeAt(int index)
Description copied from interface:SeqReturns a new sequence with the element at the specified position removed. Subsequent elements are shifted to the left (indices decreased by one).
-
removeAll
default Stream<T> removeAll(T element)
Description copied from interface:SeqReturns a new sequence with all occurrences of the given element removed.
-
removeAll
default Stream<T> removeAll(@NonNull java.lang.Iterable<? extends T> elements)
Description copied from interface:SeqReturns a new sequence with all occurrences of the given elements removed.
-
removeAll
@Deprecated default Stream<T> removeAll(@NonNull 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 ofcurrentElementwithnewElement, if it exists.- Specified by:
replacein interfaceLinearSeq<T>- Specified by:
replacein interfaceSeq<T>- Specified by:
replacein interfaceTraversable<T>- Parameters:
currentElement- the element to be replacednewElement- the replacement element- Returns:
- a new Traversable with the first occurrence of
currentElementreplaced bynewElement
-
replaceAll
default Stream<T> replaceAll(T currentElement, T newElement)
Description copied from interface:TraversableReplaces all occurrences ofcurrentElementwithnewElement.- Specified by:
replaceAllin interfaceLinearSeq<T>- Specified by:
replaceAllin interfaceSeq<T>- Specified by:
replaceAllin interfaceTraversable<T>- Parameters:
currentElement- the element to be replacednewElement- the replacement element- Returns:
- a new Traversable with all occurrences of
currentElementreplaced bynewElement
-
retainAll
default Stream<T> retainAll(@NonNull java.lang.Iterable<? extends T> elements)
Description copied from interface:TraversableRetains only the elements from this Traversable that are contained in the givenelements.
-
reverse
default Stream<T> reverse()
Description copied from interface:SeqReturns a new sequence with the order of elements reversed.
-
rotateLeft
default Stream<T> rotateLeft(int n)
Description copied from interface:SeqReturns a new sequence with the elements circularly rotated to the left by the specified distance.Example:
// Result: 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- the number of positions to rotate left- Returns:
- a new
Seqwith elements rotated left
-
rotateRight
default Stream<T> rotateRight(int n)
Description copied from interface:SeqReturns a new sequence with the elements circularly rotated to the right by the specified distance.Example:
// Result: 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- the number of positions to rotate right- Returns:
- a new
Seqwith elements rotated right
-
scan
default Stream<T> scan(T zero, @NonNull java.util.function.BiFunction<? super T,? super T,? extends T> operation)
Description copied from interface:TraversableComputes a prefix scan of the elements of this Traversable.The neutral element
zeromay be applied more than once.
-
scanLeft
default <U> Stream<U> scanLeft(U zero, @NonNull 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 from left to right.Will not terminate for infinite collections. The results may vary across runs unless the collection is ordered.
- Specified by:
scanLeftin interfaceLinearSeq<T>- Specified by:
scanLeftin interfaceSeq<T>- Specified by:
scanLeftin interfaceTraversable<T>- Type Parameters:
U- the type of the resulting elements- Parameters:
zero- the initial valueoperation- a binary operator applied to the intermediate result and each element- Returns:
- a new Traversable containing the cumulative results
-
scanRight
default <U> Stream<U> scanRight(U zero, @NonNull 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 from right to left.The head of the resulting collection is the last cumulative result. Will not terminate for infinite collections. Results may vary across runs unless the collection is ordered.
- Specified by:
scanRightin interfaceLinearSeq<T>- Specified by:
scanRightin interfaceSeq<T>- Specified by:
scanRightin interfaceTraversable<T>- Type Parameters:
U- the type of the resulting elements- Parameters:
zero- the initial valueoperation- a binary operator applied to each element and the intermediate result- Returns:
- a new Traversable containing the cumulative results
-
shuffle
default Stream<T> shuffle()
Description copied from interface:SeqReturns a new sequence with the elements randomly shuffled.
-
slice
default Stream<T> slice(int beginIndex, int endIndex)
Description copied from interface:SeqReturns a subsequence (slice) of this sequence, starting atbeginIndex(inclusive) and ending atendIndex(exclusive).Examples:
List.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)See also
Seq.subSequence(int, int), which may throw an exception instead of returning a sequence in some cases.
-
slideBy
default Iterator<Stream<T>> slideBy(@NonNull java.util.function.Function<? super T,?> classifier)
Description copied from interface:TraversablePartitions thisTraversableinto consecutive non-overlapping windows according to a classification function.Each window contains elements with the same class, as determined by
classifier. Two consecutive elements belong to the same window only ifclassifierreturns equal values for both. Otherwise, the current window ends and a new window begins with the next element.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 givensizeover thisTraversablewith a step size of 1.This is equivalent to calling
Traversable.sliding(int, int)with a step size of 1.
-
sliding
default Iterator<Stream<T>> sliding(int size, int step)
Description copied from interface:TraversableSlides a window of a specificsizewith a givenstepover 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:SeqReturns a new sequence with elements sorted according to their natural order.
-
sorted
default Stream<T> sorted(@NonNull java.util.Comparator<? super T> comparator)
Description copied from interface:SeqReturns a new sequence with elements sorted according to the givenComparator.
-
sortBy
default <U extends java.lang.Comparable<? super U>> Stream<T> sortBy(@NonNull java.util.function.Function<? super T,? extends U> mapper)
Description copied from interface:SeqReturns a new sequence sorted by comparing elements in a different domain defined by the givenmapper.
-
sortBy
default <U> Stream<T> sortBy(@NonNull java.util.Comparator<? super U> comparator, java.util.function.Function<? super T,? extends U> mapper)
Description copied from interface:SeqReturns a new sequence sorted by comparing elements in a different domain defined by the givenmapper, using the providedcomparator.- Specified by:
sortByin interfaceLinearSeq<T>- Specified by:
sortByin interfaceSeq<T>- Type Parameters:
U- the type used for comparison- Parameters:
comparator- the comparator used to compare mapped values; must not benullmapper- a function mapping elements to the domain for comparison; must not benull- Returns:
- a new
Seqsorted according to the mapped values and comparator
-
span
default Tuple2<Stream<T>,Stream<T>> span(@NonNull java.util.function.Predicate<? super T> predicate)
Description copied from interface:TraversableSplits thisTraversableinto a prefix and remainder according to the givenpredicate.The first element of the returned
Tupleis the longest prefix of elements satisfyingpredicate, and the second element is the remaining elements.
-
splitAt
default Tuple2<Stream<T>,Stream<T>> splitAt(int n)
Description copied from interface:SeqSplits this sequence at the specified index.The result of
splitAt(n)is equivalent toTuple.of(take(n), drop(n)).
-
splitAt
default Tuple2<Stream<T>,Stream<T>> splitAt(@NonNull java.util.function.Predicate<? super T> predicate)
Description copied from interface:SeqSplits this sequence at the first element satisfying the given predicate.
-
splitAtInclusive
default Tuple2<Stream<T>,Stream<T>> splitAtInclusive(@NonNull java.util.function.Predicate<? super T> predicate)
Description copied from interface:SeqSplits this sequence at the first element satisfying the given predicate, including the element in the first part.- Specified by:
splitAtInclusivein interfaceSeq<T>- Parameters:
predicate- the predicate used to determine the split point; must not benull- Returns:
- a
Tuple2containing the sequence up to and including the first matching element and the remaining sequence
-
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 aSeqthat is a subsequence of this sequence, starting from the specifiedbeginIndexand extending to the end of this sequence.Examples:
List.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 IndexOutOfBoundsExceptionSee also
Seq.drop(int), which provides similar functionality but does not throw an exception for out-of-bounds indices.- Specified by:
subSequencein interfaceLinearSeq<T>- Specified by:
subSequencein interfaceSeq<T>- Parameters:
beginIndex- the starting index (inclusive) of the subsequence- Returns:
- a new
Seqrepresenting the subsequence frombeginIndexto the end
-
subSequence
default Stream<T> subSequence(int beginIndex, int endIndex)
Description copied from interface:SeqReturns aSeqthat is a subsequence of this sequence, starting from the specifiedbeginIndex(inclusive) and ending atendIndex(exclusive).Examples:
List.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 IndexOutOfBoundsExceptionSee also
Seq.slice(int, int), which returns an empty sequence instead of throwing exceptions when indices are out of range.- Specified by:
subSequencein interfaceLinearSeq<T>- Specified by:
subSequencein interfaceSeq<T>- Parameters:
beginIndex- the starting index (inclusive) of the subsequenceendIndex- the ending index (exclusive) of the subsequence- Returns:
- a new
Seqrepresenting the subsequence frombeginIndextoendIndex - 1
-
tail
Stream<T> tail()
Description copied from interface:TraversableReturns a newTraversablewithout its first element.
-
tailOption
default Option<Stream<T>> tailOption()
Description copied from interface:TraversableReturns a newTraversablewithout its first element as anOption.- Specified by:
tailOptionin interfaceLinearSeq<T>- Specified by:
tailOptionin interfaceSeq<T>- Specified by:
tailOptionin interfaceTraversable<T>- Returns:
Some(traversable)if non-empty, otherwiseNone
-
take
default Stream<T> take(int n)
Description copied from interface:TraversableReturns the firstnelements of thisTraversable, or all elements ifnexceeds the length.Equivalent to
sublist(0, max(0, min(length(), n))), but safe forn < 0orn > length().If
n < 0, an empty instance is returned. Ifn > length(), the full instance is returned.
-
takeUntil
default Stream<T> takeUntil(@NonNull java.util.function.Predicate<? super T> predicate)
Description copied from interface:TraversableTakes elements from thisTraversableuntil the given predicate holds for an element.Equivalent to
takeWhile(predicate.negate()), but useful when using method references that cannot be negated directly.- Specified by:
takeUntilin interfaceLinearSeq<T>- Specified by:
takeUntilin interfaceSeq<T>- Specified by:
takeUntilin interfaceTraversable<T>- Parameters:
predicate- a condition tested sequentially on the elements- Returns:
- a new
Traversablecontaining all elements before the first one that satisfies the predicate
-
takeWhile
default Stream<T> takeWhile(@NonNull java.util.function.Predicate<? super T> predicate)
Description copied from interface:TraversableTakes elements from thisTraversablewhile the given predicate holds.- Specified by:
takeWhilein interfaceLinearSeq<T>- Specified by:
takeWhilein interfaceSeq<T>- Specified by:
takeWhilein interfaceTraversable<T>- Parameters:
predicate- a condition tested sequentially on the elements- Returns:
- a new
Traversablecontaining all elements up to (but not including) the first one that does not satisfy the predicate
-
takeRight
default Stream<T> takeRight(int n)
Description copied from interface:TraversableReturns the lastnelements of thisTraversable, or all elements ifnexceeds the length.Equivalent to
sublist(max(0, length() - n), length()), but safe forn < 0orn > length().If
n < 0, an empty instance is returned. Ifn > length(), the full instance is returned.
-
takeRightUntil
default Stream<T> takeRightUntil(@NonNull java.util.function.Predicate<? super T> predicate)
Description copied from interface:SeqTakes elements from the end of the sequence until an element satisfies the given predicate. The returned sequence starts after the last element that satisfies the predicate.- Specified by:
takeRightUntilin interfaceLinearSeq<T>- Specified by:
takeRightUntilin interfaceSeq<T>- Parameters:
predicate- a condition to test elements, starting from the end- Returns:
- a new sequence containing all elements after the last element that satisfies the predicate
-
takeRightWhile
default Stream<T> takeRightWhile(@NonNull java.util.function.Predicate<? super T> predicate)
Description copied from interface:SeqTakes elements from the end of the sequence while the given predicate holds.This is an equivalent to
takeRightUntil(predicate.negate()). Useful when using method references that cannot be negated directly.- Specified by:
takeRightWhilein interfaceLinearSeq<T>- Specified by:
takeRightWhilein interfaceSeq<T>- Parameters:
predicate- a condition to test elements, starting from the end- Returns:
- a new sequence containing all elements after the last element that does not satisfy the predicate
-
transform
default <U> U transform(@NonNull 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(@NonNull java.util.function.Function<? super T,Tuple2<? extends T1,? extends T2>> unzipper)
Description copied from interface:TraversableUnzips the elements of thisTraversableby mapping each element to a pair and splitting them into two separateTraversablecollections.- Specified by:
unzipin interfaceLinearSeq<T>- Specified by:
unzipin interfaceSeq<T>- Specified by:
unzipin interfaceTraversable<T>- Type Parameters:
T1- type of the first element in the resulting pairsT2- type of the second element in the resulting pairs- Parameters:
unzipper- a function that maps elements of thisTraversableto pairs- Returns:
- a
Tuple2containing twoTraversablecollections with the split elements
-
unzip3
default <T1,T2,T3> Tuple3<Stream<T1>,Stream<T2>,Stream<T3>> unzip3(@NonNull java.util.function.Function<? super T,Tuple3<? extends T1,? extends T2,? extends T3>> unzipper)
Description copied from interface:TraversableUnzips the elements of thisTraversableby mapping each element to a triple and splitting them into three separateTraversablecollections.- Specified by:
unzip3in interfaceSeq<T>- Specified by:
unzip3in interfaceTraversable<T>- Type Parameters:
T1- type of the first element in the resulting triplesT2- type of the second element in the resulting triplesT3- type of the third element in the resulting triples- Parameters:
unzipper- a function that maps elements of thisTraversableto triples- Returns:
- a
Tuple3containing threeTraversablecollections with the split elements
-
update
default Stream<T> update(int index, T element)
Description copied from interface:SeqReturns a newSeqwith the element at the specified index replaced by the given value.
-
update
default Stream<T> update(int index, @NonNull java.util.function.Function<? super T,? extends T> updater)
Description copied from interface:SeqReturns a newSeqwith the element at the specified index updated using the given function.
-
zip
default <U> Stream<Tuple2<T,U>> zip(@NonNull java.lang.Iterable<? extends U> that)
Description copied from interface:TraversableReturns aTraversableformed by pairing elements of thisTraversablewith elements of anotherIterable. Pairing stops when either collection runs out of elements; any remaining elements in the longer collection are ignored.The length of the resulting
Traversableis the minimum of the lengths of thisTraversableandthat.- Specified by:
zipin interfaceLinearSeq<T>- Specified by:
zipin interfaceSeq<T>- Specified by:
zipin interfaceTraversable<T>- Type Parameters:
U- the type of elements in the second half of each pair- Parameters:
that- anIterableproviding the second element of each pair- Returns:
- a new
Traversablecontaining pairs of corresponding elements
-
zipWith
default <U,R> Stream<R> zipWith(@NonNull java.lang.Iterable<? extends U> that, java.util.function.BiFunction<? super T,? super U,? extends R> mapper)
Description copied from interface:TraversableReturns aTraversableby combining elements of thisTraversablewith elements of anotherIterableusing a mapping function. Pairing stops when either collection runs out of elements.The length of the resulting
Traversableis the minimum of the lengths of thisTraversableandthat.- Specified by:
zipWithin interfaceLinearSeq<T>- Specified by:
zipWithin interfaceSeq<T>- Specified by:
zipWithin interfaceTraversable<T>- Type Parameters:
U- the type of elements in the second parameter of the mapperR- the type of elements in the resultingTraversable- Parameters:
that- anIterableproviding the second parameter of the mappermapper- a function that combines elements from this andthatinto a new element- Returns:
- a new
Traversablecontaining mapped elements
-
zipAll
default <U> Stream<Tuple2<T,U>> zipAll(@NonNull java.lang.Iterable<? extends U> iterable, T thisElem, U thatElem)
Description copied from interface:TraversableReturns aTraversableformed by pairing elements of thisTraversablewith elements of anotherIterable, filling in placeholder elements when one collection is shorter than the other.The length of the resulting
Traversableis the maximum of the lengths of thisTraversableandthat.If this
Traversableis shorter thanthat,thisElemis used as a filler. Conversely, ifthatis shorter,thatElemis used.- Specified by:
zipAllin interfaceLinearSeq<T>- Specified by:
zipAllin interfaceSeq<T>- Specified by:
zipAllin interfaceTraversable<T>- Type Parameters:
U- the type of elements in the second half of each pair- Parameters:
iterable- anIterableproviding the second element of each pairthisElem- the element used to fill missing values if thisTraversableis shorter thanthatthatElem- the element used to fill missing values ifthatis shorter than thisTraversable- Returns:
- a new
Traversablecontaining pairs of elements, including fillers as needed
-
zipWithIndex
default Stream<Tuple2<T,java.lang.Integer>> zipWithIndex()
Description copied from interface:TraversableZips thisTraversablewith its indices, starting at 0.- Specified by:
zipWithIndexin interfaceLinearSeq<T>- Specified by:
zipWithIndexin interfaceSeq<T>- Specified by:
zipWithIndexin interfaceTraversable<T>- Returns:
- a new
Traversablecontaining each element paired with its index
-
zipWithIndex
default <U> Stream<U> zipWithIndex(@NonNull java.util.function.BiFunction<? super T,? super java.lang.Integer,? extends U> mapper)
Description copied from interface:TraversableZips thisTraversablewith its indices and maps the resulting pairs using the provided mapper.- Specified by:
zipWithIndexin interfaceLinearSeq<T>- Specified by:
zipWithIndexin interfaceSeq<T>- Specified by:
zipWithIndexin interfaceTraversable<T>- Type Parameters:
U- the type of elements in the resultingTraversable- Parameters:
mapper- a function mapping an element and its index to a new element- Returns:
- a new
Traversablecontaining the mapped elements
-
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(@NonNull 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(@NonNull 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
-
-