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:
java.io.Serializable
- Functional Interface:
- This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
@FunctionalInterface public interface Function5<T1,T2,T3,T4,T5,R> extends java.io.Serializable
Represents a function with 5 arguments.
-
-
Field Summary
Fields Modifier and Type Field Description static long
serialVersionUID
The serial version uid.
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default <V> Function5<T1,T2,T3,T4,T5,V>
andThen(java.util.function.Function<? super R,? extends V> after)
Returns a composed function that first applies this Function5 to the given argument and then applies Functionafter
to the result.default Function4<T2,T3,T4,T5,R>
apply(T1 t1)
Applies this function partially to one argument.default Function3<T3,T4,T5,R>
apply(T1 t1, T2 t2)
Applies this function partially to two arguments.default Function2<T4,T5,R>
apply(T1 t1, T2 t2, T3 t3)
Applies this function partially to three arguments.default Function1<T5,R>
apply(T1 t1, T2 t2, T3 t3, T4 t4)
Applies this function partially to 4 arguments.R
apply(T1 t1, T2 t2, T3 t3, T4 t4, T5 t5)
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.default Function1<T1,Function1<T2,Function1<T3,Function1<T4,Function1<T5,R>>>>>
curried()
Returns a curried version of this function.default boolean
isMemoized()
Checks if this function is memoizing (= caching) computed values.static <T1,T2,T3,T4,T5,R>
Function5<T1,T2,T3,T4,T5,Option<R>>lift(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.static <T1,T2,T3,T4,T5,R>
Function5<T1,T2,T3,T4,T5,Try<R>>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.default Function5<T1,T2,T3,T4,T5,R>
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>narrow(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>
static <T1,T2,T3,T4,T5,R>
Function5<T1,T2,T3,T4,T5,R>of(Function5<T1,T2,T3,T4,T5,R> methodReference)
default Function5<T5,T4,T3,T2,T1,R>
reversed()
Returns a reversed version of this function.default Function1<Tuple5<T1,T2,T3,T4,T5>,R>
tupled()
Returns a tupled version of this function.
-
-
-
Field Detail
-
serialVersionUID
static final long serialVersionUID
The serial version uid.- See Also:
- Constant Field Values
-
-
Method Detail
-
constant
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.- 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,T3,T4,T5,R> Function5<T1,T2,T3,T4,T5,R> of(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:
R
- return typeT1
- 1st argumentT2
- 2nd argumentT3
- 3rd argumentT4
- 4th argumentT5
- 5th argument- Parameters:
methodReference
- (typically) a method reference, e.g.Type::method
- Returns:
- a
Function5
-
lift
static <T1,T2,T3,T4,T5,R> Function5<T1,T2,T3,T4,T5,Option<R>> lift(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:
R
- return typeT1
- 1st argumentT2
- 2nd argumentT3
- 3rd argumentT4
- 4th argumentT5
- 5th argument- 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,T3,T4,T5,R> Function5<T1,T2,T3,T4,T5,Try<R>> 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.- Type Parameters:
R
- return typeT1
- 1st argumentT2
- 2nd argumentT3
- 3rd argumentT4
- 4th argumentT5
- 5th argument- 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,T3,T4,T5,R> Function5<T1,T2,T3,T4,T5,R> narrow(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:
R
- return typeT1
- 1st argumentT2
- 2nd argumentT3
- 3rd argumentT4
- 4th argumentT5
- 5th argument- Parameters:
f
- AFunction5
- Returns:
- the given
f
instance as narrowed typeFunction5<T1, T2, T3, T4, T5, R>
-
apply
R apply(T1 t1, T2 t2, T3 t3, T4 t4, T5 t5)
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
default Function4<T2,T3,T4,T5,R> apply(T1 t1)
Applies this function partially to one argument.- Parameters:
t1
- argument 1- Returns:
- a partial application of this function
-
apply
default Function3<T3,T4,T5,R> apply(T1 t1, T2 t2)
Applies this function partially to two arguments.- Parameters:
t1
- argument 1t2
- argument 2- Returns:
- a partial application of this function
-
apply
default Function2<T4,T5,R> apply(T1 t1, T2 t2, T3 t3)
Applies this function partially to three arguments.- Parameters:
t1
- argument 1t2
- argument 2t3
- argument 3- Returns:
- a partial application of this function
-
apply
default Function1<T5,R> apply(T1 t1, T2 t2, T3 t3, T4 t4)
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:
- Arity
-
curried
default Function1<T1,Function1<T2,Function1<T3,Function1<T4,Function1<T5,R>>>>> curried()
Returns a curried version of this function.- Returns:
- a curried function equivalent to this.
-
tupled
default Function1<Tuple5<T1,T2,T3,T4,T5>,R> tupled()
Returns a tupled version of this function.- Returns:
- a tupled function equivalent to this.
-
reversed
default Function5<T5,T4,T3,T2,T1,R> reversed()
Returns a reversed version of this function. This may be useful in a recursive context.- Returns:
- a reversed function equivalent to this.
-
memoized
default Function5<T1,T2,T3,T4,T5,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:
- 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
default <V> Function5<T1,T2,T3,T4,T5,V> andThen(java.util.function.Function<? super R,? extends V> after)
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:
java.lang.NullPointerException
- if after is null
-
-