Class Queue<T>
- java.lang.Object
-
- io.vavr.collection.AbstractQueue<T,Queue<T>>
-
- io.vavr.collection.Queue<T>
-
- Type Parameters:
T- Component type of the Queue
- All Implemented Interfaces:
Foldable<T>,LinearSeq<T>,Seq<T>,Traversable<T>,Function1<java.lang.Integer,T>,PartialFunction<java.lang.Integer,T>,Value<T>,java.io.Serializable,java.lang.Iterable<T>,java.util.function.Function<java.lang.Integer,T>
public final class Queue<T> extends AbstractQueue<T,Queue<T>> implements LinearSeq<T>
An immutableQueuestores elements allowing a first-in-first-out (FIFO) retrieval.Queue API:
AbstractQueue.dequeue()AbstractQueue.dequeueOption()enqueue(Object)AbstractQueue.enqueue(Object[])enqueueAll(Iterable)AbstractQueue.peek()AbstractQueue.peekOption()
When the front list is empty, front and rear are swapped and rear is reversed. This implies the following queue invariant:
front.isEmpty() => rear.isEmpty().See Okasaki, Chris: Purely Functional Data Structures (p. 42 ff.). Cambridge, 2003.
- See Also:
- Serialized Form
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Queue<T>append(T element)Returns a new sequence with the given element appended at the end.Queue<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.java.util.List<T>asJava()Returns an immutableListview of thisSeq.Queue<T>asJava(@NonNull java.util.function.Consumer<? super java.util.List<T>> action)Creates an immutableListview of thisSeqand passes it to the givenaction.java.util.List<T>asJavaMutable()Returns a mutableListview of thisSeq.Queue<T>asJavaMutable(@NonNull java.util.function.Consumer<? super java.util.List<T>> action)Creates a mutableListview of thisSeqand passes it to the givenaction.<R> Queue<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>,Queue<T>>collector()Returns aCollectorwhich may be used in conjunction withStream.collect(java.util.stream.Collector)to obtain aQueue.Queue<Queue<T>>combinations()Returns a sequence containing all combinations of elements from this sequence, for all sizes from0tolength().Queue<Queue<T>>combinations(int k)Returns all subsets of this sequence containing exactlykdistinct elements, i.e., the k-combinations of this sequence.Iterator<Queue<T>>crossProduct(int power)Returns the n-ary Cartesian power (cross product) of this sequence.Queue<T>distinct()Returns a newTraversablecontaining the elements of this instance with all duplicates removed.Queue<T>distinctBy(@NonNull java.util.Comparator<? super T> comparator)Returns a newTraversablecontaining the elements of this instance without duplicates, as determined by the givencomparator.<U> Queue<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.Queue<T>distinctByKeepLast(@NonNull java.util.Comparator<? super T> comparator)Returns a sequence with duplicate elements removed, as determined by the provided comparator.<U> Queue<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.Queue<T>drop(int n)Returns a newTraversablewithout the firstnelements, or an empty instance if this contains fewer thannelements.Queue<T>dropRight(int n)Returns a newTraversablewithout the lastnelements, or an empty instance if this contains fewer thannelements.Queue<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.Queue<T>dropRightWhile(@NonNull java.util.function.Predicate<? super T> predicate)Drops elements from the end of the sequence while the given predicate holds.Queue<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> Queue<T>empty()Returns the empty Queue.Queue<T>enqueue(T element)Enqueues a new element.Queue<T>enqueueAll(@NonNull java.lang.Iterable<? extends T> elements)Enqueues the given elements.booleanequals(java.lang.Object o)Determines whether this collection is equal to the given object.static <T> Queue<T>fill(int n, @NonNull java.util.function.Supplier<? extends T> s)Returns a Queue containingnvalues supplied by a given Suppliers.static <T> Queue<T>fill(int n, T element)Returns a Queue containingntimes the givenelementQueue<T>filter(@NonNull java.util.function.Predicate<? super T> predicate)Returns a new traversable containing only the elements that satisfy the given predicate.<U> Queue<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.Tget(int index)Returns the element at the specified index.<C> Map<C,Queue<T>>groupBy(@NonNull java.util.function.Function<? super T,? extends C> classifier)Groups elements of thisTraversablebased on a classifier function.Iterator<Queue<T>>grouped(int size)Splits thisTraversableinto consecutive blocks of the given size.booleanhasDefiniteSize()Indicates whether thisTraversablehas a known finite size.inthashCode()Returns the hash code of this collection.Thead()Returns the first element of this non-emptyTraversable.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.Queue<T>init()Dual of AbstractQueue.tail(), returning all elements except the last.Queue<T>insert(int index, T element)Returns a new sequence with the given element inserted at the specified index.Queue<T>insertAll(int index, @NonNull java.lang.Iterable<? extends T> elements)Returns a new sequence with the given elements inserted at the specified index.Queue<T>intersperse(T element)Returns a new sequence where the given element is inserted between all elements of this sequence.booleanisAsync()AQueueis computed synchronously.booleanisEmpty()Checks if this Traversable contains no elements.booleanisLazy()AQueueis computed eagerly.booleanisTraversableAgain()Checks if this Traversable can be traversed multiple times without side effects.Tlast()Returns the last element of this Traversable.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.Queue<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.intlength()Returns the number of elements in this Traversable.<U> Queue<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.<U> Queue<U>mapTo(U value)Maps the underlying value to another fixed value.Queue<java.lang.Void>mapToVoid()Maps the underlying value to Voidstatic <T> Queue<T>narrow(Queue<? extends T> queue)Narrows aQueue<? extends T>toQueue<T>via a type-safe cast.static <T> Queue<T>of(T element)Returns a singletonQueue, i.e.static <T> Queue<T>of(T @NonNull ... elements)Creates a Queue of the given elements.static Queue<java.lang.Boolean>ofAll(boolean @NonNull ... elements)Creates a Queue from boolean values.static Queue<java.lang.Byte>ofAll(byte @NonNull ... elements)Creates a Queue from byte values.static Queue<java.lang.Character>ofAll(char @NonNull ... elements)Creates a Queue from char values.static Queue<java.lang.Double>ofAll(double @NonNull ... elements)Creates a Queue from double values.static Queue<java.lang.Float>ofAll(float @NonNull ... elements)Creates a Queue from float values.static Queue<java.lang.Integer>ofAll(int @NonNull ... elements)Creates a Queue from int values.static Queue<java.lang.Long>ofAll(long @NonNull ... elements)Creates a Queue from long values.static Queue<java.lang.Short>ofAll(short @NonNull ... elements)Creates a Queue from short values.static <T> Queue<T>ofAll(@NonNull java.lang.Iterable<? extends T> elements)Creates a Queue of the given elements.static <T> Queue<T>ofAll(@NonNull java.util.stream.Stream<? extends T> javaStream)Creates a Queue that contains the elements of the givenStream.Queue<T>orElse(@NonNull java.lang.Iterable<? extends T> other)Returns thisTraversableif it is non-empty; otherwise, returns the given alternative.Queue<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.Queue<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.Tuple2<Queue<T>,Queue<T>>partition(@NonNull java.util.function.Predicate<? super T> predicate)Splits thisTraversableinto two partitions according to a predicate.Queue<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.Queue<Queue<T>>permutations()Returns all unique permutations of this sequence.Queue<T>prepend(T element)Returns a new sequence with the given element prepended to this sequence.Queue<T>prependAll(@NonNull java.lang.Iterable<? extends T> elements)Returns a new sequence with all given elements prepended to this sequence.static Queue<java.lang.Character>range(char from, char toExclusive)Creates a Queue of characters starting fromfrom(inclusive) up totoExclusive(exclusive).static Queue<java.lang.Integer>range(int from, int toExclusive)Creates a Queue of int numbers starting fromfrom, extending totoExclusive - 1.static Queue<java.lang.Long>range(long from, long toExclusive)Creates a Queue of long numbers starting fromfrom, extending totoExclusive - 1.static Queue<java.lang.Character>rangeBy(char from, char toExclusive, int step)Creates a Queue of characters starting fromfrom(inclusive) up totoExclusive(exclusive), advancing by the specifiedstep.static Queue<java.lang.Double>rangeBy(double from, double toExclusive, double step)Creates a Queue of double values starting fromfrom(inclusive) up totoExclusive(exclusive), advancing by the specifiedstep.static Queue<java.lang.Integer>rangeBy(int from, int toExclusive, int step)Creates a Queue of int numbers starting fromfrom, extending totoExclusive - 1, withstep.static Queue<java.lang.Long>rangeBy(long from, long toExclusive, long step)Creates a Queue of long numbers starting fromfrom, extending totoExclusive - 1, withstep.static Queue<java.lang.Character>rangeClosed(char from, char toInclusive)Creates a Queue of characters starting fromfrom(inclusive) up totoInclusive(inclusive).static Queue<java.lang.Integer>rangeClosed(int from, int toInclusive)Creates a Queue of int numbers starting fromfrom, extending totoInclusive.static Queue<java.lang.Long>rangeClosed(long from, long toInclusive)Creates a Queue of long numbers starting fromfrom, extending totoInclusive.static Queue<java.lang.Character>rangeClosedBy(char from, char toInclusive, int step)Creates a Queue of characters starting fromfrom(inclusive) up totoInclusive(inclusive), advancing by the specifiedstep.static Queue<java.lang.Double>rangeClosedBy(double from, double toInclusive, double step)Creates a Queue of double values starting fromfrom(inclusive) up totoInclusive(inclusive), advancing by the specifiedstep.static Queue<java.lang.Integer>rangeClosedBy(int from, int toInclusive, int step)Creates a Queue of int numbers starting fromfrom, extending totoInclusive, withstep.static Queue<java.lang.Long>rangeClosedBy(long from, long toInclusive, long step)Creates a Queue of long numbers starting fromfrom, extending totoInclusive, withstep.private java.lang.ObjectreadResolve()Queue<T>remove(T element)Returns a new sequence with the first occurrence of the given element removed.Queue<T>removeAll(T element)Returns a new sequence with all occurrences of the given element removed.Queue<T>removeAt(int index)Returns a new sequence with the element at the specified position removed.Queue<T>removeFirst(@NonNull java.util.function.Predicate<T> predicate)Returns a new sequence with the first element that satisfies the given predicate removed.Queue<T>removeLast(@NonNull java.util.function.Predicate<T> predicate)Returns a new sequence with the last element that satisfies the given predicate removed.Queue<T>replace(T currentElement, T newElement)Replaces the first occurrence ofcurrentElementwithnewElement, if it exists.Queue<T>replaceAll(T currentElement, T newElement)Replaces all occurrences ofcurrentElementwithnewElement.Queue<T>reverse()Returns a new sequence with the order of elements reversed.Queue<T>rotateLeft(int n)Returns a new sequence with the elements circularly rotated to the left by the specified distance.Queue<T>rotateRight(int n)Returns a new sequence with the elements circularly rotated to the right by the specified distance.Queue<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.<U> Queue<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.<U> Queue<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.Queue<T>shuffle()Returns a new sequence with the elements randomly shuffled.Queue<T>slice(int beginIndex, int endIndex)Returns a subsequence (slice) of this sequence, starting atbeginIndex(inclusive) and ending atendIndex(exclusive).Iterator<Queue<T>>slideBy(@NonNull java.util.function.Function<? super T,?> classifier)Partitions thisTraversableinto consecutive non-overlapping windows according to a classification function.Iterator<Queue<T>>sliding(int size)Slides a window of a givensizeover thisTraversablewith a step size of 1.Iterator<Queue<T>>sliding(int size, int step)Slides a window of a specificsizewith a givenstepover thisTraversable.<U> Queue<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.<U extends java.lang.Comparable<? super U>>
Queue<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.Queue<T>sorted()Returns a new sequence with elements sorted according to their natural order.Queue<T>sorted(@NonNull java.util.Comparator<? super T> comparator)Returns a new sequence with elements sorted according to the givenComparator.Tuple2<Queue<T>,Queue<T>>span(@NonNull java.util.function.Predicate<? super T> predicate)Splits thisTraversableinto a prefix and remainder according to the givenpredicate.Tuple2<Queue<T>,Queue<T>>splitAt(int n)Splits this sequence at the specified index.Tuple2<Queue<T>,Queue<T>>splitAt(@NonNull java.util.function.Predicate<? super T> predicate)Splits this sequence at the first element satisfying the given predicate.Tuple2<Queue<T>,Queue<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.booleanstartsWith(@NonNull java.lang.Iterable<? extends T> that, int offset)Tests whether this sequence contains the given sequence starting at the specified index.java.lang.StringstringPrefix()Returns the name of this Value type, which is used by toString().Queue<T>subSequence(int beginIndex)Returns aSeqthat is a subsequence of this sequence, starting from the specifiedbeginIndexand extending to the end of this sequence.Queue<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> Queue<T>tabulate(int n, @NonNull java.util.function.Function<? super java.lang.Integer,? extends T> f)Returns a Queue containingnvalues of a given Functionfover a range of integer values from 0 ton - 1.Queue<T>tail()Drops the first element of a non-empty Traversable.Queue<T>take(int n)Returns the firstnelements of thisTraversable, or all elements ifnexceeds the length.Queue<T>takeRight(int n)Returns the lastnelements of thisTraversable, or all elements ifnexceeds the length.Queue<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.Queue<T>takeRightWhile(@NonNull java.util.function.Predicate<? super T> predicate)Takes elements from the end of the sequence while the given predicate holds.Queue<T>takeUntil(@NonNull java.util.function.Predicate<? super T> predicate)Takes elements from thisTraversableuntil the given predicate holds for an element.<U> Utransform(java.util.function.Function<? super Queue<T>,? extends U> f)Transforms thisQueue.static <T> Queue<Queue<T>>transpose(@NonNull Queue<Queue<T>> matrix)Transposes the rows and columns of aQueuematrix.static <T> Queue<T>unfold(T seed, @NonNull java.util.function.Function<? super T,Option<Tuple2<? extends T,? extends T>>> f)Creates a Queue from a seed value and a function.static <T,U>
Queue<U>unfoldLeft(T seed, @NonNull java.util.function.Function<? super T,Option<Tuple2<? extends T,? extends U>>> f)Creates a Queue from a seed value and a function.static <T,U>
Queue<U>unfoldRight(T seed, @NonNull java.util.function.Function<? super T,Option<Tuple2<? extends U,? extends T>>> f)Creates a Queue from a seed value and a function.<T1,T2>
Tuple2<Queue<T1>,Queue<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.<T1,T2,T3>
Tuple3<Queue<T1>,Queue<T2>,Queue<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.Queue<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.Queue<T>update(int index, T element)Returns a newSeqwith the element at the specified index replaced by the given value.<U> Queue<Tuple2<T,U>>zip(@NonNull java.lang.Iterable<? extends U> that)Returns aTraversableformed by pairing elements of thisTraversablewith elements of anotherIterable.<U> Queue<Tuple2<T,U>>zipAll(@NonNull java.lang.Iterable<? extends U> that, 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.<U,R>
Queue<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.Queue<Tuple2<T,java.lang.Integer>>zipWithIndex()Zips thisTraversablewith its indices, starting at 0.<U> Queue<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 class io.vavr.collection.AbstractQueue
dequeue, dequeueOption, dropUntil, enqueue, initOption, peek, peek, peekOption, reject, removeAll, removeAll, retainAll, tailOption, takeWhile, toString
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
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, dropUntil, indexOfSlice, indexWhere, initOption, isDefinedAt, lastIndexOfSlice, lastIndexWhere, peek, reject, removeAll, removeAll, retainAll, reverseIterator, search, search, segmentLength, tailOption, takeWhile
-
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, withDefault, withDefaultValue
-
Methods inherited from interface io.vavr.collection.Traversable
arrangeBy, average, containsAll, count, existsUnique, find, findLast, foldLeft, forEachWithIndex, get, headOption, isDistinct, 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
-
-
-
-
Constructor Detail
-
Queue
private Queue(List<T> front, List<T> rear)
Creates a Queue consisting of a front List and a rear List.For a
Queue(front, rear)the following invariant holds:Queue is empty <=> front is empty. In other words: If the Queue is not empty, the front List contains at least one element.- Parameters:
front- A List of front elements, in correct order.rear- A List of rear elements, in reverse order.
-
-
Method Detail
-
collector
public static <T> java.util.stream.Collector<T,java.util.ArrayList<T>,Queue<T>> collector()
Returns aCollectorwhich may be used in conjunction withStream.collect(java.util.stream.Collector)to obtain aQueue.- Type Parameters:
T- Component type of the Queue.- Returns:
- A io.vavr.collection.Queue Collector.
-
empty
public static <T> Queue<T> empty()
Returns the empty Queue.- Type Parameters:
T- Component type- Returns:
- The empty Queue.
-
narrow
public static <T> Queue<T> narrow(Queue<? extends T> queue)
Narrows aQueue<? extends T>toQueue<T>via a type-safe cast. Safe here because the queue is immutable and no elements can be added that would violate the type (covariance)- Type Parameters:
T- the target element type- Parameters:
queue- the queue to narrow- Returns:
- the same queue viewed as
Queue<T>
-
of
public static <T> Queue<T> of(T element)
Returns a singletonQueue, i.e. aQueueof one element.- Type Parameters:
T- The component type- Parameters:
element- An element.- Returns:
- A new Queue instance containing the given element
-
of
@SafeVarargs public static <T> Queue<T> of(T @NonNull ... elements)
Creates a Queue of the given elements.- Type Parameters:
T- Component type of the Queue.- Parameters:
elements- Zero or more elements.- Returns:
- A queue containing the given elements in the same order.
- Throws:
java.lang.NullPointerException- ifelementsis null
-
ofAll
public static <T> Queue<T> ofAll(@NonNull java.lang.Iterable<? extends T> elements)
Creates a Queue of the given elements.- Type Parameters:
T- Component type of the Queue.- Parameters:
elements- An Iterable of elements.- Returns:
- A queue containing the given elements in the same order.
- Throws:
java.lang.NullPointerException- ifelementsis null
-
ofAll
public static <T> Queue<T> ofAll(@NonNull java.util.stream.Stream<? extends T> javaStream)
Creates a Queue that contains the elements of the givenStream.- Type Parameters:
T- Component type of the Stream.- Parameters:
javaStream- AStream- Returns:
- A Queue containing the given elements in the same order.
-
ofAll
public static Queue<java.lang.Boolean> ofAll(boolean @NonNull ... elements)
Creates a Queue from boolean values.- Parameters:
elements- boolean values- Returns:
- A new Queue of Boolean values
- Throws:
java.lang.NullPointerException- if elements is null
-
ofAll
public static Queue<java.lang.Byte> ofAll(byte @NonNull ... elements)
Creates a Queue from byte values.- Parameters:
elements- byte values- Returns:
- A new Queue of Byte values
- Throws:
java.lang.NullPointerException- if elements is null
-
ofAll
public static Queue<java.lang.Character> ofAll(char @NonNull ... elements)
Creates a Queue from char values.- Parameters:
elements- char values- Returns:
- A new Queue of Character values
- Throws:
java.lang.NullPointerException- if elements is null
-
ofAll
public static Queue<java.lang.Double> ofAll(double @NonNull ... elements)
Creates a Queue from double values.- Parameters:
elements- double values- Returns:
- A new Queue of Double values
- Throws:
java.lang.NullPointerException- if elements is null
-
ofAll
public static Queue<java.lang.Float> ofAll(float @NonNull ... elements)
Creates a Queue from float values.- Parameters:
elements- float values- Returns:
- A new Queue of Float values
- Throws:
java.lang.NullPointerException- if elements is null
-
ofAll
public static Queue<java.lang.Integer> ofAll(int @NonNull ... elements)
Creates a Queue from int values.- Parameters:
elements- int values- Returns:
- A new Queue of Integer values
- Throws:
java.lang.NullPointerException- if elements is null
-
ofAll
public static Queue<java.lang.Long> ofAll(long @NonNull ... elements)
Creates a Queue from long values.- Parameters:
elements- long values- Returns:
- A new Queue of Long values
- Throws:
java.lang.NullPointerException- if elements is null
-
ofAll
public static Queue<java.lang.Short> ofAll(short @NonNull ... elements)
Creates a Queue from short values.- Parameters:
elements- short values- Returns:
- A new Queue of Short values
- Throws:
java.lang.NullPointerException- if elements is null
-
tabulate
public static <T> Queue<T> tabulate(int n, @NonNull java.util.function.Function<? super java.lang.Integer,? extends T> f)
Returns a Queue containingnvalues of a given Functionfover a range of integer values from 0 ton - 1.- Type Parameters:
T- Component type of the Queue- Parameters:
n- The number of elements in the Queuef- The Function computing element values- Returns:
- A Queue consisting of elements
f(0),f(1), ..., f(n - 1) - Throws:
java.lang.NullPointerException- iffis null
-
fill
public static <T> Queue<T> fill(int n, @NonNull java.util.function.Supplier<? extends T> s)
Returns a Queue containingnvalues supplied by a given Suppliers.- Type Parameters:
T- Component type of the Queue- Parameters:
n- The number of elements in the Queues- The Supplier computing element values- Returns:
- An Queue of size
n, where each element contains the result supplied bys. - Throws:
java.lang.NullPointerException- ifsis null
-
fill
public static <T> Queue<T> fill(int n, T element)
Returns a Queue containingntimes the givenelement- Type Parameters:
T- Component type of the Queue- Parameters:
n- The number of elements in the Queueelement- The element- Returns:
- An Queue of size
n, where each element is the givenelement.
-
range
public static Queue<java.lang.Character> range(char from, char toExclusive)
Creates a Queue of characters starting fromfrom(inclusive) up totoExclusive(exclusive).Examples:
Queue.range('a', 'c') // = Queue('a', 'b') Queue.range('c', 'a') // = Queue()- Parameters:
from- the first character (inclusive)toExclusive- the end character (exclusive)- Returns:
- a Queue over the specified character range, or empty if
from >= toExclusive
-
rangeBy
public static Queue<java.lang.Character> rangeBy(char from, char toExclusive, int step)
Creates a Queue of characters starting fromfrom(inclusive) up totoExclusive(exclusive), advancing by the specifiedstep.Examples:
Queue.rangeBy('a', 'c', 1) // = Queue('a', 'b') Queue.rangeBy('a', 'd', 2) // = Queue('a', 'c') Queue.rangeBy('d', 'a', -2) // = Queue('d', 'b') Queue.rangeBy('d', 'a', 2) // = Queue()- Parameters:
from- the first character (inclusive)toExclusive- the end character (exclusive)step- the increment; must not be zero- Returns:
- a Queue over the specified character range, or empty if the step
direction does not match the direction from
fromtotoExclusive - Throws:
java.lang.IllegalArgumentException- ifstepis zero
-
rangeBy
@GwtIncompatible public static Queue<java.lang.Double> rangeBy(double from, double toExclusive, double step)
Creates a Queue of double values starting fromfrom(inclusive) up totoExclusive(exclusive), advancing by the specifiedstep.Examples:
Queue.rangeBy(0.0, 1.0, 0.25) // = Queue(0.0, 0.25, 0.5, 0.75) Queue.rangeBy(1.0, 0.0, -0.25) // = Queue(1.0, 0.75, 0.5, 0.25) Queue.rangeBy(0.0, 1.0, -0.25) // = Queue()
- Parameters:
from- the first double value (inclusive)toExclusive- the end value (exclusive)step- the increment; must not be zero- Returns:
- a Queue over the specified double range, or empty if the step
direction does not match the direction from
fromtotoExclusive - Throws:
java.lang.IllegalArgumentException- ifstepis zero
-
range
public static Queue<java.lang.Integer> range(int from, int toExclusive)
Creates a Queue of int numbers starting fromfrom, extending totoExclusive - 1.Examples:
Queue.range(0, 0) // = Queue() Queue.range(2, 0) // = Queue() Queue.range(-2, 2) // = Queue(-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
public static Queue<java.lang.Integer> rangeBy(int from, int toExclusive, int step)
Creates a Queue of int numbers starting fromfrom, extending totoExclusive - 1, withstep.Examples:
Queue.rangeBy(1, 3, 1) // = Queue(1, 2) Queue.rangeBy(1, 4, 2) // = Queue(1, 3) Queue.rangeBy(4, 1, -2) // = Queue(4, 2) Queue.rangeBy(4, 1, 2) // = Queue()- 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
public static Queue<java.lang.Long> range(long from, long toExclusive)
Creates a Queue of long numbers starting fromfrom, extending totoExclusive - 1.Examples:
Queue.range(0L, 0L) // = Queue() Queue.range(2L, 0L) // = Queue() Queue.range(-2L, 2L) // = Queue(-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
public static Queue<java.lang.Long> rangeBy(long from, long toExclusive, long step)
Creates a Queue of long numbers starting fromfrom, extending totoExclusive - 1, withstep.Examples:
Queue.rangeBy(1L, 3L, 1L) // = Queue(1L, 2L) Queue.rangeBy(1L, 4L, 2L) // = Queue(1L, 3L) Queue.rangeBy(4L, 1L, -2L) // = Queue(4L, 2L) Queue.rangeBy(4L, 1L, 2L) // = Queue()- 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
public static Queue<java.lang.Character> rangeClosed(char from, char toInclusive)
Creates a Queue of characters starting fromfrom(inclusive) up totoInclusive(inclusive).Examples:
Queue.rangeClosed('a', 'c') // = Queue('a', 'b', 'c') Queue.rangeClosed('c', 'a') // = Queue()- Parameters:
from- the first character (inclusive)toInclusive- the last character (inclusive)- Returns:
- a Queue over the specified character range, or empty if
from > toInclusive
-
rangeClosedBy
public static Queue<java.lang.Character> rangeClosedBy(char from, char toInclusive, int step)
Creates a Queue of characters starting fromfrom(inclusive) up totoInclusive(inclusive), advancing by the specifiedstep.Examples:
Queue.rangeClosedBy('a', 'c', 1) // = Queue('a', 'b', 'c') Queue.rangeClosedBy('a', 'd', 2) // = Queue('a', 'c') Queue.rangeClosedBy('d', 'a', -2) // = Queue('d', 'b') Queue.rangeClosedBy('d', 'a', 2) // = Queue()- Parameters:
from- the first character (inclusive)toInclusive- the last character (inclusive)step- the increment; must not be zero- Returns:
- a Queue over the specified character range, or empty if the step
direction does not match the direction from
fromtotoInclusive - Throws:
java.lang.IllegalArgumentException- ifstepis zero
-
rangeClosedBy
@GwtIncompatible public static Queue<java.lang.Double> rangeClosedBy(double from, double toInclusive, double step)
Creates a Queue of double values starting fromfrom(inclusive) up totoInclusive(inclusive), advancing by the specifiedstep.Examples:
Queue.rangeClosedBy(0.0, 1.0, 0.25) // = Queue(0.0, 0.25, 0.5, 0.75, 1.0) Queue.rangeClosedBy(1.0, 0.0, -0.25) // = Queue(1.0, 0.75, 0.5, 0.25, 0.0) Queue.rangeClosedBy(0.0, 1.0, -0.25) // = Queue()
- Parameters:
from- the first double value (inclusive)toInclusive- the last value (inclusive)step- the increment; must not be zero- Returns:
- a Queue over the specified double range, or empty if the step
direction does not match the direction from
fromtotoInclusive - Throws:
java.lang.IllegalArgumentException- ifstepis zero
-
rangeClosed
public static Queue<java.lang.Integer> rangeClosed(int from, int toInclusive)
Creates a Queue of int numbers starting fromfrom, extending totoInclusive.Examples:
Queue.rangeClosed(0, 0) // = Queue(0) Queue.rangeClosed(2, 0) // = Queue() Queue.rangeClosed(-2, 2) // = Queue(-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
public static Queue<java.lang.Integer> rangeClosedBy(int from, int toInclusive, int step)
Creates a Queue of int numbers starting fromfrom, extending totoInclusive, withstep.Examples:
Queue.rangeClosedBy(1, 3, 1) // = Queue(1, 2, 3) Queue.rangeClosedBy(1, 4, 2) // = Queue(1, 3) Queue.rangeClosedBy(4, 1, -2) // = Queue(4, 2) Queue.rangeClosedBy(4, 1, 2) // = Queue()- 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
public static Queue<java.lang.Long> rangeClosed(long from, long toInclusive)
Creates a Queue of long numbers starting fromfrom, extending totoInclusive.Examples:
Queue.rangeClosed(0L, 0L) // = Queue(0L) Queue.rangeClosed(2L, 0L) // = Queue() Queue.rangeClosed(-2L, 2L) // = Queue(-2L, -1L, 0L, 1L, 2L)- Parameters:
from- the first numbertoInclusive- the last number- Returns:
- a range of long values as specified or
Niliffrom > toInclusive
-
transpose
public static <T> Queue<Queue<T>> transpose(@NonNull Queue<Queue<T>> matrix)
Transposes the rows and columns of aQueuematrix.- Type Parameters:
T- matrix element type- Parameters:
matrix- to be transposed.- Returns:
- a transposed
Queuematrix. - Throws:
java.lang.IllegalArgumentException- if the row lengths ofmatrixdiffer.ex:
Queue.transpose(Queue(Queue(1,2,3), Queue(4,5,6))) → Queue(Queue(1,4), Queue(2,5), Queue(3,6))
-
rangeClosedBy
public static Queue<java.lang.Long> rangeClosedBy(long from, long toInclusive, long step)
Creates a Queue of long numbers starting fromfrom, extending totoInclusive, withstep.Examples:
Queue.rangeClosedBy(1L, 3L, 1L) // = Queue(1L, 2L, 3L) Queue.rangeClosedBy(1L, 4L, 2L) // = Queue(1L, 3L) Queue.rangeClosedBy(4L, 1L, -2L) // = Queue(4L, 2L) Queue.rangeClosedBy(4L, 1L, 2L) // = Queue()- 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
-
unfoldRight
public static <T,U> Queue<U> unfoldRight(T seed, @NonNull java.util.function.Function<? super T,Option<Tuple2<? extends U,? extends T>>> f)
Creates a Queue from a seed value and a function. The function takes the seed at first. The function should returnNonewhen it's done generating the Queue, otherwiseSomeTupleof the element for the next call and the value to add to the resulting Queue.Example:
Queue.unfoldRight(10, x -> x == 0 ? Option.none() : Option.of(new Tuple2<>(x, x-1))); // Queue(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 Queue with the values built up by the iteration
- Throws:
java.lang.NullPointerException- iffis null
-
unfoldLeft
public static <T,U> Queue<U> unfoldLeft(T seed, @NonNull java.util.function.Function<? super T,Option<Tuple2<? extends T,? extends U>>> f)
Creates a Queue from a seed value and a function. The function takes the seed at first. The function should returnNonewhen it's done generating the Queue, otherwiseSomeTupleof the value to add to the resulting Queue and the element for the next call.Example:
Queue.unfoldLeft(10, x -> x == 0 ? Option.none() : Option.of(new Tuple2<>(x-1, x))); // Queue(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 Queue with the values built up by the iteration
- Throws:
java.lang.NullPointerException- iffis null
-
unfold
public static <T> Queue<T> unfold(T seed, @NonNull java.util.function.Function<? super T,Option<Tuple2<? extends T,? extends T>>> f)
Creates a Queue from a seed value and a function. The function takes the seed at first. The function should returnNonewhen it's done generating the Queue, otherwiseSomeTupleof the value to add to the resulting Queue and the element for the next call.Example:
Queue.unfold(10, x -> x == 0 ? Option.none() : Option.of(new Tuple2<>(x-1, x))); // Queue(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 Queue with the values built up by the iteration
- Throws:
java.lang.NullPointerException- iffis null
-
enqueue
public Queue<T> enqueue(T element)
Enqueues a new element.- Specified by:
enqueuein classAbstractQueue<T,Queue<T>>- Parameters:
element- The new element- Returns:
- a new
Queueinstance, containing the new element
-
enqueueAll
public Queue<T> enqueueAll(@NonNull java.lang.Iterable<? extends T> elements)
Enqueues the given elements. A queue has FIFO order, i.e. the first of the given elements is the first which will be retrieved.- Specified by:
enqueueAllin classAbstractQueue<T,Queue<T>>- Parameters:
elements- An Iterable of elements, may be empty- Returns:
- a new
Queueinstance, containing the new elements - Throws:
java.lang.NullPointerException- if elements is null
-
append
public Queue<T> append(T element)
Description copied from interface:SeqReturns a new sequence with the given element appended at the end.
-
appendAll
public Queue<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.
-
asJava
@GwtIncompatible public 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 public Queue<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 public 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 public Queue<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
public <R> Queue<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
public Queue<Queue<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
public Queue<Queue<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
public Iterator<Queue<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
-
distinct
public Queue<T> distinct()
Description copied from interface:TraversableReturns a newTraversablecontaining the elements of this instance with all duplicates removed. Element equality is determined usingequals.
-
distinctBy
public Queue<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
public <U> Queue<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
public Queue<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
public <U> Queue<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
public Queue<T> drop(int n)
Description copied from interface:TraversableReturns a newTraversablewithout the firstnelements, or an empty instance if this contains fewer thannelements.
-
dropWhile
public Queue<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.- Specified by:
dropWhilein interfaceLinearSeq<T>- Specified by:
dropWhilein interfaceSeq<T>- Specified by:
dropWhilein interfaceTraversable<T>- Specified by:
dropWhilein classAbstractQueue<T,Queue<T>>- Parameters:
predicate- a condition tested on each element- Returns:
- a new instance starting from the first element not matching the predicate
-
dropRight
public Queue<T> dropRight(int n)
Description copied from interface:TraversableReturns a newTraversablewithout the lastnelements, or an empty instance if this contains fewer thannelements.
-
dropRightUntil
public Queue<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
public Queue<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
public Queue<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.
-
flatMap
public <U> Queue<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
public T get(int index)
Description copied from interface:SeqReturns the element at the specified index.
-
groupBy
public <C> Map<C,Queue<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
public Iterator<Queue<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
public 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.
-
head
public T head()
Description copied from interface:TraversableReturns the first element of this non-emptyTraversable.- Specified by:
headin interfaceTraversable<T>- Returns:
- the first element
-
indexOf
public 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
public Queue<T> init()
Description copied from class:AbstractQueueDual of AbstractQueue.tail(), returning all elements except the last.
-
insert
public Queue<T> insert(int index, T element)
Description copied from interface:SeqReturns a new sequence with the given element inserted at the specified index.
-
insertAll
public Queue<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
public Queue<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
public boolean isAsync()
AQueueis computed synchronously.
-
isEmpty
public boolean isEmpty()
Description copied from interface:TraversableChecks if this Traversable contains no elements.
-
isLazy
public boolean isLazy()
AQueueis computed eagerly.
-
isTraversableAgain
public 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
public T last()
Description copied from interface:TraversableReturns the last element of this Traversable.- Specified by:
lastin interfaceTraversable<T>- Returns:
- the last element
-
lastIndexOf
public 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
public 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
public <U> Queue<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
public <U> Queue<U> mapTo(U value)
Description copied from interface:ValueMaps the underlying value to another fixed value.
-
mapToVoid
public Queue<java.lang.Void> mapToVoid()
Description copied from interface:ValueMaps the underlying value to Void
-
orElse
public Queue<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
public Queue<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.
-
padTo
public Queue<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
public Queue<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.
-
patch
public Queue<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
public Tuple2<Queue<T>,Queue<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.
-
permutations
public Queue<Queue<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
public Queue<T> prepend(T element)
Description copied from interface:SeqReturns a new sequence with the given element prepended to this sequence.
-
prependAll
public Queue<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
public Queue<T> remove(T element)
Description copied from interface:SeqReturns a new sequence with the first occurrence of the given element removed.
-
removeFirst
public Queue<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
public Queue<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
public Queue<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
public Queue<T> removeAll(T element)
Description copied from interface:SeqReturns a new sequence with all occurrences of the given element removed.
-
replace
public Queue<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
public Queue<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
-
reverse
public Queue<T> reverse()
Description copied from interface:SeqReturns a new sequence with the order of elements reversed.
-
rotateLeft
public Queue<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
public Queue<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
public Queue<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
public <U> Queue<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
public <U> Queue<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
public Queue<T> shuffle()
Description copied from interface:SeqReturns a new sequence with the elements randomly shuffled.
-
slice
public Queue<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
public Iterator<Queue<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
public Iterator<Queue<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
public Iterator<Queue<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
public Queue<T> sorted()
Description copied from interface:SeqReturns a new sequence with elements sorted according to their natural order.
-
sorted
public Queue<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
public <U extends java.lang.Comparable<? super U>> Queue<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
public <U> Queue<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
public Tuple2<Queue<T>,Queue<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
public Tuple2<Queue<T>,Queue<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
public Tuple2<Queue<T>,Queue<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
public Tuple2<Queue<T>,Queue<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
-
startsWith
public boolean startsWith(@NonNull java.lang.Iterable<? extends T> that, int offset)
Description copied from interface:SeqTests whether this sequence contains the given sequence starting at the specified index.Note: If both this sequence and the argument sequence are infinite, this method may not terminate.
- Specified by:
startsWithin interfaceSeq<T>- Parameters:
that- the sequence to test; must not benulloffset- the index at which to start checking for the prefix- Returns:
trueifthatis empty or matches a subsequence of this sequence starting atoffset,falseotherwise
-
subSequence
public Queue<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
public Queue<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
public Queue<T> tail()
Description copied from class:AbstractQueueDrops the first element of a non-empty Traversable.
-
take
public Queue<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
public Queue<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>- Specified by:
takeUntilin classAbstractQueue<T,Queue<T>>- Parameters:
predicate- a condition tested sequentially on the elements- Returns:
- a new
Traversablecontaining all elements before the first one that satisfies the predicate
-
takeRight
public Queue<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
public Queue<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
public Queue<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
public <U> U transform(java.util.function.Function<? super Queue<T>,? extends U> f)
Transforms thisQueue.- Type Parameters:
U- Type of transformation result- Parameters:
f- A transformation- Returns:
- An instance of type
U - Throws:
java.lang.NullPointerException- iffis null
-
unzip
public <T1,T2> Tuple2<Queue<T1>,Queue<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
public <T1,T2,T3> Tuple3<Queue<T1>,Queue<T2>,Queue<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
public Queue<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
public Queue<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
public <U> Queue<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
public <U,R> Queue<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
public <U> Queue<Tuple2<T,U>> zipAll(@NonNull java.lang.Iterable<? extends U> that, 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:
that- 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
public Queue<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
public <U> Queue<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
-
readResolve
private java.lang.Object readResolve()
-
stringPrefix
public 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.
-
equals
public boolean equals(java.lang.Object o)
Description copied from interface:TraversableDetermines whether this collection is equal to the given object.In Vavr, there are four basic collection types:
Seq– sequential elementsSet– distinct elementsMap– key-value pairsMultimap– keys mapped to multiple values
- They are of the same collection type (Seq, Set, Map, Multimap)
- They contain the same elements
- For
Seq, the element order is the same
For
MapandMultimap, two entries(key1, value1)and(key2, value2)are equal if both their keys and values are equal.Additional notes:
- No collection equals
null(e.g.,Queue(1) != null) - Null elements are allowed and treated as expected
(e.g.,
List(null, 1) == Stream(null, 1),HashMap((null,1)) == LinkedHashMap((null,1))) - Element order matters only for
Seq - Other collection classes are equal if their types and elements (in iteration order) are equal
- Iterators are compared by reference only
-
hashCode
public int hashCode()
Description copied from interface:TraversableReturns the hash code of this collection.Vavr distinguishes between collections with predictable iteration order (like
Seq) and collections with arbitrary iteration order (likeSet,Map, andMultimap). In all cases, the hash of an empty collection is defined as1.For collections with predictable iteration order, the hash is computed as:
int hash = 1; for (T t : this) { hash = hash * 31 + Objects.hashCode(t); }For collections with arbitrary iteration order, the hash is computed to be independent of element order:
int hash = 1; for (T t : this) { hash += Objects.hashCode(t); }Note that these algorithms may change in future Vavr versions. Hash codes are generally not cached, unlike size/length, because caching would increase memory usage due to persistent tree-based structures. Computing the hash code is linear in time, O(n). For frequently re-used collections (e.g., as
HashMapkeys), caching can be done externally using a wrapper, for example:{@code public final class Hashed{ private final K key; private final Lazy hashCode; public Hashed(K key) { this.key = key; this.hashCode = Lazy.of(() -> Objects.hashCode(key)); } public K key() { return key; }
-
-