T - Component typepublic final class Array<T> extends java.lang.Object implements IndexedSeq<T>, java.io.Serializable
Object[] containing elements of type T.| Modifier and Type | Method and Description |
|---|---|
Array<T> |
append(T element)
Appends an element to this.
|
Array<T> |
appendAll(java.lang.Iterable<? extends T> elements)
Appends all given elements to this.
|
T |
apply(java.lang.Integer index)
A
Seq is a partial function which returns the element at the specified index if the
index is valid. |
java.util.List<T> |
asJava()
Creates an immutable
List view on top of this Seq,
i.e. |
Array<T> |
asJava(java.util.function.Consumer<? super java.util.List<T>> action)
Creates an immutable
List view on top of this Seq
that is passed to the given action. |
java.util.List<T> |
asJavaMutable()
Creates a mutable
List view on top of this Seq,
i.e. |
Array<T> |
asJavaMutable(java.util.function.Consumer<? super java.util.List<T>> action)
Creates a mutable
List view on top of this Seq
that is passed to the given action. |
<R> Array<R> |
collect(PartialFunction<? super T,? extends R> partialFunction)
Collects all elements that are in the domain of the given
partialFunction by mapping the elements to type R. |
static <T> java.util.stream.Collector<T,java.util.ArrayList<T>,Array<T>> |
collector()
Returns a
Collector which may be used in conjunction with
Stream.collect(java.util.stream.Collector) to obtain a Array. |
Array<Array<T>> |
combinations()
Returns the union of all combinations from k = 0 to length().
|
Array<Array<T>> |
combinations(int k)
Returns the k-combination of this traversable, i.e.
|
Iterator<Array<T>> |
crossProduct(int power)
Calculates the n-ary cartesian power (or cross product or simply product) of this.
|
Array<T> |
distinct()
Returns a new version of this which contains no duplicates.
|
Array<T> |
distinctBy(java.util.Comparator<? super T> comparator)
Returns a new version of this which contains no duplicates.
|
<U> Array<T> |
distinctBy(java.util.function.Function<? super T,? extends U> keyExtractor)
Returns a new version of this which contains no duplicates.
|
Array<T> |
drop(int n)
Drops the first n elements of this or all elements, if this length < n.
|
Array<T> |
dropRight(int n)
Drops the last n elements of this or all elements, if this length < n.
|
Array<T> |
dropRightUntil(java.util.function.Predicate<? super T> predicate)
Drops elements until the predicate holds for the current element, starting from the end.
|
Array<T> |
dropRightWhile(java.util.function.Predicate<? super T> predicate)
Drops elements while the predicate holds for the current element, starting from the end.
|
Array<T> |
dropUntil(java.util.function.Predicate<? super T> predicate)
Drops elements until the predicate holds for the current element.
|
Array<T> |
dropWhile(java.util.function.Predicate<? super T> predicate)
Drops elements while the predicate holds for the current element.
|
static <T> Array<T> |
empty() |
boolean |
equals(java.lang.Object o)
In Vavr there are four basic classes of collections:
Seq (sequential elements)
Set (distinct elements)
Map (indexed elements)
Multimap (indexed collections)
Two collection instances of these classes are equal if and only if both collections
belong to the same basic collection class (Seq, Set, Map or Multimap)
contain the same elements
have the same element order, if the collections are of type Seq
Two Map/Multimap elements, resp.
|
static <T> Array<T> |
fill(int n,
java.util.function.Supplier<? extends T> s)
Returns an Array containing
n values supplied by a given Supplier s. |
static <T> Array<T> |
fill(int n,
T element)
Returns an Array containing
n times the given element |
Array<T> |
filter(java.util.function.Predicate<? super T> predicate)
Returns a new traversable consisting of all elements which satisfy the given predicate.
|
Array<T> |
filterNot(java.util.function.Predicate<? super T> predicate)
Returns a new traversable consisting of all elements which do not satisfy the given predicate.
|
<U> Array<U> |
flatMap(java.util.function.Function<? super T,? extends java.lang.Iterable<? extends U>> mapper)
FlatMaps this Traversable.
|
Seq<Array<T>> |
group()
Groups subsequent equal elements.
|
<C> Map<C,Array<T>> |
groupBy(java.util.function.Function<? super T,? extends C> classifier)
Groups this elements by classifying the elements.
|
Iterator<Array<T>> |
grouped(int size)
Groups this
Traversable into fixed size blocks. |
boolean |
hasDefiniteSize()
Checks if this Traversable is known to have a finite size.
|
int |
hashCode()
Returns the hash code of this collection.
|
T |
head()
Returns the first element of a non-empty Traversable.
|
int |
indexOf(T element,
int from)
Returns the index of the first occurrence of the given element after or at some start index
or -1 if this does not contain the given element.
|
Array<T> |
init()
Dual of Traversable.tail(), returning all elements except the last.
|
Option<Array<T>> |
initOption()
Dual of Traversable.tailOption(), returning all elements except the last as
Option. |
Array<T> |
insert(int index,
T element)
Inserts the given element at the specified index.
|
Array<T> |
insertAll(int index,
java.lang.Iterable<? extends T> elements)
Inserts the given elements at the specified index.
|
Array<T> |
intersperse(T element)
Inserts an element between all elements of this Traversable.
|
boolean |
isAsync()
An
Array is computed synchronously. |
boolean |
isEmpty()
Checks if this Traversable is empty.
|
boolean |
isLazy()
An
Array is computed eagerly. |
boolean |
isTraversableAgain()
Checks if this Traversable can be repeatedly traversed.
|
Iterator<T> |
iterator()
An iterator by means of head() and tail().
|
int |
lastIndexOf(T element,
int end)
Returns the index of the last occurrence of the given element before or at a given end index
or -1 if this does not contain the given element.
|
Array<T> |
leftPadTo(int length,
T element)
A copy of this sequence with an element prepended until a given target length is reached.
|
int |
length()
Computes the number of elements of this Traversable.
|
<U> Array<U> |
map(java.util.function.Function<? super T,? extends U> mapper)
Maps the elements of this
Traversable to elements of a new type preserving their order, if any. |
static <T> Array<T> |
narrow(Array<? extends T> array)
Narrows a widened
Array<? extends T> to Array<T>
by performing a type-safe cast. |
static <T> Array<T> |
of(T... elements)
Creates an Array of the given elements.
|
static <T> Array<T> |
of(T element)
Returns a singleton
Array, i.e. |
static Array<java.lang.Boolean> |
ofAll(boolean... elements)
Creates an Array from boolean values.
|
static Array<java.lang.Byte> |
ofAll(byte... elements)
Creates an Array from byte values.
|
static Array<java.lang.Character> |
ofAll(char... elements)
Creates an Array from char values.
|
static Array<java.lang.Double> |
ofAll(double... elements)
Creates an Array from double values.
|
static Array<java.lang.Float> |
ofAll(float... elements)
Creates an Array from float values.
|
static Array<java.lang.Integer> |
ofAll(int... elements)
Creates an Array from int values.
|
static <T> Array<T> |
ofAll(java.lang.Iterable<? extends T> elements)
Creates an Array of the given elements.
|
static Array<java.lang.Long> |
ofAll(long... elements)
Creates an Array from long values.
|
static Array<java.lang.Short> |
ofAll(short... elements)
Creates an Array from short values.
|
static <T> Array<T> |
ofAll(java.util.stream.Stream<? extends T> javaStream)
Creates an Array that contains the elements of the given
Stream. |
Array<T> |
orElse(java.lang.Iterable<? extends T> other)
Returns this
Traversable if it is nonempty, otherwise return the alternative. |
Array<T> |
orElse(java.util.function.Supplier<? extends java.lang.Iterable<? extends T>> supplier)
Returns this
Traversable if it is nonempty, otherwise return the result of evaluating supplier. |
Array<T> |
padTo(int length,
T element)
A copy of this sequence with an element appended until a given target length is reached.
|
Tuple2<Array<T>,Array<T>> |
partition(java.util.function.Predicate<? super T> predicate)
Creates a partition of this
Traversable by splitting this elements in two in distinct traversables
according to a predicate. |
Array<T> |
patch(int from,
java.lang.Iterable<? extends T> that,
int replaced)
Produces a new list where a slice of elements in this list is replaced by another sequence.
|
Array<T> |
peek(java.util.function.Consumer<? super T> action)
Performs the given
action on the first element if this is an eager implementation. |
Array<Array<T>> |
permutations()
Computes all unique permutations.
|
Array<T> |
prepend(T element)
Prepends an element to this.
|
Array<T> |
prependAll(java.lang.Iterable<? extends T> elements)
Prepends all given elements to this.
|
static Array<java.lang.Character> |
range(char from,
char toExclusive) |
static Array<java.lang.Integer> |
range(int from,
int toExclusive)
Creates an Array of int numbers starting from
from, extending to toExclusive - 1. |
static Array<java.lang.Long> |
range(long from,
long toExclusive)
Creates an Array of long numbers starting from
from, extending to toExclusive - 1. |
static Array<java.lang.Character> |
rangeBy(char from,
char toExclusive,
int step) |
static Array<java.lang.Double> |
rangeBy(double from,
double toExclusive,
double step) |
static Array<java.lang.Integer> |
rangeBy(int from,
int toExclusive,
int step)
Creates an Array of int numbers starting from
from, extending to toExclusive - 1,
with step. |
static Array<java.lang.Long> |
rangeBy(long from,
long toExclusive,
long step)
Creates an Array of long numbers starting from
from, extending to toExclusive - 1,
with step. |
static Array<java.lang.Character> |
rangeClosed(char from,
char toInclusive) |
static Array<java.lang.Integer> |
rangeClosed(int from,
int toInclusive)
Creates an Array of int numbers starting from
from, extending to toInclusive. |
static Array<java.lang.Long> |
rangeClosed(long from,
long toInclusive)
Creates an Array of long numbers starting from
from, extending to toInclusive. |
static Array<java.lang.Character> |
rangeClosedBy(char from,
char toInclusive,
int step) |
static Array<java.lang.Double> |
rangeClosedBy(double from,
double toInclusive,
double step) |
static Array<java.lang.Integer> |
rangeClosedBy(int from,
int toInclusive,
int step)
Creates an Array of int numbers starting from
from, extending to toInclusive,
with step. |
static Array<java.lang.Long> |
rangeClosedBy(long from,
long toInclusive,
long step)
Creates an Array of long numbers starting from
from, extending to toInclusive,
with step. |
Array<T> |
remove(T element)
Removes the first occurrence of the given element.
|
Array<T> |
removeAll(java.lang.Iterable<? extends T> elements)
Removes all occurrences of the given elements.
|
Array<T> |
removeAll(T element)
Removes all occurrences of the given element.
|
Array<T> |
removeAt(int index)
Removes the element at the specified position in this sequence.
|
Array<T> |
removeFirst(java.util.function.Predicate<T> predicate)
Removes the first occurrence that satisfy predicate
|
Array<T> |
removeLast(java.util.function.Predicate<T> predicate)
Removes the last occurrence that satisfy predicate
|
Array<T> |
replace(T currentElement,
T newElement)
Replaces the first occurrence (if exists) of the given currentElement with newElement.
|
Array<T> |
replaceAll(T currentElement,
T newElement)
Replaces all occurrences of the given currentElement with newElement.
|
Array<T> |
retainAll(java.lang.Iterable<? extends T> elements)
Keeps all occurrences of the given elements from this.
|
Array<T> |
reverse()
Reverses the order of elements.
|
Array<T> |
rotateLeft(int n)
Circular rotates the elements by the specified distance to the left direction.
|
Array<T> |
rotateRight(int n)
Circular rotates the elements by the specified distance to the right direction.
|
Array<T> |
scan(T zero,
java.util.function.BiFunction<? super T,? super T,? extends T> operation)
Computes a prefix scan of the elements of the collection.
|
<U> Array<U> |
scanLeft(U zero,
java.util.function.BiFunction<? super U,? super T,? extends U> operation)
Produces a collection containing cumulative results of applying the
operator going left to right.
|
<U> Array<U> |
scanRight(U zero,
java.util.function.BiFunction<? super T,? super U,? extends U> operation)
Produces a collection containing cumulative results of applying the
operator going right to left.
|
Array<T> |
shuffle()
Randomize the order of the elements in the current sequence.
|
Array<T> |
shuffle(java.util.Random random)
Randomize the order of the elements in the current sequence using the given source
of randomness.
|
Array<T> |
slice(int beginIndex,
int endIndex)
Returns a Seq that is a slice of this.
|
Iterator<Array<T>> |
slideBy(java.util.function.Function<? super T,?> classifier)
Slides a non-overlapping window of a variable size over this
Traversable. |
Iterator<Array<T>> |
sliding(int size)
Slides a window of a specific
size and step size 1 over this Traversable by calling
Traversable.sliding(int, int). |
Iterator<Array<T>> |
sliding(int size,
int step)
Slides a window of a specific
size and step size over this Traversable. |
<U> Array<T> |
sortBy(java.util.Comparator<? super U> comparator,
java.util.function.Function<? super T,? extends U> mapper)
Sorts this elements by comparing the elements in a different domain, using the given
mapper. |
<U extends java.lang.Comparable<? super U>> |
sortBy(java.util.function.Function<? super T,? extends U> mapper)
Sorts this elements by comparing the elements in a different domain, using the given
mapper. |
Array<T> |
sorted()
Sorts this elements according to their natural order.
|
Array<T> |
sorted(java.util.Comparator<? super T> comparator)
Sorts this elements according to the provided
Comparator. |
Tuple2<Array<T>,Array<T>> |
span(java.util.function.Predicate<? super T> predicate)
Returns a tuple where the first element is the longest prefix of elements that satisfy the given
predicate and the second element is the remainder. |
Tuple2<Array<T>,Array<T>> |
splitAt(int n)
Splits a Seq at the specified index.
|
Tuple2<Array<T>,Array<T>> |
splitAt(java.util.function.Predicate<? super T> predicate)
Splits a sequence at the first element which satisfies the
Predicate, e.g. |
Tuple2<Array<T>,Array<T>> |
splitAtInclusive(java.util.function.Predicate<? super T> predicate)
Splits a sequence at the first element which satisfies the
Predicate, e.g. |
java.lang.String |
stringPrefix()
Returns the name of this Value type, which is used by toString().
|
Array<T> |
subSequence(int beginIndex)
Returns a Seq that is a subsequence of this.
|
Array<T> |
subSequence(int beginIndex,
int endIndex)
Returns a Seq that is a subsequence of this.
|
static <T> Array<T> |
tabulate(int n,
java.util.function.Function<? super java.lang.Integer,? extends T> f)
Returns an Array containing
n values of a given Function f
over a range of integer values from 0 to n - 1. |
Array<T> |
tail()
Drops the first element of a non-empty Traversable.
|
Option<Array<T>> |
tailOption()
Drops the first element of a non-empty Traversable and returns an
Option. |
Array<T> |
take(int n)
Takes the first n elements of this or all elements, if this length < n.
|
Array<T> |
takeRight(int n)
Takes the last n elements of this or all elements, if this length < n.
|
Array<T> |
takeRightUntil(java.util.function.Predicate<? super T> predicate)
Takes elements until the predicate holds for the current element, starting from the end.
|
Array<T> |
takeRightWhile(java.util.function.Predicate<? super T> predicate)
Takes elements while the predicate holds for the current element, starting from the end.
|
Array<T> |
takeUntil(java.util.function.Predicate<? super T> predicate)
Takes elements until the predicate holds for the current element.
|
Array<T> |
takeWhile(java.util.function.Predicate<? super T> predicate)
Takes elements while the predicate holds for the current element.
|
java.lang.String |
toString()
Clarifies that values have a proper toString() method implemented.
|
<U> U |
transform(java.util.function.Function<? super Array<T>,? extends U> f)
Transforms this
Array. |
static <T> Array<T> |
unfold(T seed,
java.util.function.Function<? super T,Option<Tuple2<? extends T,? extends T>>> f)
Creates an Array from a seed value and a function.
|
static <T,U> Array<U> |
unfoldLeft(T seed,
java.util.function.Function<? super T,Option<Tuple2<? extends T,? extends U>>> f)
Creates an Array from a seed value and a function.
|
static <T,U> Array<U> |
unfoldRight(T seed,
java.util.function.Function<? super T,Option<Tuple2<? extends U,? extends T>>> f)
Creates an Array from a seed value and a function.
|
Array<T> |
update(int index,
java.util.function.Function<? super T,? extends T> updater)
Updates the given element at the specified index using the specified function.
|
Array<T> |
update(int index,
T element)
Updates the given element at the specified index.
|
<U> Array<Tuple2<T,U>> |
zip(java.lang.Iterable<? extends U> that)
Returns a traversable formed from this traversable and another Iterable collection by combining
corresponding elements in pairs.
|
<U> Array<Tuple2<T,U>> |
zipAll(java.lang.Iterable<? extends U> that,
T thisElem,
U thatElem)
Returns a traversable formed from this traversable and another Iterable by combining corresponding elements in
pairs.
|
<U,R> Array<R> |
zipWith(java.lang.Iterable<? extends U> that,
java.util.function.BiFunction<? super T,? super U,? extends R> mapper)
Returns a traversable formed from this traversable and another Iterable collection by mapping elements.
|
Array<Tuple2<T,java.lang.Integer>> |
zipWithIndex()
Zips this traversable with its indices.
|
<U> Array<U> |
zipWithIndex(java.util.function.BiFunction<? super T,? super java.lang.Integer,? extends U> mapper)
Zips this traversable with its indices by applying mapper provided.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, waitasPartialFunction, endsWith, indexOfSlice, indexWhere, isDefinedAt, last, lastIndexOfSlice, lastIndexWhere, narrow, reverseIterator, search, search, segmentLength, startsWithcontainsSlice, crossProduct, crossProduct, foldRight, get, getOption, getOrElse, indexOf, indexOfOption, indexOfOption, indexOfSlice, indexOfSliceOption, indexOfSliceOption, indexWhere, indexWhereOption, indexWhereOption, isSequential, iterator, lastIndexOf, lastIndexOfOption, lastIndexOfOption, lastIndexOfSlice, lastIndexOfSliceOption, lastIndexOfSliceOption, lastIndexWhere, lastIndexWhereOption, lastIndexWhereOption, lift, narrow, prefixLength, startsWitharrangeBy, average, containsAll, count, existsUnique, find, findLast, fold, foldLeft, forEachWithIndex, get, headOption, isDistinct, isOrdered, isSingleValued, lastOption, max, maxBy, maxBy, min, minBy, minBy, mkCharSeq, mkCharSeq, mkCharSeq, mkString, mkString, mkString, narrow, nonEmpty, product, reduce, reduceLeft, reduceLeftOption, reduceOption, reduceRight, reduceRightOption, single, singleOption, size, spliterator, sum, toLinkedMap, toMap, toSortedMap, toSortedMap, unzip, unzip3collect, collect, contains, corresponds, eq, exists, forAll, forEach, getOrElse, getOrElse, getOrElseThrow, getOrElseTry, getOrNull, narrow, 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, toTree, toTree, toTry, toTry, toValid, toValid, toValidation, toValidation, toVectorpublic static <T> java.util.stream.Collector<T,java.util.ArrayList<T>,Array<T>> collector()
Collector which may be used in conjunction with
Stream.collect(java.util.stream.Collector) to obtain a Array.T - Component type of the Array.Collector which collects all the input elements into a
Array, in encounter orderpublic static <T> Array<T> empty()
public static <T> Array<T> narrow(Array<? extends T> array)
Array<? extends T> to Array<T>
by performing a type-safe cast. This is eligible because immutable/read-only
collections are covariant.
Array<Double> doubles = Array.of(1.0d, 2.0d);
Array<Number> numbers = Array.narrow(doubles); // = Array(1.0d, 2.0d)
T - Component type of the Array.array - An Array.array instance as narrowed type Array<T>.public static <T> Array<T> of(T element)
Array, i.e. a Array of one element.
Array<Double> doubles = Array.of(1.0d); // = Array(1.0d)
Array<Integer> ints = Array.of(10); // = Array(10)
@SafeVarargs public static <T> Array<T> of(T... elements)
Array<Integer> ints = Array.of(1, 2, 3); // = Array(1, 2, 3)
Array<Double> doubles = Array.of(1.0d, 2.0d, 3.0d); // = Array(1.0, 2.0, 3.0)
T - Component type of the Array.elements - Zero or more elements.java.lang.NullPointerException - if elements is nullpublic static <T> Array<T> ofAll(java.lang.Iterable<? extends T> elements)
The resulting Array has the same iteration order as the given iterable of elements if the iteration order of the elements is stable.
List<Integer> integers = List.of(1, 2, 3);
Array<Integer> ints = Array.ofAll(integers); // = Array(1, 2, 3)
T - Component type of the Array.elements - An Iterable of elements.java.lang.NullPointerException - if elements is nullpublic static <T> Array<T> ofAll(java.util.stream.Stream<? extends T> javaStream)
Stream.
List<Integer> integers = List.of(1, 2, 3);
Array<Integer> ints = Array.ofAll(integers.toJavaStream()); // = Array(1, 2, 3)
T - Component type of the Stream.javaStream - A Streampublic static Array<java.lang.Boolean> ofAll(boolean... elements)
Array<Boolean> booleans = Array.ofAll(true, false); // = Array(true, false)
elements - boolean valuesjava.lang.NullPointerException - if elements is nullpublic static Array<java.lang.Byte> ofAll(byte... elements)
Array<Byte> bytes = Array.ofAll((byte)1, (byte)2); // = Array(1, 2)
elements - byte valuesjava.lang.NullPointerException - if elements is nullpublic static Array<java.lang.Character> ofAll(char... elements)
Array<Character> characters = Array.ofAll('a', 'e', 'i', 'o', 'u'); // = Array(a, e, i, o, u)
elements - char valuesjava.lang.NullPointerException - if elements is nullpublic static Array<java.lang.Double> ofAll(double... elements)
Array<Double> doubles = Array.ofAll(1d, 2d); // = Array(1.0, 2.0)
elements - double valuesjava.lang.NullPointerException - if elements is nullpublic static Array<java.lang.Float> ofAll(float... elements)
Array<Float> floats = Array.ofAll(1.1f, 2.2f); // = Array(1.1, 2.2)
elements - float valuesjava.lang.NullPointerException - if elements is nullpublic static Array<java.lang.Integer> ofAll(int... elements)
Array<Integer> ints = Array.ofAll(1, 2); // = Array(1, 2)
elements - int valuesjava.lang.NullPointerException - if elements is nullpublic static Array<java.lang.Long> ofAll(long... elements)
Array<Long> longValues = Array.ofAll(1L, 2L); // = Array(1, 2)
elements - long valuesjava.lang.NullPointerException - if elements is nullpublic static Array<java.lang.Short> ofAll(short... elements)
Array<Short> shortValues = Array.ofAll((short)1, (short)2); // = Array(1, 2)
elements - short valuesjava.lang.NullPointerException - if elements is nullpublic static <T> Array<T> tabulate(int n, java.util.function.Function<? super java.lang.Integer,? extends T> f)
n values of a given Function f
over a range of integer values from 0 to n - 1.
Array<Integer> values = Array.tabulate(5, i -> 2 * i); // = Array(0, 2, 4, 6, 8)
T - Component type of the Arrayn - The number of elements in the Arrayf - The Function computing element valuesf(0),f(1), ..., f(n - 1)java.lang.NullPointerException - if f is nullpublic static <T> Array<T> fill(int n, java.util.function.Supplier<? extends T> s)
n values supplied by a given Supplier s.T - Component type of the Arrayn - The number of elements in the Arrays - The Supplier computing element valuesn, where each element contains the result supplied by s.java.lang.NullPointerException - if s is nullpublic static <T> Array<T> fill(int n, T element)
n times the given element
Array<Integer> values = Array.fill(5, 20); // = Array(20, 20, 20, 20, 20)
T - Component type of the Arrayn - The number of elements in the Arrayelement - The elementn, where each element is the given element.public static Array<java.lang.Character> range(char from, char toExclusive)
public static Array<java.lang.Character> rangeBy(char from, char toExclusive, int step)
public static Array<java.lang.Double> rangeBy(double from, double toExclusive, double step)
public static Array<java.lang.Integer> range(int from, int toExclusive)
from, extending to toExclusive - 1.
Examples:
Array.range(0, 0) // = Array()
Array.range(2, 0) // = Array()
Array.range(-2, 2) // = Array(-2, -1, 0, 1)
from - the first numbertoExclusive - the last number + 1from >= toExclusivepublic static Array<java.lang.Integer> rangeBy(int from, int toExclusive, int step)
from, extending to toExclusive - 1,
with step.
Examples:
Array.rangeBy(1, 3, 1) // = Array(1, 2)
Array.rangeBy(1, 4, 2) // = Array(1, 3)
Array.rangeBy(4, 1, -2) // = Array(4, 2)
Array.rangeBy(4, 1, 2) // = Array()
from - the first numbertoExclusive - the last number + 1step - the stepfrom >= toInclusive and step > 0 orfrom <= toInclusive and step < 0java.lang.IllegalArgumentException - if step is zeropublic static Array<java.lang.Long> range(long from, long toExclusive)
from, extending to toExclusive - 1.
Examples:
Array.range(0L, 0L) // = Array()
Array.range(2L, 0L) // = Array()
Array.range(-2L, 2L) // = Array(-2L, -1L, 0L, 1L)
from - the first numbertoExclusive - the last number + 1from >= toExclusivepublic static Array<java.lang.Long> rangeBy(long from, long toExclusive, long step)
from, extending to toExclusive - 1,
with step.
Examples:
Array.rangeBy(1L, 3L, 1L) // = Array(1L, 2L)
Array.rangeBy(1L, 4L, 2L) // = Array(1L, 3L)
Array.rangeBy(4L, 1L, -2L) // = Array(4L, 2L)
Array.rangeBy(4L, 1L, 2L) // = Array()
from - the first numbertoExclusive - the last number + 1step - the stepfrom >= toInclusive and step > 0 orfrom <= toInclusive and step < 0java.lang.IllegalArgumentException - if step is zeropublic static Array<java.lang.Character> rangeClosed(char from, char toInclusive)
public static Array<java.lang.Character> rangeClosedBy(char from, char toInclusive, int step)
public static Array<java.lang.Double> rangeClosedBy(double from, double toInclusive, double step)
public static Array<java.lang.Integer> rangeClosed(int from, int toInclusive)
from, extending to toInclusive.
Examples:
Array.rangeClosed(0, 0) // = Array(0)
Array.rangeClosed(2, 0) // = Array()
Array.rangeClosed(-2, 2) // = Array(-2, -1, 0, 1, 2)
from - the first numbertoInclusive - the last numberfrom > toInclusivepublic static Array<java.lang.Integer> rangeClosedBy(int from, int toInclusive, int step)
from, extending to toInclusive,
with step.
Examples:
Array.rangeClosedBy(1, 3, 1) // = Array(1, 2, 3)
Array.rangeClosedBy(1, 4, 2) // = Array(1, 3)
Array.rangeClosedBy(4, 1, -2) // = Array(4, 2)
Array.rangeClosedBy(4, 1, 2) // = Array()
from - the first numbertoInclusive - the last numberstep - the stepfrom > toInclusive and step > 0 orfrom < toInclusive and step < 0java.lang.IllegalArgumentException - if step is zeropublic static Array<java.lang.Long> rangeClosed(long from, long toInclusive)
from, extending to toInclusive.
Examples:
Array.rangeClosed(0L, 0L) // = Array(0L)
Array.rangeClosed(2L, 0L) // = Array()
Array.rangeClosed(-2L, 2L) // = Array(-2L, -1L, 0L, 1L, 2L)
from - the first numbertoInclusive - the last numberfrom > toInclusivepublic static Array<java.lang.Long> rangeClosedBy(long from, long toInclusive, long step)
from, extending to toInclusive,
with step.
Examples:
Array.rangeClosedBy(1L, 3L, 1L) // = Array(1L, 2L, 3L)
Array.rangeClosedBy(1L, 4L, 2L) // = Array(1L, 3L)
Array.rangeClosedBy(4L, 1L, -2L) // = Array(4L, 2L)
Array.rangeClosedBy(4L, 1L, 2L) // = Array()
from - the first numbertoInclusive - the last numberstep - the stepfrom > toInclusive and step > 0 orfrom < toInclusive and step < 0java.lang.IllegalArgumentException - if step is zeropublic static <T,U> Array<U> unfoldRight(T seed, java.util.function.Function<? super T,Option<Tuple2<? extends U,? extends T>>> f)
None when it's
done generating the Array, otherwise Some Tuple
of the element for the next call and the value to add to the
resulting Array.
Example:
Array.unfoldRight(10, x -> x == 0
? Option.none()
: Option.of(new Tuple2<gt;(x, x-1)));
// Array(10, 9, 8, 7, 6, 5, 4, 3, 2, 1))
T - type of seedsU - type of unfolded valuesseed - the start value for the iterationf - the function to get the next step of the iterationjava.lang.NullPointerException - if f is nullpublic static <T,U> Array<U> unfoldLeft(T seed, java.util.function.Function<? super T,Option<Tuple2<? extends T,? extends U>>> f)
None when it's
done generating the list, otherwise Some Tuple
of the value to add to the resulting list and
the element for the next call.
Example:
Array.unfoldLeft(10, x -> x == 0
? Option.none()
: Option.of(new Tuple2<gt;(x-1, x)));
// Array(1, 2, 3, 4, 5, 6, 7, 8, 9, 10))
T - type of seedsU - type of unfolded valuesseed - the start value for the iterationf - the function to get the next step of the iterationjava.lang.NullPointerException - if f is nullpublic static <T> Array<T> unfold(T seed, java.util.function.Function<? super T,Option<Tuple2<? extends T,? extends T>>> f)
None when it's
done generating the list, otherwise Some Tuple
of the value to add to the resulting list and
the element for the next call.
Example:
Array.unfold(10, x -> x == 0
? Option.none()
: Option.of(new Tuple2<gt;(x-1, x)));
// Array(1, 2, 3, 4, 5, 6, 7, 8, 9, 10))
T - type of seeds and unfolded valuesseed - the start value for the iterationf - the function to get the next step of the iterationjava.lang.NullPointerException - if f is nullpublic Array<T> append(T element)
Seqpublic Array<T> appendAll(java.lang.Iterable<? extends T> elements)
Seqpublic java.util.List<T> asJava()
SeqList view on top of this Seq,
i.e. calling mutators will result in UnsupportedOperationException at runtime.
The difference to conversion methods toJava*() is that
java.util.List view throws UnsupportedOperationException before
checking method arguments. Java does handle this case inconsistently.public Array<T> asJava(java.util.function.Consumer<? super java.util.List<T>> action)
SeqList view on top of this Seq
that is passed to the given action.asJava in interface IndexedSeq<T>asJava in interface Seq<T>action - A side-effecting unit of work that operates on an immutable java.util.List view.Seq.asJava()public java.util.List<T> asJavaMutable()
SeqList view on top of this Seq,
i.e. all mutator methods of the List are implemented.asJavaMutable in interface Seq<T>Collection view on this Traversable.Seq.asJava()public Array<T> asJavaMutable(java.util.function.Consumer<? super java.util.List<T>> action)
SeqList view on top of this Seq
that is passed to the given action.asJavaMutable in interface IndexedSeq<T>asJavaMutable in interface Seq<T>action - A side-effecting unit of work that operates on a mutable java.util.List view.java.util.List view or a new instance of this type, if write operations are performed on the java.util.List view.Seq.asJavaMutable()public <R> Array<R> collect(PartialFunction<? super T,? extends R> partialFunction)
TraversablepartialFunction by mapping the elements to type R.
More specifically, for each of this elements in iteration order first it is checked
partialFunction.isDefinedAt(element)
If the elements makes it through that filter, the mapped instance is added to the result collection
R newElement = partialFunction.apply(element)
Note:If this Traversable is ordered (i.e. extends Ordered,
the caller of collect has to ensure that the elements are comparable (i.e. extend Comparable).collect in interface IndexedSeq<T>collect in interface Seq<T>collect in interface Traversable<T>R - The new element typepartialFunction - A function that is not necessarily defined of all elements of this traversable.Traversable instance containing elements of type Rpublic boolean hasDefiniteSize()
TraversableThis method should be implemented by classes only, i.e. not by interfaces.
hasDefiniteSize in interface Traversable<T>public boolean isAsync()
Array is computed synchronously.public boolean isLazy()
Array is computed eagerly.public boolean isTraversableAgain()
TraversableThis method should be implemented by classes only, i.e. not by interfaces.
isTraversableAgain in interface Traversable<T>public Iterator<T> iterator()
Traversablepublic Array<Array<T>> combinations()
SeqExamples:
[].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
]
combinations in interface IndexedSeq<T>combinations in interface Seq<T>public Array<Array<T>> combinations(int k)
Seqcombinations in interface IndexedSeq<T>combinations in interface Seq<T>k - Size of subsetspublic Iterator<Array<T>> crossProduct(int power)
SeqExample:
// = ((A,A), (A,B), (A,C), ..., (B,A), (B,B), ..., (Z,Y), (Z,Z))
CharSeq.rangeClosed('A', 'Z').crossProduct(2);
Cartesian power of negative value will return empty iterator.
Example:
// = ()
CharSeq.rangeClosed('A', 'Z').crossProduct(-1);
crossProduct in interface IndexedSeq<T>crossProduct in interface Seq<T>power - the number of cartesian multiplicationspublic T apply(java.lang.Integer index)
SeqSeq is a partial function which returns the element at the specified index if the
index is valid. It's up to the caller to make sure the index is valid (for instance through
isDefinedAt).
The behaviour is undefined if the index is out of bounds.
It may throw any RuntimeException or return an arbitrary value.apply in interface Seq<T>apply in interface Function1<java.lang.Integer,T>apply in interface PartialFunction<java.lang.Integer,T>apply in interface java.util.function.Function<java.lang.Integer,T>index - an indexpublic Array<T> distinct()
Traversableequals.distinct in interface IndexedSeq<T>distinct in interface Seq<T>distinct in interface Traversable<T>Traversable containing this elements without duplicatespublic Array<T> distinctBy(java.util.Comparator<? super T> comparator)
Traversablecomparator.distinctBy in interface IndexedSeq<T>distinctBy in interface Seq<T>distinctBy in interface Traversable<T>comparator - A comparatorTraversable containing this elements without duplicatespublic <U> Array<T> distinctBy(java.util.function.Function<? super T,? extends U> keyExtractor)
Traversableequals.
The elements of the result are determined in the order of their occurrence - first match wins.
distinctBy in interface IndexedSeq<T>distinctBy in interface Seq<T>distinctBy in interface Traversable<T>U - key typekeyExtractor - A key extractorTraversable containing this elements without duplicatespublic Array<T> drop(int n)
Traversabledrop in interface IndexedSeq<T>drop in interface Seq<T>drop in interface Traversable<T>n - The number of elements to drop.public Array<T> dropUntil(java.util.function.Predicate<? super T> predicate)
TraversabledropUntil in interface IndexedSeq<T>dropUntil in interface Seq<T>dropUntil in interface Traversable<T>predicate - A condition tested subsequently for this elements.public Array<T> dropWhile(java.util.function.Predicate<? super T> predicate)
Traversable
Note: This is essentially the same as dropUntil(predicate.negate()).
It is intended to be used with method references, which cannot be negated directly.
dropWhile in interface IndexedSeq<T>dropWhile in interface Seq<T>dropWhile in interface Traversable<T>predicate - A condition tested subsequently for this elements.public Array<T> dropRight(int n)
TraversabledropRight in interface IndexedSeq<T>dropRight in interface Seq<T>dropRight in interface Traversable<T>n - The number of elements to drop.public Array<T> dropRightUntil(java.util.function.Predicate<? super T> predicate)
SeqdropRightUntil in interface IndexedSeq<T>dropRightUntil in interface Seq<T>predicate - A condition tested subsequently for this elements, starting from the end.public Array<T> dropRightWhile(java.util.function.Predicate<? super T> predicate)
Seq
Note: This is essentially the same as dropRightUntil(predicate.negate()).
It is intended to be used with method references, which cannot be negated directly.
dropRightWhile in interface IndexedSeq<T>dropRightWhile in interface Seq<T>predicate - A condition tested subsequently for this elements, starting from the end.public Array<T> filter(java.util.function.Predicate<? super T> predicate)
Traversablefilter in interface IndexedSeq<T>filter in interface Seq<T>filter in interface Traversable<T>predicate - A predicatepublic Array<T> filterNot(java.util.function.Predicate<? super T> predicate)
TraversableThe default implementation is equivalent to
filter(predicate.negate()filterNot in interface IndexedSeq<T>filterNot in interface Seq<T>filterNot in interface Traversable<T>predicate - A predicatepublic <U> Array<U> flatMap(java.util.function.Function<? super T,? extends java.lang.Iterable<? extends U>> mapper)
TraversableflatMap in interface IndexedSeq<T>flatMap in interface Seq<T>flatMap in interface Traversable<T>U - The resulting component type.mapper - A mapperpublic Seq<Array<T>> group()
Seqpublic <C> Map<C,Array<T>> groupBy(java.util.function.Function<? super T,? extends C> classifier)
TraversablegroupBy in interface IndexedSeq<T>groupBy in interface Seq<T>groupBy in interface Traversable<T>C - classified class typeclassifier - A function which classifies elements into classesTraversable.arrangeBy(Function)public Iterator<Array<T>> grouped(int size)
TraversableTraversable into fixed size blocks.
Let length be the length of this Iterable. Then grouped is defined as follows:
this.isEmpty(), the resulting Iterator is empty.size <= length, the resulting Iterator will contain length / size blocks of size
size and maybe a non-empty block of size length % size, if there are remaining elements.size > length, the resulting Iterator will contain one block of size length.
[].grouped(1) = []
[].grouped(0) throws
[].grouped(-1) throws
[1,2,3,4].grouped(2) = [[1,2],[3,4]]
[1,2,3,4,5].grouped(2) = [[1,2],[3,4],[5]]
[1,2,3,4].grouped(5) = [[1,2,3,4]]
Please note that grouped(int) is a special case of Traversable.sliding(int, int), i.e.
grouped(size) is the same as sliding(size, size).grouped in interface IndexedSeq<T>grouped in interface Seq<T>grouped in interface Traversable<T>size - a positive block sizepublic T head()
Traversablehead in interface Traversable<T>public int indexOf(T element, int from)
Seqpublic Array<T> init()
Traversableinit in interface IndexedSeq<T>init in interface Seq<T>init in interface Traversable<T>public Option<Array<T>> initOption()
TraversableOption.initOption in interface IndexedSeq<T>initOption in interface Seq<T>initOption in interface Traversable<T>Some(traversable) or None if this is empty.public boolean isEmpty()
Traversablepublic Array<T> insert(int index, T element)
Seqpublic Array<T> insertAll(int index, java.lang.Iterable<? extends T> elements)
Seqpublic Array<T> intersperse(T element)
Seqintersperse in interface IndexedSeq<T>intersperse in interface Seq<T>element - An element.public int lastIndexOf(T element, int end)
SeqlastIndexOf in interface Seq<T>element - an elementend - the end indexpublic int length()
Traversable
Same as Traversable.size().
length in interface Traversable<T>public <U> Array<U> map(java.util.function.Function<? super T,? extends U> mapper)
TraversableTraversable to elements of a new type preserving their order, if any.public Array<T> orElse(java.lang.Iterable<? extends T> other)
TraversableTraversable if it is nonempty, otherwise return the alternative.orElse in interface IndexedSeq<T>orElse in interface Seq<T>orElse in interface Traversable<T>other - An alternative TraversableTraversable if it is nonempty, otherwise return the alternative.public Array<T> orElse(java.util.function.Supplier<? extends java.lang.Iterable<? extends T>> supplier)
TraversableTraversable if it is nonempty, otherwise return the result of evaluating supplier.orElse in interface IndexedSeq<T>orElse in interface Seq<T>orElse in interface Traversable<T>supplier - An alternative Traversable supplierTraversable if it is nonempty, otherwise return the result of evaluating supplier.public Array<T> padTo(int length, T element)
SeqNote: lazily-evaluated Seq implementations need to process all elements in order to gather the overall length.
padTo in interface IndexedSeq<T>padTo in interface Seq<T>length - the target lengthelement - the padding elementelement so that the resulting sequence has a length of at least length.public Array<T> leftPadTo(int length, T element)
SeqNote: lazily-evaluated Seq implementations need to process all elements in order to gather the overall length.
leftPadTo in interface Seq<T>length - the target lengthelement - the padding elementelement so that the resulting sequence has a length of at least length.public Array<T> patch(int from, java.lang.Iterable<? extends T> that, int replaced)
Seqpublic Tuple2<Array<T>,Array<T>> partition(java.util.function.Predicate<? super T> predicate)
TraversableTraversable by splitting this elements in two in distinct traversables
according to a predicate.partition in interface IndexedSeq<T>partition in interface Seq<T>partition in interface Traversable<T>predicate - A predicate which classifies an element if it is in the first or the second traversable.Traversable contains all elements that satisfy the given predicate, the second Traversable contains all elements that don't. The original order of elements is preserved.public Array<T> peek(java.util.function.Consumer<? super T> action)
Valueaction on the first element if this is an eager implementation.
Performs the given action on all elements (the first immediately, successive deferred),
if this is a lazy implementation.public Array<Array<T>> permutations()
SeqExample:
[].permutations() = []
[1,2,3].permutations() = [
[1,2,3],
[1,3,2],
[2,1,3],
[2,3,1],
[3,1,2],
[3,2,1]
]
permutations in interface IndexedSeq<T>permutations in interface Seq<T>public Array<T> prepend(T element)
Seqpublic Array<T> prependAll(java.lang.Iterable<? extends T> elements)
SeqprependAll in interface IndexedSeq<T>prependAll in interface Seq<T>elements - An Iterable of elementspublic Array<T> remove(T element)
Seqpublic Array<T> removeFirst(java.util.function.Predicate<T> predicate)
SeqremoveFirst in interface IndexedSeq<T>removeFirst in interface Seq<T>predicate - an predicatepublic Array<T> removeLast(java.util.function.Predicate<T> predicate)
SeqremoveLast in interface IndexedSeq<T>removeLast in interface Seq<T>predicate - an predicatepublic Array<T> removeAt(int index)
Seqpublic Array<T> removeAll(T element)
Seqpublic Array<T> removeAll(java.lang.Iterable<? extends T> elements)
Seqpublic Array<T> replace(T currentElement, T newElement)
Traversablereplace in interface IndexedSeq<T>replace in interface Seq<T>replace in interface Traversable<T>currentElement - An element to be substituted.newElement - A replacement for currentElement.public Array<T> replaceAll(T currentElement, T newElement)
TraversablereplaceAll in interface IndexedSeq<T>replaceAll in interface Seq<T>replaceAll in interface Traversable<T>currentElement - An element to be substituted.newElement - A replacement for currentElement.public Array<T> retainAll(java.lang.Iterable<? extends T> elements)
TraversableretainAll in interface IndexedSeq<T>retainAll in interface Seq<T>retainAll in interface Traversable<T>elements - Elements to be kept.public Array<T> reverse()
Seqpublic Array<T> rotateLeft(int n)
Seq
// = List(3, 4, 5, 1, 2)
List.of(1, 2, 3, 4, 5).rotateLeft(2);
rotateLeft in interface IndexedSeq<T>rotateLeft in interface Seq<T>n - distance of left rotationpublic Array<T> rotateRight(int n)
Seq
// = List(4, 5, 1, 2, 3)
List.of(1, 2, 3, 4, 5).rotateRight(2);
rotateRight in interface IndexedSeq<T>rotateRight in interface Seq<T>n - distance of right rotationpublic Array<T> scan(T zero, java.util.function.BiFunction<? super T,? super T,? extends T> operation)
Traversablescan in interface IndexedSeq<T>scan in interface Seq<T>scan in interface Traversable<T>zero - neutral element for the operator opoperation - the associative operator for the scanpublic <U> Array<U> scanLeft(U zero, java.util.function.BiFunction<? super U,? super T,? extends U> operation)
TraversablescanLeft in interface IndexedSeq<T>scanLeft in interface Seq<T>scanLeft in interface Traversable<T>U - the type of the elements in the resulting collectionzero - the initial valueoperation - the binary operator applied to the intermediate result and the elementpublic <U> Array<U> scanRight(U zero, java.util.function.BiFunction<? super T,? super U,? extends U> operation)
TraversablescanRight in interface IndexedSeq<T>scanRight in interface Seq<T>scanRight in interface Traversable<T>U - the type of the elements in the resulting collectionzero - the initial valueoperation - the binary operator applied to the intermediate result and the elementpublic Array<T> shuffle()
Seqpublic Array<T> shuffle(java.util.Random random)
Seqpublic Array<T> slice(int beginIndex, int endIndex)
SeqbeginIndex and extends to the element at index endIndex - 1.
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 throws in some cases instead of returning a sequence.public Iterator<Array<T>> slideBy(java.util.function.Function<? super T,?> classifier)
TraversableTraversable.
Each window contains elements with the same class, as determined by classifier. Two consecutive
values in this Traversable will be in the same window only if classifier returns equal
values for them. Otherwise, the values will constitute the last element of the previous window and the
first element of the next window.
Examples:
[].slideBy(Function.identity()) = []
[1,2,3,4,4,5].slideBy(Function.identity()) = [[1],[2],[3],[4,4],[5]]
[1,2,3,10,12,5,7,20,29].slideBy(x -> x/10) = [[1,2,3],[10,12],[5,7],[20,29]]
slideBy in interface IndexedSeq<T>slideBy in interface Seq<T>slideBy in interface Traversable<T>classifier - A function which classifies elements into classespublic Iterator<Array<T>> sliding(int size)
Traversablesize and step size 1 over this Traversable by calling
Traversable.sliding(int, int).sliding in interface IndexedSeq<T>sliding in interface Seq<T>sliding in interface Traversable<T>size - a positive window sizepublic Iterator<Array<T>> sliding(int size, int step)
Traversablesize and step size over this Traversable.
Examples:
[].sliding(1,1) = []
[1,2,3,4,5].sliding(2,3) = [[1,2],[4,5]]
[1,2,3,4,5].sliding(2,4) = [[1,2],[5]]
[1,2,3,4,5].sliding(2,5) = [[1,2]]
[1,2,3,4].sliding(5,3) = [[1,2,3,4]]
sliding in interface IndexedSeq<T>sliding in interface Seq<T>sliding in interface Traversable<T>size - a positive window sizestep - a positive step sizepublic Array<T> sorted()
SeqComparable, a java.lang.ClassCastException may be thrown.public Array<T> sorted(java.util.Comparator<? super T> comparator)
SeqComparator. If this elements are not
Comparable, a java.lang.ClassCastException may be thrown.public <U extends java.lang.Comparable<? super U>> Array<T> sortBy(java.util.function.Function<? super T,? extends U> mapper)
Seqmapper.public <U> Array<T> sortBy(java.util.Comparator<? super U> comparator, java.util.function.Function<? super T,? extends U> mapper)
Seqmapper.public Tuple2<Array<T>,Array<T>> splitAt(int n)
SeqsplitAt(n) is equivalent to
Tuple.of(take(n), drop(n)).public Tuple2<Array<T>,Array<T>> splitAt(java.util.function.Predicate<? super T> predicate)
SeqPredicate, e.g. Tuple(init, element+tail).public Tuple2<Array<T>,Array<T>> splitAtInclusive(java.util.function.Predicate<? super T> predicate)
SeqPredicate, e.g. Tuple(init+element, tail).splitAtInclusive in interface Seq<T>predicate - An predicateTuple containing divided sequencespublic Tuple2<Array<T>,Array<T>> span(java.util.function.Predicate<? super T> predicate)
Traversablepredicate and the second element is the remainder.span in interface IndexedSeq<T>span in interface Seq<T>span in interface Traversable<T>predicate - A predicate.Tuple containing the longest prefix of elements that satisfy p and the remainder.public Array<T> subSequence(int beginIndex)
SeqbeginIndex and extends to the end of this Seq.
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 IndexOutOfBoundsException
See also Seq.drop(int) which is similar but does not throw.subSequence in interface IndexedSeq<T>subSequence in interface Seq<T>beginIndex - the beginning index, inclusivepublic Array<T> subSequence(int beginIndex, int endIndex)
SeqbeginIndex and extends to the element at index endIndex - 1.
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 IndexOutOfBoundsException
See also Seq.slice(int, int) which returns an empty sequence instead of throwing.subSequence in interface IndexedSeq<T>subSequence in interface Seq<T>beginIndex - the beginning index, inclusiveendIndex - the end index, exclusivepublic Array<T> tail()
Traversabletail in interface IndexedSeq<T>tail in interface Seq<T>tail in interface Traversable<T>public Option<Array<T>> tailOption()
TraversableOption.tailOption in interface IndexedSeq<T>tailOption in interface Seq<T>tailOption in interface Traversable<T>Some(traversable) or None if this is empty.public Array<T> take(int n)
Traversable
The result is equivalent to sublist(0, max(0, min(length(), n))) but does not throw if n < 0 or
n > length().
In the case of n < 0 the empty instance is returned, in the case of n > length() this is returned.
take in interface IndexedSeq<T>take in interface Seq<T>take in interface Traversable<T>n - The number of elements to take.public Array<T> takeUntil(java.util.function.Predicate<? super T> predicate)
Traversable
Note: This is essentially the same as takeWhile(predicate.negate()). It is intended to be used with
method references, which cannot be negated directly.
takeUntil in interface IndexedSeq<T>takeUntil in interface Seq<T>takeUntil in interface Traversable<T>predicate - A condition tested subsequently for this elements.public Array<T> takeWhile(java.util.function.Predicate<? super T> predicate)
TraversabletakeWhile in interface IndexedSeq<T>takeWhile in interface Seq<T>takeWhile in interface Traversable<T>predicate - A condition tested subsequently for the contained elements.public Array<T> takeRight(int n)
Traversable
The result is equivalent to sublist(max(0, min(length(), length() - n)), n), i.e. takeRight will not
throw if n < 0 or n > length().
In the case of n < 0 the empty instance is returned, in the case of n > length() this is returned.
takeRight in interface IndexedSeq<T>takeRight in interface Seq<T>takeRight in interface Traversable<T>n - The number of elements to take.public Array<T> takeRightUntil(java.util.function.Predicate<? super T> predicate)
SeqtakeRightUntil in interface IndexedSeq<T>takeRightUntil in interface Seq<T>predicate - A condition tested subsequently for this elements, starting from the end.public Array<T> takeRightWhile(java.util.function.Predicate<? super T> predicate)
Seq
Note: This is essentially the same as takeRightUntil(predicate.negate()).
It is intended to be used with method references, which cannot be negated directly.
takeRightWhile in interface IndexedSeq<T>takeRightWhile in interface Seq<T>predicate - A condition tested subsequently for this elements, starting from the end.public <U> U transform(java.util.function.Function<? super Array<T>,? extends U> f)
Array.U - Type of transformation resultf - A transformationUjava.lang.NullPointerException - if f is nullpublic Array<T> update(int index, T element)
Seqpublic Array<T> update(int index, java.util.function.Function<? super T,? extends T> updater)
Seqpublic <U> Array<Tuple2<T,U>> zip(java.lang.Iterable<? extends U> that)
Traversable
The length of the returned traversable is the minimum of the lengths of this traversable and that
iterable.
zip in interface IndexedSeq<T>zip in interface Seq<T>zip in interface Traversable<T>U - The type of the second half of the returned pairs.that - The Iterable providing the second half of each result pair.that iterable.public <U,R> Array<R> zipWith(java.lang.Iterable<? extends U> that, java.util.function.BiFunction<? super T,? super U,? extends R> mapper)
Traversable
The length of the returned traversable is the minimum of the lengths of this traversable and that
iterable.
zipWith in interface IndexedSeq<T>zipWith in interface Seq<T>zipWith in interface Traversable<T>U - The type of the second parameter of the mapper.R - The type of the mapped elements.that - The Iterable providing the second parameter of the mapper.mapper - a mapper.that iterable.public <U> Array<Tuple2<T,U>> zipAll(java.lang.Iterable<? extends U> that, T thisElem, U thatElem)
Traversable
The length of the returned traversable is the maximum of the lengths of this traversable and that
iterable.
Special case: if this traversable is shorter than that elements, and that elements contains duplicates, the resulting traversable may be shorter than the maximum of the lengths of this and that because a traversable contains an element at most once.
If this Traversable is shorter than that, thisElem values are used to fill the result. If that is shorter than this Traversable, thatElem values are used to fill the result.
zipAll in interface IndexedSeq<T>zipAll in interface Seq<T>zipAll in interface Traversable<T>U - The type of the second half of the returned pairs.that - The Iterable providing the second half of each result pair.thisElem - The element to be used to fill up the result if this traversable is shorter than that.thatElem - The element to be used to fill up the result if that is shorter than this traversable.public Array<Tuple2<T,java.lang.Integer>> zipWithIndex()
TraversablezipWithIndex in interface IndexedSeq<T>zipWithIndex in interface Seq<T>zipWithIndex in interface Traversable<T>public <U> Array<U> zipWithIndex(java.util.function.BiFunction<? super T,? super java.lang.Integer,? extends U> mapper)
TraversablezipWithIndex in interface IndexedSeq<T>zipWithIndex in interface Seq<T>zipWithIndex in interface Traversable<T>U - The type of the mapped elements.mapper - a mapper.public boolean equals(java.lang.Object o)
TraversableNotes:
public int hashCode()
Traversable
int hash = 1;
for (T t : this) { hash = hash * 31 + Objects.hashCode(t); }
Collections with arbitrary iteration order are hashed in a way such that the hash of a fixed number of elements is independent of their iteration order.
int hash = 1;
for (T t : this) { hash += Objects.hashCode(t); }
Please note that the particular hashing algorithms may change in a future version of Vavr.
public final class Hashed<K> {
private final K key;
private final Lazy<Integer> hashCode;
public Hashed(K key) {
this.key = key;
this.hashCode = Lazy.of(() -> Objects.hashCode(key));
}
public K key() {
return key;
}
@Override
public boolean equals(Object o) {
if (o == key) {
return true;
} else if (key != null && o instanceof Hashed) {
final Hashed that = (Hashed) o;
return key.equals(that.key);
} else {
return false;
}
}
@Override
public int hashCode() {
return hashCode.get();
}
@Override
public String toString() {
return "Hashed(" + (key == null ? "null" : key.toString()) + ")";
}
}
public java.lang.String stringPrefix()
ValuestringPrefix in interface Value<T>public java.lang.String toString()
ValueSee Object.toString().