Top Description Interfaces Annotations Classes
module io.vavr

Package io.vavr

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

Interface Summary

Modifier and TypeInterface and Description
public interface
CheckedConsumer<
the value type supplied to this consumer.
T>

A consumer that may throw, equivalent to java.util.function.Consumer.

pack-priv interface
CheckedConsumerModule

public interface
CheckedFunction0<
return type of the function
R>

Represents a function with no arguments.

pack-priv interface
CheckedFunction0Module

public interface
CheckedFunction1<
argument 1 of the function
T1,
return type of the function
R>

Represents a function with one argument.

pack-priv interface
CheckedFunction1Module

public interface
CheckedFunction2<
argument 1 of the function
T1,
argument 2 of the function
T2,
return type of the function
R>

Represents a function with two arguments.

pack-priv interface
CheckedFunction2Module

public interface
CheckedFunction3<
argument 1 of the function
T1,
argument 2 of the function
T2,
argument 3 of the function
T3,
return type of the function
R>

Represents a function with three arguments.

pack-priv interface
CheckedFunction3Module

public interface
CheckedFunction4<
argument 1 of the function
T1,
argument 2 of the function
T2,
argument 3 of the function
T3,
argument 4 of the function
T4,
return type of the function
R>

Represents a function with 4 arguments.

pack-priv interface
CheckedFunction4Module

public interface
CheckedFunction5<
argument 1 of the function
T1,
argument 2 of the function
T2,
argument 3 of the function
T3,
argument 4 of the function
T4,
argument 5 of the function
T5,
return type of the function
R>

Represents a function with 5 arguments.

pack-priv interface
CheckedFunction5Module

public interface
CheckedFunction6<
argument 1 of the function
T1,
argument 2 of the function
T2,
argument 3 of the function
T3,
argument 4 of the function
T4,
argument 5 of the function
T5,
argument 6 of the function
T6,
return type of the function
R>

Represents a function with 6 arguments.

pack-priv interface
CheckedFunction6Module

public interface
CheckedFunction7<
argument 1 of the function
T1,
argument 2 of the function
T2,
argument 3 of the function
T3,
argument 4 of the function
T4,
argument 5 of the function
T5,
argument 6 of the function
T6,
argument 7 of the function
T7,
return type of the function
R>

Represents a function with 7 arguments.

pack-priv interface
CheckedFunction7Module

public interface
CheckedFunction8<
argument 1 of the function
T1,
argument 2 of the function
T2,
argument 3 of the function
T3,
argument 4 of the function
T4,
argument 5 of the function
T5,
argument 6 of the function
T6,
argument 7 of the function
T7,
argument 8 of the function
T8,
return type of the function
R>

Represents a function with 8 arguments.

pack-priv interface
CheckedFunction8Module

public interface
CheckedPredicate<
the type of the input to the predicate
T>

A java.util.function.Predicate which may throw.

pack-priv interface
CheckedPredicateModule

public interface
CheckedRunnable

A Runnable which may throw.

pack-priv interface
CheckedRunnableModule

public interface
Function0<
return type of the function
R>

Represents a function with no arguments.

public interface
Function1<
argument 1 of the function
T1,
return type of the function
R>

Represents a function with one argument.

public interface
Function2<
argument 1 of the function
T1,
argument 2 of the function
T2,
return type of the function
R>

Represents a function with two arguments.

public interface
Function3<
argument 1 of the function
T1,
argument 2 of the function
T2,
argument 3 of the function
T3,
return type of the function
R>

Represents a function with three arguments.

public interface
Function4<
argument 1 of the function
T1,
argument 2 of the function
T2,
argument 3 of the function
T3,
argument 4 of the function
T4,
return type of the function
R>

Represents a function with 4 arguments.

public interface
Function5<
argument 1 of the function
T1,
argument 2 of the function
T2,
argument 3 of the function
T3,
argument 4 of the function
T4,
argument 5 of the function
T5,
return type of the function
R>

Represents a function with 5 arguments.

public interface
Function6<
argument 1 of the function
T1,
argument 2 of the function
T2,
argument 3 of the function
T3,
argument 4 of the function
T4,
argument 5 of the function
T5,
argument 6 of the function
T6,
return type of the function
R>

Represents a function with 6 arguments.

public interface
Function7<
argument 1 of the function
T1,
argument 2 of the function
T2,
argument 3 of the function
T3,
argument 4 of the function
T4,
argument 5 of the function
T5,
argument 6 of the function
T6,
argument 7 of the function
T7,
return type of the function
R>

Represents a function with 7 arguments.

public interface
Function8<
argument 1 of the function
T1,
argument 2 of the function
T2,
argument 3 of the function
T3,
argument 4 of the function
T4,
argument 5 of the function
T5,
argument 6 of the function
T6,
argument 7 of the function
T7,
argument 8 of the function
T8,
return type of the function
R>

Represents a function with 8 arguments.

pack-priv interface
Memoized

INTERNAL.

public interface
PartialFunction<
type of the function input, called domain of the function
T,
type of the function output, called codomain of the function
R>

Represents a partial function T -> R that is not necessarily defined for all input values of type T.

public interface
Tuple

The base interface of all tuples.

public interface
Value<
The type of the wrapped value.
T>

Functional programming is all about values and transformation of values using functions.

pack-priv interface
ValueModule

Annotation Summary

Modifier and TypeAnnotation and Description
pack-priv @interface
GwtIncompatible

Class Summary

Modifier and TypeClass and Description
pack-priv class
$

INTERNAL TYPE - turned to io.vavr.Patterns by vavr-match annotation processor.

public class
API

The most basic Vavr functionality is accessed through this API class.

public class
Lazy<T>

Represents a lazy evaluated value.

public class
MatchError

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

public class
NotImplementedError

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

public class
Patterns

public class
Predicates

Defines general-purpose predicates which are particularly useful when working with API.Match.

public class
Tuple0

A tuple of no elements which can be seen as cartesian product of no components.

public class
Tuple1<
type of the 1st element
T1>

A tuple of one element which can be seen as cartesian product of one component.

public class
Tuple2<
type of the 1st element
T1,
type of the 2nd element
T2>

A tuple of two elements which can be seen as cartesian product of two components.

public class
Tuple3<
type of the 1st element
T1,
type of the 2nd element
T2,
type of the 3rd element
T3>

A tuple of three elements which can be seen as cartesian product of three components.

public class
Tuple4<
type of the 1st element
T1,
type of the 2nd element
T2,
type of the 3rd element
T3,
type of the 4th element
T4>

A tuple of 4 elements which can be seen as cartesian product of 4 components.

public class
Tuple5<
type of the 1st element
T1,
type of the 2nd element
T2,
type of the 3rd element
T3,
type of the 4th element
T4,
type of the 5th element
T5>

A tuple of 5 elements which can be seen as cartesian product of 5 components.

public class
Tuple6<
type of the 1st element
T1,
type of the 2nd element
T2,
type of the 3rd element
T3,
type of the 4th element
T4,
type of the 5th element
T5,
type of the 6th element
T6>

A tuple of 6 elements which can be seen as cartesian product of 6 components.

public class
Tuple7<
type of the 1st element
T1,
type of the 2nd element
T2,
type of the 3rd element
T3,
type of the 4th element
T4,
type of the 5th element
T5,
type of the 6th element
T6,
type of the 7th element
T7>

A tuple of 7 elements which can be seen as cartesian product of 7 components.

public class
Tuple8<
type of the 1st element
T1,
type of the 2nd element
T2,
type of the 3rd element
T3,
type of the 4th element
T4,
type of the 5th element
T5,
type of the 6th element
T6,
type of the 7th element
T7,
type of the 8th element
T8>

A tuple of 8 elements which can be seen as cartesian product of 8 components.