Vavr 0.10.6 · io.vavr.Function2 · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
public static final long	serialVersionUID The serial version uid.

Method Summary

Modifier and Type	Method and Description
public default < return type of after V> Function2<T1, T2, V>	Returns: a function composed of this and after andThen(Function<? super R, ? extends V> the function applied after this after) Overrides default java.util.function.BiFunction.andThen. Returns a composed function that first applies this Function2 to the given argument and then applies Function `after` to the result.
public R	Returns: the result of function application apply(T1 argument 1 t1, T2 argument 2 t2) Redeclares java.util.function.BiFunction.apply. Applies this function to two arguments and returns the result.
public default Function1<T2, R>	Returns: a partial application of this function apply(T1 argument 1 t1) Applies this function partially to one argument.
public default int	Returns: an int value >= 0 arity() Returns the number of function arguments.
public static < generic parameter type 1 of the resulting function T1, generic parameter type 2 of the resulting function T2, the result type R> Function2<T1, T2, R>	Returns: a function always returning the given value constant(R the value to be returned value) Returns a function that always returns the constant value that you give in parameter.
public default Function1<T1, Function1<T2, R>>	Returns: a curried function equivalent to this. curried() Returns a curried version of this function.
public default boolean	Returns: true, if this function is memoizing, false otherwise isMemoized() Checks if this function is memoizing (= caching) computed values.
public static < 1st argument T1, 2nd argument T2, return type R> Function2<T1, T2, Option<R>>	Returns: a function that applies arguments to the given `partialFunction` and returns `Some(result)` if the function is defined for the given arguments, and `None` otherwise. lift(BiFunction<? super T1, ? super T2, ? extends R> a function that is not defined for all values of the domain (e.g. by throwing) partialFunction) Lifts the given `partialFunction` into a total function that returns an `Option` result.
public static < 1st argument T1, 2nd argument T2, return type R> Function2<T1, T2, Try<R>>	Returns: a function that applies arguments to the given `partialFunction` and returns `Success(result)` if the function is defined for the given arguments, and `Failure(throwable)` otherwise. liftTry(BiFunction<? super T1, ? super T2, ? extends R> a function that is not defined for all values of the domain (e.g. by throwing) partialFunction) Lifts the given `partialFunction` into a total function that returns an `Try` result.
public default Function2<T1, T2, R>	Returns: a memoizing function equivalent to this. memoized() Returns a memoizing version of this function, which computes the return value for given arguments only one time.
public static < 1st argument T1, 2nd argument T2, return type R> Function2<T1, T2, R>	Returns: the given `f` instance as narrowed type `Function2<T1, T2, R>` narrow(Function2<? super T1, ? super T2, ? extends R> A `Function2` f) Narrows the given `Function2<?`
public static < 1st argument T1, 2nd argument T2, return type R> Function2<T1, T2, R>	Returns: a `Function2` of(Function2<T1, T2, R> (typically) a method reference, e.g. `Type::method` methodReference) Creates a `Function2` based on method reference lambda expression
public default Function2<T2, T1, R>	Returns: a reversed function equivalent to this. reversed() Returns a reversed version of this function.
public default Function1<Tuple2<T1, T2>, R>	Returns: a tupled function equivalent to this. tupled() Returns a tupled version of this function.

serialVersionUID	back to summary
public static final long serialVersionUID The serial version uid.

Method Detail

andThen back to summary

andThen	back to summary
public default <V> Function2<T1, T2, V> andThen(Function<? super R, ? extends V> after) Overrides default java.util.function.BiFunction.andThen. Returns a composed function that first applies this Function2 to the given argument and then applies Function `after` to the result. Parameters <V> return type of after after:Function<? super R, ? extends V> the function applied after this Returns:Function2<T1, T2, V> a function composed of this and after Exceptions NullPointerException: if after is null

public default <V> Function2<T1, T2, V> andThen(Function<? super R, ? extends V> after)

Overrides default java.util.function.BiFunction.andThen.

Returns a composed function that first applies this Function2 to the given argument and then applies Function after to the result.

Parameters

<V>: return type of after
after:Function<? super R, ? extends V>: the function applied after this

Returns:Function2<T1, T2, V>

a function composed of this and after

Exceptions

NullPointerException:: if after is null

apply	back to summary
public R apply(T1 t1, T2 t2) Redeclares java.util.function.BiFunction.apply. Applies this function to two arguments and returns the result. Parameters t1:T1 argument 1 t2:T2 argument 2 Returns:R the result of function application

apply

back to summary

public R apply(T1 t1, T2 t2)

Redeclares java.util.function.BiFunction.apply.

Applies this function to two arguments and returns the result.

Parameters

t1:T1: argument 1
t2:T2: argument 2

Returns:R

the result of function application

apply	back to summary
public default Function1<T2, R> apply(T1 t1) Applies this function partially to one argument. Parameters t1:T1 argument 1 Returns:Function1<T2, R> a partial application of this function

apply

back to summary

public default Function1<T2, R> apply(T1 t1)

Applies this function partially to one argument.

Parameters

t1:T1: argument 1

Returns:Function1<T2, R>

a partial application of this function

arity	back to summary
public default int arity() Returns the number of function arguments. Returns:int an int value >= 0 See Also Arity

arity

back to summary

public default int arity()

Returns the number of function arguments.

Returns:int: an int value >= 0
See Also: Arity

constant	back to summary
public static <T1, T2, R> Function2<T1, T2, R> constant(R value) Returns a function that always returns the constant value that you give in parameter. Parameters <T1> generic parameter type 1 of the resulting function <T2> generic parameter type 2 of the resulting function <R> the result type value:R the value to be returned Returns:Function2<T1, T2, R> a function always returning the given value

constant

back to summary

public static <T1, T2, R> Function2<T1, T2, R> constant(R value)

Returns a function that always returns the constant value that you give in parameter.

Parameters

<T1>: generic parameter type 1 of the resulting function
<T2>: generic parameter type 2 of the resulting function
<R>: the result type
value:R: the value to be returned

Returns:Function2<T1, T2, R>

a function always returning the given value

curried	back to summary
public default Function1<T1, Function1<T2, R>> curried() Returns a curried version of this function. Returns:Function1<T1, Function1<T2, R>> a curried function equivalent to this.

curried

back to summary

public default Function1<T1, Function1<T2, R>> curried()

Returns a curried version of this function.

Returns:Function1<T1, Function1<T2, R>>: a curried function equivalent to this.

isMemoized	back to summary
public default boolean isMemoized() Checks if this function is memoizing (= caching) computed values. Returns:boolean true, if this function is memoizing, false otherwise

isMemoized

back to summary

public default boolean isMemoized()

Checks if this function is memoizing (= caching) computed values.

Returns:boolean: true, if this function is memoizing, false otherwise

lift back to summary

lift	back to summary
public static <T1, T2, R> Function2<T1, T2, Option<R>> lift(BiFunction<? super T1, ? super T2, ? extends R> partialFunction) Lifts the given `partialFunction` into a total function that returns an `Option` result. Parameters <T1> 1st argument <T2> 2nd argument <R> return type partialFunction:BiFunction<? super T1, ? super T2, ? extends R> a function that is not defined for all values of the domain (e.g. by throwing) Returns:Function2<T1, T2, Option<R>> a function that applies arguments to the given `partialFunction` and returns `Some(result)` if the function is defined for the given arguments, and `None` otherwise. Annotations @SuppressWarnings:RedundantTypeArguments

public static <T1, T2, R> Function2<T1, T2, Option<R>> lift(BiFunction<? super T1, ? super T2, ? extends R> partialFunction)

Lifts the given partialFunction into a total function that returns an Option result.

Parameters

<T1>: 1st argument
<T2>: 2nd argument
<R>: return type
partialFunction:BiFunction<? super T1, ? super T2, ? extends R>: a function that is not defined for all values of the domain (e.g. by throwing)

Returns:Function2<T1, T2, Option<R>>

a function that applies arguments to the given partialFunction and returns Some(result) if the function is defined for the given arguments, and None otherwise.

Annotations

@SuppressWarnings:RedundantTypeArguments

liftTry back to summary

liftTry	back to summary
public static <T1, T2, R> Function2<T1, T2, Try<R>> liftTry(BiFunction<? super T1, ? super T2, ? extends R> partialFunction) Lifts the given `partialFunction` into a total function that returns an `Try` result. Parameters <T1> 1st argument <T2> 2nd argument <R> return type partialFunction:BiFunction<? super T1, ? super T2, ? extends R> a function that is not defined for all values of the domain (e.g. by throwing) Returns:Function2<T1, T2, Try<R>> a function that applies arguments to the given `partialFunction` and returns `Success(result)` if the function is defined for the given arguments, and `Failure(throwable)` otherwise.

public static <T1, T2, R> Function2<T1, T2, Try<R>> liftTry(BiFunction<? super T1, ? super T2, ? extends R> partialFunction)

Lifts the given partialFunction into a total function that returns an Try result.

Parameters

<T1>: 1st argument
<T2>: 2nd argument
<R>: return type
partialFunction:BiFunction<? super T1, ? super T2, ? extends R>: a function that is not defined for all values of the domain (e.g. by throwing)

Returns:Function2<T1, T2, Try<R>>

a function that applies arguments to the given partialFunction and returns Success(result) if the function is defined for the given arguments, and Failure(throwable) otherwise.

memoized back to summary

memoized	back to summary
public default Function2<T1, T2, R> memoized() Returns a memoizing version of this function, which computes the return value for given arguments only one time. On subsequent calls given the same arguments the memoized value is returned. Please note that memoizing functions do not permit `null` as single argument or return value. Returns:Function2<T1, T2, R> a memoizing function equivalent to this.

public default Function2<T1, T2, R> memoized()

Returns a memoizing version of this function, which computes the return value for given arguments only one time. On subsequent calls given the same arguments the memoized value is returned.

Please note that memoizing functions do not permit null as single argument or return value.

Returns:Function2<T1, T2, R>: a memoizing function equivalent to this.

narrow back to summary

narrow	back to summary
public static <T1, T2, R> Function2<T1, T2, R> narrow(Function2<? super T1, ? super T2, ? extends R> f) Narrows the given `Function2<? super T1, ? super T2, ? extends R>` to `Function2<T1, T2, R>` Parameters <T1> 1st argument <T2> 2nd argument <R> return type f:Function2<? super T1, ? super T2, ? extends R> A `Function2` Returns:Function2<T1, T2, R> the given `f` instance as narrowed type `Function2<T1, T2, R>` Annotations @SuppressWarnings:unchecked

public static <T1, T2, R> Function2<T1, T2, R> narrow(Function2<? super T1, ? super T2, ? extends R> f)

Narrows the given Function2<? super T1, ? super T2, ? extends R> to Function2<T1, T2, R>

Parameters

<T1>: 1st argument
<T2>: 2nd argument
<R>: return type
f:Function2<? super T1, ? super T2, ? extends R>: A Function2

Returns:Function2<T1, T2, R>

the given f instance as narrowed type Function2<T1, T2, R>

Annotations

@SuppressWarnings:unchecked

of back to summary

of	back to summary
public static <T1, T2, R> Function2<T1, T2, R> of(Function2<T1, T2, R> methodReference) Creates a `Function2` based on method reference lambda expression Examples (w.l.o.g. referring to Function1): `// using a lambda expression Function1<Integer, Integer> add1 = Function1.of(i -> i + 1); // using a method reference (, e.g. Integer method(Integer i) { return i + 1; }) Function1<Integer, Integer> add2 = Function1.of(this::method); // using a lambda reference Function1<Integer, Integer> add3 = Function1.of(add1::apply);` Caution Reflection loses type information of lambda references. `// type of a lambda expression Type<?, ?> type1 = add1.getType(); // (Integer) -> Integer // type of a method reference Type<?, ?> type2 = add2.getType(); // (Integer) -> Integer // type of a lambda reference Type<?, ?> type3 = add3.getType(); // (Object) -> Object` Parameters <T1> 1st argument <T2> 2nd argument <R> return type methodReference:Function2<T1, T2, R> (typically) a method reference, e.g. `Type::method` Returns:Function2<T1, T2, R> a `Function2`

public static <T1, T2, R> Function2<T1, T2, R> of(Function2<T1, T2, R> methodReference)

Creates a Function2 based on

Examples (w.l.o.g. referring to Function1):

// using a lambda expression
Function1<Integer, Integer> add1 = Function1.of(i -> i + 1);

// using a method reference (, e.g. Integer method(Integer i) { return i + 1; })
Function1<Integer, Integer> add2 = Function1.of(this::method);

// using a lambda reference
Function1<Integer, Integer> add3 = Function1.of(add1::apply);

Caution

Reflection loses type information of lambda references.

// type of a lambda expression
Type<?, ?> type1 = add1.getType(); // (Integer) -> Integer

// type of a method reference
Type<?, ?> type2 = add2.getType(); // (Integer) -> Integer

// type of a lambda reference
Type<?, ?> type3 = add3.getType(); // (Object) -> Object

Parameters

<T1>: 1st argument
<T2>: 2nd argument
<R>: return type
methodReference:Function2<T1, T2, R>: (typically) a method reference, e.g. Type::method

Returns:Function2<T1, T2, R>

a Function2

reversed	back to summary
public default Function2<T2, T1, R> reversed() Returns a reversed version of this function. This may be useful in a recursive context. Returns:Function2<T2, T1, R> a reversed function equivalent to this.

reversed

back to summary

public default Function2<T2, T1, R> reversed()

Returns a reversed version of this function. This may be useful in a recursive context.

Returns:Function2<T2, T1, R>: a reversed function equivalent to this.

tupled	back to summary
public default Function1<Tuple2<T1, T2>, R> tupled() Returns a tupled version of this function. Returns:Function1<Tuple2<T1, T2>, R> a tupled function equivalent to this.

tupled

back to summary

public default Function1<Tuple2<T1, T2>, R> tupled()

Returns a tupled version of this function.

Returns:Function1<Tuple2<T1, T2>, R>: a tupled function equivalent to this.

public Interface Function2<T1, T2, R>

Field Summary

Method Summary

Field Detail

Method Detail