Uses of Interface
io.vavr.collection.List

Packages that use List

Package	Description
io.vavr	Beside API the io.vavr package contains core types like (Checked)Functions and Tuples.
io.vavr.collection	Purely functional collections based on Traversable.
io.vavr.test	A property check framework built around Property which integrates well with unit test frameworks like junit.

Uses of List in io.vavr

Fields in io.vavr declared as List

Modifier and Type	Field	Description
private List<T1>	API.For1List.ts1
private List<T1>	API.For2List.ts1
private List<T1>	API.For3List.ts1
private List<T1>	API.For4List.ts1
private List<T1>	API.For5List.ts1
private List<T1>	API.For6List.ts1
private List<T1>	API.For7List.ts1
private List<T1>	API.For8List.ts1
private List<T2>	API.For2List.ts2
private List<T2>	API.For3List.ts2
private List<T2>	API.For4List.ts2
private List<T2>	API.For5List.ts2
private List<T2>	API.For6List.ts2
private List<T2>	API.For7List.ts2
private List<T2>	API.For8List.ts2
private List<T3>	API.For3List.ts3
private List<T3>	API.For4List.ts3
private List<T3>	API.For5List.ts3
private List<T3>	API.For6List.ts3
private List<T3>	API.For7List.ts3
private List<T3>	API.For8List.ts3
private List<T4>	API.For4List.ts4
private List<T4>	API.For5List.ts4
private List<T4>	API.For6List.ts4
private List<T4>	API.For7List.ts4
private List<T4>	API.For8List.ts4
private List<T5>	API.For5List.ts5
private List<T5>	API.For6List.ts5
private List<T5>	API.For7List.ts5
private List<T5>	API.For8List.ts5
private List<T6>	API.For6List.ts6
private List<T6>	API.For7List.ts6
private List<T6>	API.For8List.ts6
private List<T7>	API.For7List.ts7
private List<T7>	API.For8List.ts7
private List<T8>	API.For8List.ts8

Methods in io.vavr with type parameters of type List

Modifier and Type	Method	Description
static <T,_1 extends T,_2 extends List<T>> API.Match.Pattern2<List.Cons<T>,_1,_2>	Patterns.$Cons(API.Match.Pattern<_1,?> p1, API.Match.Pattern<_2,?> p2)

Methods in io.vavr that return List

Modifier and Type	Method	Description
static <T> List<T>	API.List()	Alias for empty()
static <T> List<T>	API.List(T element)	Alias for of(Object)
static <T> List<T>	API.List(T... elements)	Alias for of(Object...)
default List<T>	Value.toList()	Converts this to a List.
default <ID> List<Tree.Node<T>>	Value.toTree(java.util.function.Function<? super T,? extends ID> idMapper, java.util.function.Function<? super T,? extends ID> parentMapper)	Converts this to a Tree using a idMapper and parentMapper.
List<T1>	API.For1List.yield()	A shortcut for yield(Function.identity()).
<R> List<R>	API.For1List.yield(java.util.function.Function<? super T1,? extends R> f)	Yields a result for elements of the cross product of the underlying List.
<R> List<R>	API.For2List.yield(java.util.function.BiFunction<? super T1,? super T2,? extends R> f)	Yields a result for elements of the cross product of the underlying Lists.
<R> List<R>	API.For3List.yield(Function3<? super T1,? super T2,? super T3,? extends R> f)	Yields a result for elements of the cross product of the underlying Lists.
<R> List<R>	API.For4List.yield(Function4<? super T1,? super T2,? super T3,? super T4,? extends R> f)	Yields a result for elements of the cross product of the underlying Lists.
<R> List<R>	API.For5List.yield(Function5<? super T1,? super T2,? super T3,? super T4,? super T5,? extends R> f)	Yields a result for elements of the cross product of the underlying Lists.
<R> List<R>	API.For6List.yield(Function6<? super T1,? super T2,? super T3,? super T4,? super T5,? super T6,? extends R> f)	Yields a result for elements of the cross product of the underlying Lists.
<R> List<R>	API.For7List.yield(Function7<? super T1,? super T2,? super T3,? super T4,? super T5,? super T6,? super T7,? extends R> f)	Yields a result for elements of the cross product of the underlying Lists.
<R> List<R>	API.For8List.yield(Function8<? super T1,? super T2,? super T3,? super T4,? super T5,? super T6,? super T7,? super T8,? extends R> f)	Yields a result for elements of the cross product of the underlying Lists.

Methods in io.vavr that return types with arguments of type List

Modifier and Type	Method	Description
(package private) static <T> Tuple2<T,List<T>>	$.Cons(List.Cons<T> cons)

Methods in io.vavr with parameters of type List

Modifier and Type	Method	Description
static <T1> API.For1List<T1>	API.For(List<T1> ts1)	Creates a For-comprehension of one List.
static <T1,T2> API.For2List<T1,T2>	API.For(List<T1> ts1, List<T2> ts2)	Creates a For-comprehension of two Lists.
static <T1,T2,T3> API.For3List<T1,T2,T3>	API.For(List<T1> ts1, List<T2> ts2, List<T3> ts3)	Creates a For-comprehension of three Lists.
static <T1,T2,T3,T4> API.For4List<T1,T2,T3,T4>	API.For(List<T1> ts1, List<T2> ts2, List<T3> ts3, List<T4> ts4)	Creates a For-comprehension of 4 Lists.
static <T1,T2,T3,T4,T5> API.For5List<T1,T2,T3,T4,T5>	API.For(List<T1> ts1, List<T2> ts2, List<T3> ts3, List<T4> ts4, List<T5> ts5)	Creates a For-comprehension of 5 Lists.
static <T1,T2,T3,T4,T5,T6> API.For6List<T1,T2,T3,T4,T5,T6>	API.For(List<T1> ts1, List<T2> ts2, List<T3> ts3, List<T4> ts4, List<T5> ts5, List<T6> ts6)	Creates a For-comprehension of 6 Lists.
static <T1,T2,T3,T4,T5,T6,T7> API.For7List<T1,T2,T3,T4,T5,T6,T7>	API.For(List<T1> ts1, List<T2> ts2, List<T3> ts3, List<T4> ts4, List<T5> ts5, List<T6> ts6, List<T7> ts7)	Creates a For-comprehension of 7 Lists.
static <T1,T2,T3,T4,T5,T6,T7,T8> API.For8List<T1,T2,T3,T4,T5,T6,T7,T8>	API.For(List<T1> ts1, List<T2> ts2, List<T3> ts3, List<T4> ts4, List<T5> ts5, List<T6> ts6, List<T7> ts7, List<T8> ts8)	Creates a For-comprehension of 8 Lists.

Constructors in io.vavr with parameters of type List

Constructor	Description
For1List(List<T1> ts1)
For2List(List<T1> ts1, List<T2> ts2)
For3List(List<T1> ts1, List<T2> ts2, List<T3> ts3)
For4List(List<T1> ts1, List<T2> ts2, List<T3> ts3, List<T4> ts4)
For5List(List<T1> ts1, List<T2> ts2, List<T3> ts3, List<T4> ts4, List<T5> ts5)
For6List(List<T1> ts1, List<T2> ts2, List<T3> ts3, List<T4> ts4, List<T5> ts5, List<T6> ts6)
For7List(List<T1> ts1, List<T2> ts2, List<T3> ts3, List<T4> ts4, List<T5> ts5, List<T6> ts6, List<T7> ts7)
For8List(List<T1> ts1, List<T2> ts2, List<T3> ts3, List<T4> ts4, List<T5> ts5, List<T6> ts6, List<T7> ts7, List<T8> ts8)

Uses of List in io.vavr.collection

Classes in io.vavr.collection that implement List

Modifier and Type	Class	Description
static class	List.Cons<T>	Non-empty List, consisting of a head and a tail.
static class	List.Nil<T>	Representation of the singleton empty List.

Fields in io.vavr.collection declared as List

Modifier and Type	Field	Description
private List<Tree.Node<T>>	Tree.Node.children
private List<T>	Queue.front
private List<T>	Queue.rear
private List<T>	List.Cons.tail

Methods in io.vavr.collection that return List

Modifier and Type	Method	Description
default List<T>	List.append(T element)
default List<T>	List.appendAll(java.lang.Iterable<? extends T> elements)
static <T> List<List<T>>	ListModule.Combinations.apply(List<T> elements, int k)
default List<T>	List.asJava(java.util.function.Consumer<? super java.util.List<T>> action)
default List<T>	List.asJavaMutable(java.util.function.Consumer<? super java.util.List<T>> action)
static <T,ID> List<Tree.Node<T>>	Tree.build(java.lang.Iterable<? extends T> source, java.util.function.Function<? super T,? extends ID> idMapper, java.util.function.Function<? super T,? extends ID> parentMapper)	Build a List with roots of Tree from flat source.
default <R> List<R>	List.collect(PartialFunction<? super T,? extends R> partialFunction)
default List<List<T>>	List.combinations()
default List<List<T>>	List.combinations(int k)
default List<T>	List.distinct()
default List<T>	List.distinctBy(java.util.Comparator<? super T> comparator)
default <U> List<T>	List.distinctBy(java.util.function.Function<? super T,? extends U> keyExtractor)
default List<T>	List.drop(int n)
default List<T>	List.dropRight(int n)
default List<T>	List.dropRightUntil(java.util.function.Predicate<? super T> predicate)
default List<T>	List.dropRightWhile(java.util.function.Predicate<? super T> predicate)
default List<T>	List.dropUntil(java.util.function.Predicate<? super T> predicate)
default List<T>	List.dropWhile(java.util.function.Predicate<? super T> predicate)
static <T> List<T>	List.empty()	Returns the single instance of Nil.
static <T> List<T>	List.fill(int n, java.util.function.Supplier<? extends T> s)	Returns a List containing n values supplied by a given Supplier s.
static <T> List<T>	List.fill(int n, T element)	Returns a List containing n times the given element
default List<T>	List.filter(java.util.function.Predicate<? super T> predicate)
default <U> List<U>	List.flatMap(java.util.function.Function<? super T,? extends java.lang.Iterable<? extends U>> mapper)
List<Tree.Node<T>>	Tree.Empty.getChildren()
List<Tree.Node<T>>	Tree.getChildren()	Returns the children of this tree.
List<Tree.Node<T>>	Tree.Node.getChildren()
default List<T>	List.init()
default List<T>	List.insert(int index, T element)
default List<T>	List.insertAll(int index, java.lang.Iterable<? extends T> elements)
default List<T>	List.intersperse(T element)
default List<T>	List.leftPadTo(int length, T element)
default <U> List<U>	List.map(java.util.function.Function<? super T,? extends U> mapper)
static <T> List<T>	List.narrow(List<? extends T> list)	Narrows a widened List<? extends T> to List<T> by performing a type-safe cast.
static <T> List<T>	List.of(T element)	Returns a singleton List, i.e.
static <T> List<T>	List.of(T... elements)	Creates a List of the given elements.
static List<java.lang.Boolean>	List.ofAll(boolean... elements)	Creates a List from boolean values.
static List<java.lang.Byte>	List.ofAll(byte... elements)	Creates a List from byte values.
static List<java.lang.Character>	List.ofAll(char... elements)	Creates a List from char values.
static List<java.lang.Double>	List.ofAll(double... elements)	Creates a List from double values.
static List<java.lang.Float>	List.ofAll(float... elements)	Creates a List from float values.
static List<java.lang.Integer>	List.ofAll(int... elements)	Creates a List from int values.
static List<java.lang.Long>	List.ofAll(long... elements)	Creates a List from long values.
static List<java.lang.Short>	List.ofAll(short... elements)	Creates a List from short values.
static <T> List<T>	List.ofAll(java.lang.Iterable<? extends T> elements)	Creates a List of the given elements.
static <T> List<T>	List.ofAll(java.util.stream.Stream<? extends T> javaStream)	Creates a List that contains the elements of the given Stream.
default List<T>	List.orElse(java.lang.Iterable<? extends T> other)
default List<T>	List.orElse(java.util.function.Supplier<? extends java.lang.Iterable<? extends T>> supplier)
default List<T>	List.padTo(int length, T element)
default List<T>	List.patch(int from, java.lang.Iterable<? extends T> that, int replaced)
default List<T>	List.peek(java.util.function.Consumer<? super T> action)	Performs an action on the head element of this List.
default List<List<T>>	List.permutations()
default List<T>	List.pop()	Removes the head element from this List.
default List<T>	List.prepend(T element)
default List<T>	List.prependAll(java.lang.Iterable<? extends T> elements)
default List<T>	List.push(T element)	Pushes a new element on top of this List.
default List<T>	List.push(T... elements)	Pushes the given elements on top of this List.
default List<T>	List.pushAll(java.lang.Iterable<T> elements)	Pushes the given elements on top of this List.
static List<java.lang.Character>	List.range(char from, char toExclusive)
static List<java.lang.Integer>	List.range(int from, int toExclusive)	Creates a List of int numbers starting from from, extending to toExclusive - 1.
static List<java.lang.Long>	List.range(long from, long toExclusive)	Creates a List of long numbers starting from from, extending to toExclusive - 1.
static List<java.lang.Character>	List.rangeBy(char from, char toExclusive, int step)
static List<java.lang.Double>	List.rangeBy(double from, double toExclusive, double step)
static List<java.lang.Integer>	List.rangeBy(int from, int toExclusive, int step)	Creates a List of int numbers starting from from, extending to toExclusive - 1, with step.
static List<java.lang.Long>	List.rangeBy(long from, long toExclusive, long step)	Creates a List of long numbers starting from from, extending to toExclusive - 1, with step.
static List<java.lang.Character>	List.rangeClosed(char from, char toInclusive)
static List<java.lang.Integer>	List.rangeClosed(int from, int toInclusive)	Creates a List of int numbers starting from from, extending to toInclusive.
static List<java.lang.Long>	List.rangeClosed(long from, long toInclusive)	Creates a List of long numbers starting from from, extending to toInclusive.
static List<java.lang.Character>	List.rangeClosedBy(char from, char toInclusive, int step)
static List<java.lang.Double>	List.rangeClosedBy(double from, double toInclusive, double step)
static List<java.lang.Integer>	List.rangeClosedBy(int from, int toInclusive, int step)	Creates a List of int numbers starting from from, extending to toInclusive, with step.
static List<java.lang.Long>	List.rangeClosedBy(long from, long toInclusive, long step)	Creates a List of long numbers starting from from, extending to toInclusive, with step.
default List<T>	List.reject(java.util.function.Predicate<? super T> predicate)
default List<T>	List.remove(T element)
default List<T>	List.removeAll(java.lang.Iterable<? extends T> elements)
default List<T>	List.removeAll(java.util.function.Predicate<? super T> predicate)	Deprecated.
default List<T>	List.removeAll(T element)
default List<T>	List.removeAt(int index)
default List<T>	List.removeFirst(java.util.function.Predicate<T> predicate)
default List<T>	List.removeLast(java.util.function.Predicate<T> predicate)
default List<T>	List.replace(T currentElement, T newElement)
default List<T>	List.replaceAll(T currentElement, T newElement)
default List<T>	List.retainAll(java.lang.Iterable<? extends T> elements)
default List<T>	List.reverse()
default List<T>	List.rotateLeft(int n)
default List<T>	List.rotateRight(int n)
default List<T>	List.scan(T zero, java.util.function.BiFunction<? super T,? super T,? extends T> operation)
default <U> List<U>	List.scanLeft(U zero, java.util.function.BiFunction<? super U,? super T,? extends U> operation)
default <U> List<U>	List.scanRight(U zero, java.util.function.BiFunction<? super T,? super U,? extends U> operation)
default List<T>	List.shuffle()
default List<T>	List.slice(int beginIndex, int endIndex)
default <U> List<T>	List.sortBy(java.util.Comparator<? super U> comparator, java.util.function.Function<? super T,? extends U> mapper)
default <U extends java.lang.Comparable<? super U>> List<T>	List.sortBy(java.util.function.Function<? super T,? extends U> mapper)
default List<T>	List.sorted()
default List<T>	List.sorted(java.util.Comparator<? super T> comparator)
default List<T>	List.subSequence(int beginIndex)
default List<T>	List.subSequence(int beginIndex, int endIndex)
static <T> List<T>	List.tabulate(int n, java.util.function.Function<? super java.lang.Integer,? extends T> f)	Returns a List containing n values of a given Function f over a range of integer values from 0 to n - 1.
List<T>	List.Cons.tail()
List<T>	List.Nil.tail()
List<T>	List.tail()
default List<T>	List.take(int n)
default List<T>	List.takeRight(int n)
default List<T>	List.takeRightUntil(java.util.function.Predicate<? super T> predicate)
default List<T>	List.takeRightWhile(java.util.function.Predicate<? super T> predicate)
default List<T>	List.takeUntil(java.util.function.Predicate<? super T> predicate)
default List<T>	List.takeWhile(java.util.function.Predicate<? super T> predicate)
List<T>	PriorityQueue.toList()
static <T> List<List<T>>	List.transpose(List<List<T>> matrix)	Transposes the rows and columns of a List matrix.
static <T> List<T>	List.unfold(T seed, java.util.function.Function<? super T,Option<Tuple2<? extends T,? extends T>>> f)	Creates a list from a seed value and a function.
static <T,U> List<U>	List.unfoldLeft(T seed, java.util.function.Function<? super T,Option<Tuple2<? extends T,? extends U>>> f)	Creates a list from a seed value and a function.
static <T,U> List<U>	List.unfoldRight(T seed, java.util.function.Function<? super T,Option<Tuple2<? extends U,? extends T>>> f)	Creates a list from a seed value and a function.
default List<T>	List.update(int index, java.util.function.Function<? super T,? extends T> updater)
default List<T>	List.update(int index, T element)
default <U> List<Tuple2<T,U>>	List.zip(java.lang.Iterable<? extends U> that)
default <U> List<Tuple2<T,U>>	List.zipAll(java.lang.Iterable<? extends U> that, T thisElem, U thatElem)
default <U,R> List<R>	List.zipWith(java.lang.Iterable<? extends U> that, java.util.function.BiFunction<? super T,? super U,? extends R> mapper)
default List<Tuple2<T,java.lang.Integer>>	List.zipWithIndex()
default <U> List<U>	List.zipWithIndex(java.util.function.BiFunction<? super T,? super java.lang.Integer,? extends U> mapper)

Methods in io.vavr.collection that return types with arguments of type List

Modifier and Type	Method	Description
static <T> List<List<T>>	ListModule.Combinations.apply(List<T> elements, int k)
static <T> java.util.stream.Collector<T,java.util.ArrayList<T>,List<T>>	List.collector()	Returns a Collector which may be used in conjunction with Stream.collect(java.util.stream.Collector) to obtain a List.
default List<List<T>>	List.combinations()
default List<List<T>>	List.combinations(int k)
default Iterator<List<T>>	List.crossProduct(int power)
default <C> Map<C,List<T>>	List.groupBy(java.util.function.Function<? super T,? extends C> classifier)
default Iterator<List<T>>	List.grouped(int size)
default Option<List<T>>	List.initOption()
default Tuple2<List<T>,List<T>>	List.partition(java.util.function.Predicate<? super T> predicate)
default Tuple2<List<T>,List<T>>	List.partition(java.util.function.Predicate<? super T> predicate)
default List<List<T>>	List.permutations()
default Tuple2<T,List<T>>	List.pop2()	Removes the head element from this List.
default Option<Tuple2<T,List<T>>>	List.pop2Option()	Removes the head element from this List.
default Option<List<T>>	List.popOption()	Removes the head element from this List.
default Iterator<List<T>>	List.slideBy(java.util.function.Function<? super T,?> classifier)
default Iterator<List<T>>	List.sliding(int size)
default Iterator<List<T>>	List.sliding(int size, int step)
default Tuple2<List<T>,List<T>>	List.span(java.util.function.Predicate<? super T> predicate)
default Tuple2<List<T>,List<T>>	List.span(java.util.function.Predicate<? super T> predicate)
default Tuple2<List<T>,List<T>>	List.splitAt(int n)
default Tuple2<List<T>,List<T>>	List.splitAt(int n)
default Tuple2<List<T>,List<T>>	List.splitAt(java.util.function.Predicate<? super T> predicate)
default Tuple2<List<T>,List<T>>	List.splitAt(java.util.function.Predicate<? super T> predicate)
default Tuple2<List<T>,List<T>>	List.splitAtInclusive(java.util.function.Predicate<? super T> predicate)
default Tuple2<List<T>,List<T>>	List.splitAtInclusive(java.util.function.Predicate<? super T> predicate)
static <T> Tuple2<List<T>,List<T>>	ListModule.SplitAt.splitByPredicateReversed(List<T> source, java.util.function.Predicate<? super T> predicate)
static <T> Tuple2<List<T>,List<T>>	ListModule.SplitAt.splitByPredicateReversed(List<T> source, java.util.function.Predicate<? super T> predicate)
default Option<List<T>>	List.tailOption()
static <T> List<List<T>>	List.transpose(List<List<T>> matrix)	Transposes the rows and columns of a List matrix.
default <T1,T2> Tuple2<List<T1>,List<T2>>	List.unzip(java.util.function.Function<? super T,Tuple2<? extends T1,? extends T2>> unzipper)
default <T1,T2> Tuple2<List<T1>,List<T2>>	List.unzip(java.util.function.Function<? super T,Tuple2<? extends T1,? extends T2>> unzipper)
default <T1,T2,T3> Tuple3<List<T1>,List<T2>,List<T3>>	List.unzip3(java.util.function.Function<? super T,Tuple3<? extends T1,? extends T2,? extends T3>> unzipper)
default <T1,T2,T3> Tuple3<List<T1>,List<T2>,List<T3>>	List.unzip3(java.util.function.Function<? super T,Tuple3<? extends T1,? extends T2,? extends T3>> unzipper)
default <T1,T2,T3> Tuple3<List<T1>,List<T2>,List<T3>>	List.unzip3(java.util.function.Function<? super T,Tuple3<? extends T1,? extends T2,? extends T3>> unzipper)

Methods in io.vavr.collection with parameters of type List

Modifier and Type	Method	Description
static <T> List<List<T>>	ListModule.Combinations.apply(List<T> elements, int k)
static <T> Stream<T>	StreamModule.DropRight.apply(List<T> front, List<T> rear, Stream<T> remaining)
static <T> List<T>	List.narrow(List<? extends T> list)	Narrows a widened List<? extends T> to List<T> by performing a type-safe cast.
static <T> Tuple2<List<T>,List<T>>	ListModule.SplitAt.splitByPredicateReversed(List<T> source, java.util.function.Predicate<? super T> predicate)
static <T> List<List<T>>	List.transpose(List<List<T>> matrix)	Transposes the rows and columns of a List matrix.

Method parameters in io.vavr.collection with type arguments of type List

Modifier and Type	Method	Description
default <U> U	List.transform(java.util.function.Function<? super List<T>,? extends U> f)	Transforms this List.
static <T> List<List<T>>	List.transpose(List<List<T>> matrix)	Transposes the rows and columns of a List matrix.

Constructors in io.vavr.collection with parameters of type List

Constructor	Description
Cons(T head, List<T> tail)	Creates a List consisting of a head value and a trailing List.
Node(T value, List<Tree.Node<T>> children)	Constructs a rose tree branch.
Queue(List<T> front, List<T> rear)	Creates a Queue consisting of a front List and a rear List.

Uses of List in io.vavr.test

Methods in io.vavr.test that return types with arguments of type List

Modifier and Type	Method	Description
static <T> Arbitrary<List<T>>	Arbitrary.list(Arbitrary<T> arbitraryT)	Generates arbitrary lists based on a given element generator arbitraryT.