Package io.vavr

Beside API the io.vavr package contains core types like (Checked)Functions and Tuples.

Interface Summary

Interface	Description
API.Match.Case<T,R>
API.Match.Pattern<T,R>	A Pattern is a partial Function in the sense that a function applications returns an optional result of type Option<R>.
CheckedConsumer<T>	A consumer that may throw, equivalent to Consumer.
CheckedFunction0<R>	Represents a function with no arguments.
CheckedFunction1<T1,R>	Represents a function with one argument.
CheckedFunction2<T1,T2,R>	Represents a function with two arguments.
CheckedFunction3<T1,T2,T3,R>	Represents a function with three arguments.
CheckedFunction4<T1,T2,T3,T4,R>	Represents a function with 4 arguments.
CheckedFunction5<T1,T2,T3,T4,T5,R>	Represents a function with 5 arguments.
CheckedFunction6<T1,T2,T3,T4,T5,T6,R>	Represents a function with 6 arguments.
CheckedFunction7<T1,T2,T3,T4,T5,T6,T7,R>	Represents a function with 7 arguments.
CheckedFunction8<T1,T2,T3,T4,T5,T6,T7,T8,R>	Represents a function with 8 arguments.
CheckedPredicate<T>	A Predicate which may throw.
CheckedRunnable	A Runnable which may throw.
Function0<R>	Represents a function with no arguments.
Function1<T1,R>	Represents a function with one argument.
Function2<T1,T2,R>	Represents a function with two arguments.
Function3<T1,T2,T3,R>	Represents a function with three arguments.
Function4<T1,T2,T3,T4,R>	Represents a function with 4 arguments.
Function5<T1,T2,T3,T4,T5,R>	Represents a function with 5 arguments.
Function6<T1,T2,T3,T4,T5,T6,R>	Represents a function with 6 arguments.
Function7<T1,T2,T3,T4,T5,T6,T7,R>	Represents a function with 7 arguments.
Function8<T1,T2,T3,T4,T5,T6,T7,T8,R>	Represents a function with 8 arguments.
Iterable<T>	Extension of the well-known Java Iterable in the sense that a rich Vavr Iterator is returned by Iterable.iterator().
PartialFunction<T,R>	Represents a partial function T -> R that is not necessarily defined for all input values of type T.
Tuple	The base interface of all tuples.
Value<T>	Deprecated. Superseded by io.vavr.Iterable

Class Summary

Class	Description
API	The most basic Vavr functionality is accessed through this API class.
API.For1<T1>	For-comprehension with one Iterable.
API.For1Either<L,T1>	For-comprehension with one Either.
API.For1Future<T1>	For-comprehension with one Future.
API.For1List<T1>	For-comprehension with one List.
API.For1Option<T1>	For-comprehension with one Option.
API.For1Try<T1>	For-comprehension with one Try.
API.For2<T1,T2>	For-comprehension with two Iterables.
API.For2Either<L,T1,T2>	For-comprehension with two Eithers.
API.For2Future<T1,T2>	For-comprehension with two Futures.
API.For2List<T1,T2>	For-comprehension with two Lists.
API.For2Option<T1,T2>	For-comprehension with two Options.
API.For2Try<T1,T2>	For-comprehension with two Trys.
API.For3<T1,T2,T3>	For-comprehension with three Iterables.
API.For3Either<L,T1,T2,T3>	For-comprehension with three Eithers.
API.For3Future<T1,T2,T3>	For-comprehension with three Futures.
API.For3List<T1,T2,T3>	For-comprehension with three Lists.
API.For3Option<T1,T2,T3>	For-comprehension with three Options.
API.For3Try<T1,T2,T3>	For-comprehension with three Trys.
API.For4<T1,T2,T3,T4>	For-comprehension with 4 Iterables.
API.For4Either<L,T1,T2,T3,T4>	For-comprehension with 4 Eithers.
API.For4Future<T1,T2,T3,T4>	For-comprehension with 4 Futures.
API.For4List<T1,T2,T3,T4>	For-comprehension with 4 Lists.
API.For4Option<T1,T2,T3,T4>	For-comprehension with 4 Options.
API.For4Try<T1,T2,T3,T4>	For-comprehension with 4 Trys.
API.For5<T1,T2,T3,T4,T5>	For-comprehension with 5 Iterables.
API.For5Either<L,T1,T2,T3,T4,T5>	For-comprehension with 5 Eithers.
API.For5Future<T1,T2,T3,T4,T5>	For-comprehension with 5 Futures.
API.For5List<T1,T2,T3,T4,T5>	For-comprehension with 5 Lists.
API.For5Option<T1,T2,T3,T4,T5>	For-comprehension with 5 Options.
API.For5Try<T1,T2,T3,T4,T5>	For-comprehension with 5 Trys.
API.For6<T1,T2,T3,T4,T5,T6>	For-comprehension with 6 Iterables.
API.For6Either<L,T1,T2,T3,T4,T5,T6>	For-comprehension with 6 Eithers.
API.For6Future<T1,T2,T3,T4,T5,T6>	For-comprehension with 6 Futures.
API.For6List<T1,T2,T3,T4,T5,T6>	For-comprehension with 6 Lists.
API.For6Option<T1,T2,T3,T4,T5,T6>	For-comprehension with 6 Options.
API.For6Try<T1,T2,T3,T4,T5,T6>	For-comprehension with 6 Trys.
API.For7<T1,T2,T3,T4,T5,T6,T7>	For-comprehension with 7 Iterables.
API.For7Either<L,T1,T2,T3,T4,T5,T6,T7>	For-comprehension with 7 Eithers.
API.For7Future<T1,T2,T3,T4,T5,T6,T7>	For-comprehension with 7 Futures.
API.For7List<T1,T2,T3,T4,T5,T6,T7>	For-comprehension with 7 Lists.
API.For7Option<T1,T2,T3,T4,T5,T6,T7>	For-comprehension with 7 Options.
API.For7Try<T1,T2,T3,T4,T5,T6,T7>	For-comprehension with 7 Trys.
API.For8<T1,T2,T3,T4,T5,T6,T7,T8>	For-comprehension with 8 Iterables.
API.For8Either<L,T1,T2,T3,T4,T5,T6,T7,T8>	For-comprehension with 8 Eithers.
API.For8Future<T1,T2,T3,T4,T5,T6,T7,T8>	For-comprehension with 8 Futures.
API.For8List<T1,T2,T3,T4,T5,T6,T7,T8>	For-comprehension with 8 Lists.
API.For8Option<T1,T2,T3,T4,T5,T6,T7,T8>	For-comprehension with 8 Options.
API.For8Try<T1,T2,T3,T4,T5,T6,T7,T8>	For-comprehension with 8 Trys.
API.Match<T>	Scala-like structural pattern matching for Java.
API.Match.Case0<T,R>
API.Match.Case1<T,T1,R>
API.Match.Case2<T,T1,T2,R>
API.Match.Case3<T,T1,T2,T3,R>
API.Match.Case4<T,T1,T2,T3,T4,R>
API.Match.Case5<T,T1,T2,T3,T4,T5,R>
API.Match.Case6<T,T1,T2,T3,T4,T5,T6,R>
API.Match.Case7<T,T1,T2,T3,T4,T5,T6,T7,R>
API.Match.Case8<T,T1,T2,T3,T4,T5,T6,T7,T8,R>
API.Match.Pattern0<T>
API.Match.Pattern1<T,T1>
API.Match.Pattern2<T,T1,T2>
API.Match.Pattern3<T,T1,T2,T3>
API.Match.Pattern4<T,T1,T2,T3,T4>
API.Match.Pattern5<T,T1,T2,T3,T4,T5>
API.Match.Pattern6<T,T1,T2,T3,T4,T5,T6>
API.Match.Pattern7<T,T1,T2,T3,T4,T5,T6,T7>
API.Match.Pattern8<T,T1,T2,T3,T4,T5,T6,T7,T8>
Lazy<T>	Represents a lazy evaluated value.
Patterns	Deprecated. Will be removed in the next major version, along with VAVR's pattern matching, in favor of Java's native pattern matching.
Predicates	Defines general-purpose predicates which are particularly useful when working with API.Match.
Tuple0	A tuple of no elements which can be seen as cartesian product of no components.
Tuple1<T1>	A tuple of one element which can be seen as cartesian product of one component.
Tuple2<T1,T2>	A tuple of two elements which can be seen as cartesian product of two components.
Tuple3<T1,T2,T3>	A tuple of three elements which can be seen as cartesian product of three components.
Tuple4<T1,T2,T3,T4>	A tuple of 4 elements which can be seen as cartesian product of 4 components.
Tuple5<T1,T2,T3,T4,T5>	A tuple of 5 elements which can be seen as cartesian product of 5 components.
Tuple6<T1,T2,T3,T4,T5,T6>	A tuple of 6 elements which can be seen as cartesian product of 6 components.
Tuple7<T1,T2,T3,T4,T5,T6,T7>	A tuple of 7 elements which can be seen as cartesian product of 7 components.
Tuple8<T1,T2,T3,T4,T5,T6,T7,T8>	A tuple of 8 elements which can be seen as cartesian product of 8 components.

Exception Summary

Exception	Description
MatchError	A API.Match throws a MatchError if no case matches the applied object.

Error Summary

Error	Description
NotImplementedError	This exception is temporarily used during development in order to indicate that an implementation is missing.