Queue stores elements allowing a first-in-first-out (FIFO) retrieval.
Queue API:
dequeue()dequeueOption()enqueue(Object)enqueue(Object[])enqueueAll(Iterable)peek()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.
| Modifier and Type | Field and Description |
|---|---|
| private static final Queue | |
| private final List | |
| private final List | |
| private static final long |
| Access | Constructor and Description |
|---|---|
| private |
| Modifier and Type | Method and Description |
|---|---|
| public Queue | append(T
An element element)Implements io. Appends an element to this. |
| public Queue | appendAll(Iterable<? extends T>
An Iterable of elements elements)Implements io. Appends all given elements to this. |
| public List | asJava()
Implements io. Creates an immutable |
| public Queue | asJava(Consumer<? super List<T>>
A side-effecting unit of work that operates on an immutable action)java.util.List view.Implements io. Creates an immutable |
| public List | asJavaMutable()
Implements io. Creates a mutable |
| public Queue | asJavaMutable(Consumer<? super List<T>>
A side-effecting unit of work that operates on a mutable action)java.util.List view.Implements io. Creates a mutable |
| public <R> Queue | collect(PartialFunction<? super T, ? extends R>
A function that is not necessarily defined of all elements of this traversable. partialFunction)Implements io. Collects all elements that are in the domain of the given |
| public static < Component type of the Queue. T> Collector | Returns: A io.vavr.collection.Queue Collector.Returns a |
| public Queue | combinations()
Implements io. Returns the union of all combinations from k = 0 to length(). |
| public Queue | combinations(int
Size of subsets k)Implements io. Returns the k-combination of this traversable, i.e. all subset of this of k distinct elements. |
| public Iterator | crossProduct(int
the number of cartesian multiplications power)Implements io. Calculates the n-ary cartesian power (or cross product or simply product) of this. |
| public Queue | distinct()
Implements io. Returns a new version of this which contains no duplicates. |
| public Queue | distinctBy(Comparator<? super T>
A comparator comparator)Implements io. Returns a new version of this which contains no duplicates. |
| public <U> Queue | distinctBy(Function<? super T, ? extends U>
A key extractor keyExtractor)Implements io. Returns a new version of this which contains no duplicates. |
| public Queue | drop(int
The number of elements to drop. n)Implements io. Drops the first n elements of this or all elements, if this length < n. |
| public Queue | dropRight(int
The number of elements to drop. n)Implements io. Drops the last n elements of this or all elements, if this length < n. |
| public Queue | dropRightUntil(Predicate<? super T>
A condition tested subsequently for this elements, starting from the end. predicate)Implements io. Drops elements until the predicate holds for the current element, starting from the end. |
| public Queue | dropRightWhile(Predicate<? super T>
A condition tested subsequently for this elements, starting from the end. predicate)Implements io. Drops elements while the predicate holds for the current element, starting from the end. |
| public Queue | dropWhile(Predicate<? super T>
A condition tested subsequently for this elements. predicate)Implements abstract io. Implements io. Drops elements while the predicate holds for the current element. |
| public static < Component type T> Queue | |
| public Queue | Returns: a newQueue instance, containing the new elementThe new element element)Implements abstract io. Enqueues a new element. |
| public Queue | Returns: a newQueue instance, containing the new elementsAn Iterable of elements, may be empty elements)Implements abstract io. Enqueues the given elements. |
| public boolean | equals(Object
an object, may be null o)Overrides java. Implements io. In Vavr there are four basic classes of collections:
|
| public static < Component type of the Queue T> Queue | |
| public static < Component type of the Queue T> Queue | Returns: An Queue of sizen, where each element is the given element.The number of elements in the Queue n, T The element element)Returns a Queue containing |
| public Queue | filter(Predicate<? super T>
A predicate predicate)Implements io. Returns a new traversable consisting of all elements which satisfy the given predicate. |
| public <U> Queue | flatMap(Function<? super T, ? extends Iterable<? extends U>>
A mapper mapper)Implements io. FlatMaps this Traversable. |
| public T | get(int
an index index)Implements io. Returns the element at the specified index. |
| public <C> Map | groupBy(Function<? super T, ? extends C>
A function which classifies elements into classes classifier)Implements io. Groups this elements by classifying the elements. |
| public Iterator | grouped(int
a positive block size size)Implements io. Groups this |
| public boolean | hasDefiniteSize()
Implements io. Checks if this Traversable is known to have a finite size. |
| public int | hashCode()
Overrides java. Implements io. Returns the hash code of this collection. |
| public T | head()
Implements io. Returns the first element of a non-empty Traversable. |
| public int | indexOf(T
an element element, int start index from)Implements io. Returns the index of the first occurrence of the given element after or at some start index or -1 if this does not contain the given element. |
| public Queue | init()
Implements abstract io. Implements io. Dual of tail(), returning all elements except the last. |
| public Queue | insert(int
an index index, T an element element)Implements io. Inserts the given element at the specified index. |
| public Queue | insertAll(int
an index index, Iterable<? extends T> An Iterable of elements elements)Implements io. Inserts the given elements at the specified index. |
| public Queue | intersperse(T
An element. element)Implements io. Inserts an element between all elements of this Traversable. |
| public boolean | |
| public boolean | isEmpty()
Overrides default io. Checks if this Traversable is empty. |
| public boolean | |
| public boolean | isTraversableAgain()
Implements io. Checks if this Traversable can be repeatedly traversed. |
| public T | |
| public int | lastIndexOf(T
an element element, int the end index end)Implements io. Returns the index of the last occurrence of the given element before or at a given end index or -1 if this does not contain the given element. |
| public Queue | leftPadTo(int
the target length length, T the padding element element)Implements io. A copy of this sequence with an element prepended until a given target length is reached. |
| public int | length()
Implements io. Computes the number of elements of this Traversable. |
| public <U> Queue | map(Function<? super T, ? extends U>
A mapper. mapper)Implements io. Maps the elements of this |
| public static < Component type of the T> QueueQueue. | |
| public static < The component type T> Queue | Returns: A new Queue instance containing the given elementAn element. element)Returns a singleton |
| public static < Component type of the Queue. T> Queue | Returns: A queue containing the given elements in the same order.Zero or more elements. elements)Creates a Queue of the given elements. |
| public static < Component type of the Queue. T> Queue | |
| public static < Component type of the Stream. T> Queue | Returns: A Queue containing the given elements in the same order.Creates a Queue that contains the elements of the given |
| public static Queue | Returns: A new Queue of Boolean valuesboolean values elements)Creates a Queue from boolean values. |
| public static Queue | Returns: A new Queue of Byte valuesbyte values elements)Creates a Queue from byte values. |
| public static Queue | Returns: A new Queue of Character valueschar values elements)Creates a Queue from char values. |
| public static Queue | Returns: A new Queue of Double valuesdouble values elements)Creates a Queue from double values. |
| public static Queue | Returns: A new Queue of Float valuesfloat values elements)Creates a Queue from float values. |
| public static Queue | Returns: A new Queue of Integer valuesint values elements)Creates a Queue from int values. |
| public static Queue | Returns: A new Queue of Long valueslong values elements)Creates a Queue from long values. |
| public static Queue | Returns: A new Queue of Short valuesshort values elements)Creates a Queue from short values. |
| public Queue | orElse(Iterable<? extends T>
An alternative other)TraversableImplements io. Returns this |
| public Queue | orElse(Supplier<? extends Iterable<? extends T>>
An alternative supplier)Traversable supplierImplements io. Returns this |
| public Queue | padTo(int
the target length length, T the padding element element)Implements io. A copy of this sequence with an element appended until a given target length is reached. |
| public Tuple2 | partition(Predicate<? super T>
A predicate which classifies an element if it is in the first or the second traversable. predicate)Implements io. Creates a partition of this |
| public Queue | patch(int
the index of the first replaced element from, Iterable<? extends T> sequence for replacement that, int the number of elements to drop in the original list replaced)Implements io. Produces a new list where a slice of elements in this list is replaced by another sequence. |
| public Queue | permutations()
Implements io. Computes all unique permutations. |
| public Queue | prepend(T
An element element)Implements io. Prepends an element to this. |
| public Queue | prependAll(Iterable<? extends T>
An Iterable of elements elements)Implements io. Prepends all given elements to this. |
| public static Queue | |
| public static Queue | Returns: a range of int values as specified orNil if from >= toExclusivethe first number from, int the last number + 1 toExclusive)Creates a Queue of int numbers starting from |
| public static Queue | Returns: a range of long values as specified orNil if from >= toExclusivethe first number from, long the last number + 1 toExclusive)Creates a Queue of long numbers starting from |
| public static Queue | |
| public static Queue | |
| public static Queue | Returns: a range of long values as specified orNil iffrom >= toInclusive and step > 0 orfrom <= toInclusive and step < 0the first number from, int the last number + 1 toExclusive, int the step step)Creates a Queue of int numbers starting from |
| public static Queue | Returns: a range of long values as specified orNil iffrom >= toInclusive and step > 0 orfrom <= toInclusive and step < 0the first number from, long the last number + 1 toExclusive, long the step step)Creates a Queue of long numbers starting from |
| public static Queue | |
| public static Queue | Returns: a range of int values as specified orNil if from > toInclusivethe first number from, int the last number toInclusive)Creates a Queue of int numbers starting from |
| public static Queue | Returns: a range of long values as specified orNil if from > toInclusivethe first number from, long the last number toInclusive)Creates a Queue of long numbers starting from |
| public static Queue | |
| public static Queue | |
| public static Queue | Returns: a range of int values as specified orNil iffrom > toInclusive and step > 0 orfrom < toInclusive and step < 0the first number from, int the last number toInclusive, int the step step)Creates a Queue of int numbers starting from |
| public static Queue | Returns: a range of int values as specified orNil iffrom > toInclusive and step > 0 orfrom < toInclusive and step < 0the first number from, long the last number toInclusive, long the step step)Creates a Queue of long numbers starting from |
| private Object | |
| public Queue | remove(T
An element to be removed from this Seq. element)Implements io. Removes the first occurrence of the given element. |
| public Queue | removeAll(T
An element to be removed from this Seq. element)Implements io. Removes all occurrences of the given element. |
| public Queue | removeAt(int
position of element to remove index)Implements io. Removes the element at the specified position in this sequence. |
| public Queue | removeFirst(Predicate<T>
an predicate predicate)Implements io. Removes the first occurrence that satisfy predicate |
| public Queue | removeLast(Predicate<T>
an predicate predicate)Implements io. Removes the last occurrence that satisfy predicate |
| public Queue | replace(T
An element to be substituted. currentElement, T A replacement for currentElement. newElement)Implements io. Replaces the first occurrence (if exists) of the given currentElement with newElement. |
| public Queue | replaceAll(T
An element to be substituted. currentElement, T A replacement for currentElement. newElement)Implements io. Replaces all occurrences of the given currentElement with newElement. |
| public Queue | |
| public Queue | rotateLeft(int
distance of left rotation n)Implements io. Circular rotates the elements by the specified distance to the left direction. |
| public Queue | rotateRight(int
distance of right rotation n)Implements io. Circular rotates the elements by the specified distance to the right direction. |
| public Queue | scan(T
neutral element for the operator op zero, BiFunction<? super T, ? super T, ? extends T> the associative operator for the scan operation)Implements io. Computes a prefix scan of the elements of the collection. |
| public <U> Queue | scanLeft(U
the initial value zero, BiFunction<? super U, ? super T, ? extends U> the binary operator applied to the intermediate result and the element operation)Implements io. Produces a collection containing cumulative results of applying the operator going left to right. |
| public <U> Queue | scanRight(U
the initial value zero, BiFunction<? super T, ? super U, ? extends U> the binary operator applied to the intermediate result and the element operation)Implements io. Produces a collection containing cumulative results of applying the operator going right to left. |
| public Queue | shuffle()
Implements io. Randomize the order of the elements in the current sequence. |
| public Queue | slice(int
the beginning index, inclusive beginIndex, int the end index, exclusive endIndex)Implements io. Returns a Seq that is a slice of this. |
| public Iterator | slideBy(Function<? super T, ?>
A function which classifies elements into classes classifier)Implements io. Slides a non-overlapping window of a variable size over this |
| public Iterator | sliding(int
a positive window size size)Implements io. Slides a window of a specific |
| public Iterator | sliding(int
a positive window size size, int a positive step size step)Implements io. Slides a window of a specific |
| public <U extends Comparable | sortBy(Function<? super T, ? extends U>
A mapper mapper)Implements io. Sorts this elements by comparing the elements in a different domain, using the given |
| public <U> Queue | sortBy(Comparator<? super U>
A comparator comparator, Function<? super T, ? extends U> A mapper mapper)Implements io. Sorts this elements by comparing the elements in a different domain, using the given |
| public Queue | sorted()
Implements io. Sorts this elements according to their natural order. |
| public Queue | sorted(Comparator<? super T>
A comparator comparator)Implements io. Sorts this elements according to the provided |
| public Tuple2 | span(Predicate<? super T>
A predicate. predicate)Implements io. Returns a tuple where the first element is the longest prefix of elements that satisfy the given
|
| public Tuple2 | splitAt(int
An index. n)Implements io. Splits a Seq at the specified index. |
| public Tuple2 | splitAt(Predicate<? super T>
An predicate predicate)Implements io. Splits a sequence at the first element which satisfies the |
| public Tuple2 | splitAtInclusive(Predicate<? super T>
An predicate predicate)Implements io. Splits a sequence at the first element which satisfies the |
| public boolean | startsWith(Iterable<? extends T>
the sequence to test that, int the index where the sequence is searched. offset)Overrides default io. Tests whether this list contains the given sequence at a given index. |
| public String | stringPrefix()
Implements io. Returns the name of this Value type, which is used by toString(). |
| public Queue | subSequence(int
the beginning index, inclusive beginIndex)Implements io. Returns a Seq that is a subsequence of this. |
| public Queue | subSequence(int
the beginning index, inclusive beginIndex, int the end index, exclusive endIndex)Implements io. Returns a Seq that is a subsequence of this. |
| public static < Component type of the Queue T> Queue | |
| public Queue | tail()
Implements abstract io. Implements io. Drops the first element of a non-empty Traversable. |
| public Queue | take(int
The number of elements to take. n)Implements io. Takes the first n elements of this or all elements, if this length < n. |
| public Queue | takeRight(int
The number of elements to take. n)Implements io. Takes the last n elements of this or all elements, if this length < n. |
| public Queue | takeRightUntil(Predicate<? super T>
A condition tested subsequently for this elements, starting from the end. predicate)Implements io. Takes elements until the predicate holds for the current element, starting from the end. |
| public Queue | takeRightWhile(Predicate<? super T>
A condition tested subsequently for this elements, starting from the end. predicate)Implements io. Takes elements while the predicate holds for the current element, starting from the end. |
| public Queue | takeUntil(Predicate<? super T>
A condition tested subsequently for this elements. predicate)Implements abstract io. Implements io. Takes elements until the predicate holds for the current element. |
| public < Type of transformation result U> U | |
| public static < matrix element type T> Queue | |
| public static < type of seeds and unfolded values T> Queue | |
| public static < type of seeds T, type of unfolded values U> Queue | Returns: a Queue with the values built up by the iterationthe start value for the iteration seed, Function<? super T, Option<Tuple2<? extends T, ? extends U>>> the function to get the next step of the iteration f)Creates a Queue from a seed value and a function. |
| public static < type of seeds T, type of unfolded values U> Queue | Returns: a Queue with the values built up by the iterationthe start value for the iteration seed, Function<? super T, Option<Tuple2<? extends U, ? extends T>>> the function to get the next step of the iteration f)Creates a Queue from a seed value and a function. |
| public <T1, T2> Tuple2 | unzip(Function<? super T, Tuple2<? extends T1, ? extends T2>>
a function which converts elements of this to pairs unzipper)Implements io. Unzips this elements by mapping this elements to pairs which are subsequently split into two distinct sets. |
| public <T1, T2, T3> Tuple3 | unzip3(Function<? super T, Tuple3<? extends T1, ? extends T2, ? extends T3>>
a function which converts elements of this to pairs unzipper)Implements io. Unzips this elements by mapping this elements to triples which are subsequently split into three distinct sets. |
| public Queue | update(int
an index index, T an element element)Implements io. Updates the given element at the specified index. |
| public Queue | update(int
an index index, Function<? super T, ? extends T> a function transforming the previous value updater)Implements io. Updates the given element at the specified index using the specified function. |
| public <U> Queue | zip(Iterable<? extends U>
The Iterable providing the second half of each result pair. that)Implements io. Returns a traversable formed from this traversable and another Iterable collection by combining corresponding elements in pairs. |
| public <U> Queue | zipAll(Iterable<? extends U>
The Iterable providing the second half of each result pair. that, T The element to be used to fill up the result if this traversable is shorter than that. thisElem, U The element to be used to fill up the result if that is shorter than this traversable. thatElem)Implements io. Returns a traversable formed from this traversable and another Iterable by combining corresponding elements in pairs. |
| public <U, R> Queue | zipWith(Iterable<? extends U>
The Iterable providing the second parameter of the mapper. that, BiFunction<? super T, ? super U, ? extends R> a mapper. mapper)Implements io. Returns a traversable formed from this traversable and another Iterable collection by mapping elements. |
| public Queue | zipWithIndex()
Implements io. Zips this traversable with its indices. |
| public <U> Queue | zipWithIndex(BiFunction<? super T, ? super Integer, ? extends U>
a mapper. mapper)Implements io. Zips this traversable with its indices by applying mapper provided. |