Package io.vavr
Interface CheckedFunction2<T1,T2,R>
- Type Parameters:
T1
- argument 1 of the functionT2
- argument 2 of the functionR
- return type of the function
- All Superinterfaces:
Serializable
- Functional Interface:
- This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
Represents a function with two arguments.
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptiondefault <V> CheckedFunction2
<T1, T2, V> andThen
(CheckedFunction1<? super R, ? extends V> after) Returns a composed function that first applies this CheckedFunction2 to the given argument and then applies CheckedFunction1after
to the result.default CheckedFunction1
<T2, R> Applies this function partially to one argument.Applies this function to two arguments and returns the result.default int
arity()
Returns the number of function arguments.static <T1,
T2, R>
CheckedFunction2<T1, T2, R> constant
(R value) Returns a function that always returns the constant value that you give in parameter.default Function1
<T1, CheckedFunction1<T2, R>> curried()
Returns a curried version of this function.default boolean
Checks if this function is memoizing (= caching) computed values.lift
(CheckedFunction2<? super T1, ? super T2, ? extends R> partialFunction) Lifts the givenpartialFunction
into a total function that returns anOption
result.liftTry
(CheckedFunction2<? super T1, ? super T2, ? extends R> partialFunction) Lifts the givenpartialFunction
into a total function that returns anTry
result.default CheckedFunction2
<T1, T2, R> memoized()
Returns a memoizing version of this function, which computes the return value for given arguments only one time.static <T1,
T2, R>
CheckedFunction2<T1, T2, R> narrow
(CheckedFunction2<? super T1, ? super T2, ? extends R> f) Narrows the givenCheckedFunction2<? super T1, ? super T2, ? extends R>
toCheckedFunction2<T1, T2, R>
static <T1,
T2, R>
CheckedFunction2<T1, T2, R> of
(CheckedFunction2<T1, T2, R> methodReference) recover
(Function<? super Throwable, ? extends BiFunction<? super T1, ? super T2, ? extends R>> recover) Return a composed function that first applies this CheckedFunction2 to the given arguments and in case of throwable try to get value fromrecover
function with same arguments and throwable information.default CheckedFunction2
<T2, T1, R> reversed()
Returns a reversed version of this function.default CheckedFunction1
<Tuple2<T1, T2>, R> tupled()
Returns a tupled version of this function.Returns an unchecked function that will sneaky throw if an exceptions occurs when applying the function.
-
Field Details
-
serialVersionUID
static final long serialVersionUIDThe serial version uid.- See Also:
-
-
Method Details
-
constant
Returns a function that always returns the constant value that you give in parameter.- Type Parameters:
T1
- generic parameter type 1 of the resulting functionT2
- generic parameter type 2 of the resulting functionR
- the result type- Parameters:
value
- the value to be returned- Returns:
- a function always returning the given value
-
of
Creates aCheckedFunction2
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
- Type Parameters:
T1
- 1st argumentT2
- 2nd argumentR
- return type- Parameters:
methodReference
- (typically) a method reference, e.g.Type::method
- Returns:
- a
CheckedFunction2
-
lift
static <T1,T2, Function2<T1,R> T2, liftOption<R>> (CheckedFunction2<? super T1, ? super T2, ? extends R> partialFunction) Lifts the givenpartialFunction
into a total function that returns anOption
result.- Type Parameters:
T1
- 1st argumentT2
- 2nd argumentR
- return type- Parameters:
partialFunction
- a function that is not defined for all values of the domain (e.g. by throwing)- Returns:
- a function that applies arguments to the given
partialFunction
and returnsSome(result)
if the function is defined for the given arguments, andNone
otherwise.
-
liftTry
static <T1,T2, Function2<T1,R> T2, liftTryTry<R>> (CheckedFunction2<? super T1, ? super T2, ? extends R> partialFunction) Lifts the givenpartialFunction
into a total function that returns anTry
result.- Type Parameters:
T1
- 1st argumentT2
- 2nd argumentR
- return type- Parameters:
partialFunction
- a function that is not defined for all values of the domain (e.g. by throwing)- Returns:
- a function that applies arguments to the given
partialFunction
and returnsSuccess(result)
if the function is defined for the given arguments, andFailure(throwable)
otherwise.
-
narrow
static <T1,T2, CheckedFunction2<T1,R> T2, narrowR> (CheckedFunction2<? super T1, ? super T2, ? extends R> f) Narrows the givenCheckedFunction2<? super T1, ? super T2, ? extends R>
toCheckedFunction2<T1, T2, R>
- Type Parameters:
T1
- 1st argumentT2
- 2nd argumentR
- return type- Parameters:
f
- ACheckedFunction2
- Returns:
- the given
f
instance as narrowed typeCheckedFunction2<T1, T2, R>
-
apply
Applies this function to two arguments and returns the result.- Parameters:
t1
- argument 1t2
- argument 2- Returns:
- the result of function application
- Throws:
Throwable
- if something goes wrong applying this function to the given arguments
-
apply
Applies this function partially to one argument.- Parameters:
t1
- argument 1- Returns:
- a partial application of this function
-
arity
default int arity()Returns the number of function arguments.- Returns:
- an int value >= 0
- See Also:
-
curried
Returns a curried version of this function.- Returns:
- a curried function equivalent to this.
-
tupled
Returns a tupled version of this function.- Returns:
- a tupled function equivalent to this.
-
reversed
Returns a reversed version of this function. This may be useful in a recursive context.- Returns:
- a reversed function equivalent to this.
-
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:
- a memoizing function equivalent to this.
-
isMemoized
default boolean isMemoized()Checks if this function is memoizing (= caching) computed values.- Returns:
- true, if this function is memoizing, false otherwise
-
recover
default Function2<T1,T2, recoverR> (Function<? super Throwable, ? extends BiFunction<? super T1, ? super T2, ? extends R>> recover) Return a composed function that first applies this CheckedFunction2 to the given arguments and in case of throwable try to get value fromrecover
function with same arguments and throwable information.- Parameters:
recover
- the function applied in case of throwable- Returns:
- a function composed of this and recover
- Throws:
NullPointerException
- if recover is null
-
unchecked
Returns an unchecked function that will sneaky throw if an exceptions occurs when applying the function.- Returns:
- a new Function2 that throws a
Throwable
.
-
andThen
Returns a composed function that first applies this CheckedFunction2 to the given argument and then applies CheckedFunction1after
to the result.- Type Parameters:
V
- return type of after- Parameters:
after
- the function applied after this- Returns:
- a function composed of this and after
- Throws:
NullPointerException
- if after is null
-