com.helger.commons.functional

Interface IFunction<T,R>

Type Parameters:

T - the type of the input to the function

R - the type of the result of the function

All Superinterfaces:

Function<T,R>, Serializable

All Known Subinterfaces:

IAggregator<SRCTYPE,DSTTYPE>, ISplitter<SRCTYPE,DSTTYPE>, ITypeConverter<SRC,DST>, ITypeConverterRule<SRC,DST>

All Known Implementing Classes:

AbstractFormatterString, AbstractTypeConverterRule, FormatterMinLengthAddLeading, FormatterMinLengthAddTrailing, FormatterStringPrefixAndSuffix, FormatterStringSkipPrefixAndSuffix, TypeConverterRuleAnySourceFixedDestination, TypeConverterRuleAssignableSourceFixedDestination, TypeConverterRuleFixedSourceAnyDestination, TypeConverterRuleFixedSourceAssignableDestination

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 IFunction<T,R>
extends Function<T,R>, Serializable

Represents a serializable function that accepts one argument and produces a result.

This is a functional interface whose functional method is Function.apply(Object).

Since:

8.6.0

Method Summary

Modifier and Type	Method and Description
default <V> IFunction<T,V>	andThen(Function<? super R,? extends V> after) Returns a composed function that first applies this function to its input, and then applies the after function to the result.
default <V> IFunction<V,R>	compose(Function<? super V,? extends T> before) Returns a composed function that first applies the before function to its input, and then applies this function to the result.
static <T> IFunction<T,T>	identity() Returns a function that always returns its input argument.

Methods inherited from interface java.util.function.Function

apply

Method Detail

compose

@Nonnull
default <V> IFunction<V,R> compose(@Nonnull
                                             Function<? super V,? extends T> before)

Returns a composed function that first applies the before function to its input, and then applies this function to the result. If evaluation of either function throws an exception, it is relayed to the caller of the composed function.

Specified by:

compose in interface Function<T,R>

Type Parameters:

V - the type of input to the before function, and to the composed function

Parameters:

before - the function to apply before this function is applied

Returns:

a composed function that first applies the before function and then applies this function

Throws:

NullPointerException - if before is null

See Also:

andThen(Function)

andThen

@Nonnull
default <V> IFunction<T,V> andThen(@Nonnull
                                             Function<? super R,? extends V> after)

Returns a composed function that first applies this function to its input, and then applies the after function to the result. If evaluation of either function throws an exception, it is relayed to the caller of the composed function.

Specified by:

andThen in interface Function<T,R>

Type Parameters:

V - the type of output of the after function, and of the composed function

Parameters:

after - the function to apply after this function is applied

Returns:

a composed function that first applies this function and then applies the after function

Throws:

NullPointerException - if after is null

See Also:

compose(Function)

identity

@Nonnull
static <T> IFunction<T,T> identity()

Returns a function that always returns its input argument.

Specified by:

identity in interface Function<T,R>

Type Parameters:

T - the type of the input and output objects to the function

Returns:

a function that always returns its input argument

Since:

8.6.2