Package io.vavr
Interface Function5<T1,T2,T3,T4,T5,R>
- Type Parameters:
T1
- argument 1 of the functionT2
- argument 2 of the functionT3
- argument 3 of the functionT4
- argument 4 of the functionT5
- argument 5 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 5 arguments.
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionReturns a composed function that first applies this Function5 to the given argument and then applies Functionafter
to the result.Applies this function partially to one argument.Applies this function partially to two arguments.Applies this function partially to three arguments.Applies this function partially to 4 arguments.Applies this function to 5 arguments and returns the result.default int
arity()
Returns the number of function arguments.static <T1,
T2, T3, T4, T5, R>
Function5<T1, T2, T3, T4, T5, R> constant
(R value) Returns a function that always returns the constant value that you give in parameter.curried()
Returns a curried version of this function.default boolean
Checks if this function is memoizing (= caching) computed values.Lifts the givenpartialFunction
into a total function that returns anOption
result.liftTry
(Function5<? super T1, ? super T2, ? super T3, ? super T4, ? super T5, ? extends R> partialFunction) Lifts the givenpartialFunction
into a total function that returns anTry
result.memoized()
Returns a memoizing version of this function, which computes the return value for given arguments only one time.static <T1,
T2, T3, T4, T5, R>
Function5<T1, T2, T3, T4, T5, R> Narrows the givenFunction5<? super T1, ? super T2, ? super T3, ? super T4, ? super T5, ? extends R>
toFunction5<T1, T2, T3, T4, T5, R>
static <T1,
T2, T3, T4, T5, R>
Function5<T1, T2, T3, T4, T5, R> reversed()
Returns a reversed version of this function.tupled()
Returns a tupled version of this 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 functionT3
- generic parameter type 3 of the resulting functionT4
- generic parameter type 4 of the resulting functionT5
- generic parameter type 5 of the resulting functionR
- the result type- Parameters:
value
- the value to be returned- Returns:
- a function always returning the given value
-
of
static <T1,T2, Function5<T1,T3, T4, T5, R> T2, ofT3, T4, T5, R> (Function5<T1, T2, T3, T4, T5, R> methodReference) Creates aFunction5
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 argumentT3
- 3rd argumentT4
- 4th argumentT5
- 5th argumentR
- return type- Parameters:
methodReference
- (typically) a method reference, e.g.Type::method
- Returns:
- a
Function5
-
lift
static <T1,T2, Function5<T1,T3, T4, T5, R> T2, liftT3, T4, T5, Option<R>> (Function5<? super T1, ? super T2, ? super T3, ? super T4, ? super T5, ? extends R> partialFunction) Lifts the givenpartialFunction
into a total function that returns anOption
result.- Type Parameters:
T1
- 1st argumentT2
- 2nd argumentT3
- 3rd argumentT4
- 4th argumentT5
- 5th 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, Function5<T1,T3, T4, T5, R> T2, liftTryT3, T4, T5, Try<R>> (Function5<? super T1, ? super T2, ? super T3, ? super T4, ? super T5, ? extends R> partialFunction) Lifts the givenpartialFunction
into a total function that returns anTry
result.- Type Parameters:
T1
- 1st argumentT2
- 2nd argumentT3
- 3rd argumentT4
- 4th argumentT5
- 5th 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, Function5<T1,T3, T4, T5, R> T2, narrowT3, T4, T5, R> (Function5<? super T1, ? super T2, ? super T3, ? super T4, ? super T5, ? extends R> f) Narrows the givenFunction5<? super T1, ? super T2, ? super T3, ? super T4, ? super T5, ? extends R>
toFunction5<T1, T2, T3, T4, T5, R>
- Type Parameters:
T1
- 1st argumentT2
- 2nd argumentT3
- 3rd argumentT4
- 4th argumentT5
- 5th argumentR
- return type- Parameters:
f
- AFunction5
- Returns:
- the given
f
instance as narrowed typeFunction5<T1, T2, T3, T4, T5, R>
-
apply
Applies this function to 5 arguments and returns the result.- Parameters:
t1
- argument 1t2
- argument 2t3
- argument 3t4
- argument 4t5
- argument 5- Returns:
- the result of function application
-
apply
Applies this function partially to one argument.- Parameters:
t1
- argument 1- Returns:
- a partial application of this function
-
apply
Applies this function partially to two arguments.- Parameters:
t1
- argument 1t2
- argument 2- Returns:
- a partial application of this function
-
apply
Applies this function partially to three arguments.- Parameters:
t1
- argument 1t2
- argument 2t3
- argument 3- Returns:
- a partial application of this function
-
apply
Applies this function partially to 4 arguments.- Parameters:
t1
- argument 1t2
- argument 2t3
- argument 3t4
- argument 4- 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
-
andThen
Returns a composed function that first applies this Function5 to the given argument and then applies Functionafter
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
-