hu.akarnokd.reactive4java.util

Class Func1Builder<T,U>

java.lang.Object

hu.akarnokd.reactive4java.util.Func1Builder<T,U>

Type Parameters:

T - the function parameter type

U - the return type

All Implemented Interfaces:

Func1<T,U>

public final class Func1Builder<T,U>
extends java.lang.Object
implements Func1<T,U>

Class holding a Func1 object and providing various relevant methods of the Functions utility class as instance methods.

The class itself is of type Func1<T, U> and can be used where this type is needed.

Since:

0.96.1

Field Summary

Fields

Modifier and Type	Field and Description
protected Func1<T,U>	f The wrapped function.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Func1Builder(Func1<T,U> f) Construct a function builder by wrapping the given function.

Method Summary

Modifier and Type	Method and Description
static <T> Func1Builder<T,java.lang.Boolean>	alwaysFalse()
static <T> Func1Builder<T,java.lang.Boolean>	alwaysTrue()
Func1Builder<T,java.lang.Boolean>	and(Func0<java.lang.Boolean> func) Returns a function which produces the logical AND value of this and the other function.
Func1Builder<T,java.lang.Boolean>	and(Func1<? super T,java.lang.Boolean> func) Returns a function which produces the logical AND value of this and the other function.
<V> Func1Builder<V,U>	composeFrom(Func1<? super V,? extends T> func) Compose this function with the other function by supplying the output of this function as input for the other function and return its result, e.g., this(func(V)).
<V> Func1Builder<T,V>	composeTo(Func1<? super U,? extends V> func) Compose this function with the other function by supplying the output of this function as input for the other function and return its result, e.g., func(this(T)).
static <T,U> Func1Builder<T,U>	from(Action0 action, U result) Construct a function which invokes the given action and returns a constant value.
static <T,U> Func1Builder<T,U>	from(Action1<? super T> action, U result) Construct a function which invokes the given action and returns a constant value.
static <T,U> Func1Builder<T,U>	from(java.util.concurrent.Callable<? extends U> f) Wrap the given function into a new builder.
static Func1Builder<java.lang.Integer,java.lang.Double>	from(double... values) Returns an indexer function which returns the corresponding array element.
static <T,U> Func1Builder<T,U>	from(Func0<U> f) Wraps the given Func0 function into a Func1 object which ignores its parameter T.
static <T,U> Func1Builder<T,U>	from(Func1<T,U> f) Wrap the given function into a new builder.
static Func1Builder<java.lang.Integer,java.lang.Integer>	from(int... values) Returns an indexer function which returns the corresponding array element.
static <T> Func1Builder<java.lang.Integer,T>	from(java.util.List<? extends T> values) Returns a function builder which will return the indexth element from the supplied list.
static Func1Builder<java.lang.Integer,java.lang.Long>	from(long... values) Returns an indexer function which returns the corresponding array element.
static <T,U> Func1Builder<T,U>	from(java.util.Map<? super T,? extends U> map) Creates a function builder which relays all invocations to the supplied map's get method.
static <T,U> Func1Builder<T,U>	from(java.lang.Runnable run, U result) Construct a function which invokes the given runnable and returns a constant value.
static <T> Func1Builder<T,java.lang.Boolean>	from(java.util.Set<? super T> values) Returns a function builder which will return true if its parameter is contained in the given set of values.
static <T> Func1Builder<java.lang.Integer,T>	from(T... values) Returns a function builder which will return the indexth element from the supplied array.
static <T,U> Func1Builder<T,U>	from(U value) Wraps the given value and the function returns this value regardless of the parameters.
static Func1Builder<java.lang.Integer,java.lang.Double>	fromDoubles(java.util.List<? extends java.lang.Number> values) Returns an indexer function which returns the corresponding list element.
static Func1Builder<java.lang.Integer,java.lang.Integer>	fromInts(java.util.List<? extends java.lang.Number> values) Returns an indexer function which returns the corresponding list element.
static Func1Builder<java.lang.Integer,java.lang.Long>	fromLongs(java.util.List<? extends java.lang.Number> values) Returns an indexer function which returns the corresponding list element.
U	invoke(T param1) The method that gets invoked with a parameter.
Func1Builder<T,java.lang.Boolean>	not() Returns a function which takes the logical not of the wrapped boolean returning function.
Func1Builder<T,java.lang.Boolean>	or(Func0<java.lang.Boolean> func) Returns a function which produces the logical AND value of this and the other function.
Func1Builder<T,java.lang.Boolean>	or(Func1<? super T,java.lang.Boolean> func) Returns a function which produces the logical OR value of this and the other function.
Func0Builder<U>	toFunc0(T param1) Convert this function into a zero parameter function builder by fixing the parameter to the given value.
Func1Builder<T,java.lang.Boolean>	xor(Func0<java.lang.Boolean> func) Returns a function which produces the logical AND value of this and the other function.
Func1Builder<T,java.lang.Boolean>	xor(Func1<? super T,java.lang.Boolean> func) Returns a function which produces the logical XOR value of this and the other function.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

f

@Nonnull
protected final Func1<T,U> f

The wrapped function.

Constructor Detail

Func1Builder

protected Func1Builder(@Nonnull
                       Func1<T,U> f)

Construct a function builder by wrapping the given function.

Parameters:

f - the function to wrap

Method Detail

from

@Nonnull
public static <T,U> Func1Builder<T,U> from(@Nonnull
                                                     Func1<T,U> f)

Wrap the given function into a new builder.

Type Parameters:

T - the parameter type

U - the return type

Parameters:

f - the function to wrap

Returns:

the function builder

from

@Nonnull
public static <T,U> Func1Builder<T,U> from(@Nonnull
                                                     Func0<U> f)

Wraps the given Func0 function into a Func1 object which ignores its parameter T.

Type Parameters:

T - the function parameter type (irrelevant)

U - the function return type

Parameters:

f - the function to wrap

Returns:

the function builder

from

@Nonnull
public static <T,U> Func1Builder<T,U> from(U value)

Wraps the given value and the function returns this value regardless of the parameters.

Type Parameters:

T - the function parameter type, irrelevant

U - the return type

Parameters:

value - the value to return

Returns:

the function builder

from

@Nonnull
public static <T> Func1Builder<java.lang.Integer,T> from(@Nonnull
                                                                   T... values)

Returns a function builder which will return the indexth element from the supplied array.

Type Parameters:

T - the element type

Parameters:

values - the values to return from

Returns:

the function builder

from

@Nonnull
public static <T> Func1Builder<java.lang.Integer,T> from(@Nonnull
                                                                   java.util.List<? extends T> values)

Returns a function builder which will return the indexth element from the supplied list.

Type Parameters:

T - the element type

Parameters:

values - the values to return from

Returns:

the function builder

from

@Nonnull
public static <T> Func1Builder<T,java.lang.Boolean> from(@Nonnull
                                                                   java.util.Set<? super T> values)

Returns a function builder which will return true if its parameter is contained in the given set of values.

Type Parameters:

T - the element type

Parameters:

values - the values to return from

Returns:

the function builder

from

@Nonnull
public static <T,U> Func1Builder<T,U> from(@Nonnull
                                                     java.util.Map<? super T,? extends U> map)

Creates a function builder which relays all invocations to the supplied map's get method.

Type Parameters:

T - the key type

U - the value type

Parameters:

map - the map to wrap

Returns:

the function builder

alwaysTrue

@Nonnull
public static <T> Func1Builder<T,java.lang.Boolean> alwaysTrue()

Type Parameters:

T - the parameter type (irrelevant)

Returns:

a function builder which returns always true.

alwaysFalse

@Nonnull
public static <T> Func1Builder<T,java.lang.Boolean> alwaysFalse()

Type Parameters:

T - the parameter type (irrelevant)

Returns:

a function builder which retuns always false.

invoke

public U invoke(T param1)

Description copied from interface: Func1

The method that gets invoked with a parameter.

Specified by:

invoke in interface Func1<T,U>

Parameters:

param1 - the parameter value

Returns:

the return object

toFunc0

@Nonnull
public Func0Builder<U> toFunc0(T param1)

Convert this function into a zero parameter function builder by fixing the parameter to the given value.

Parameters:

param1 - the fixed parameter value

Returns:

the function builder

not

@Nonnull
public Func1Builder<T,java.lang.Boolean> not()

Returns a function which takes the logical not of the wrapped boolean returning function.

Note: this function will throw a ClassCastException if the current function return type is not Boolean.

Returns:

the function builder.

and

@Nonnull
public Func1Builder<T,java.lang.Boolean> and(@Nonnull
                                                       Func1<? super T,java.lang.Boolean> func)

Returns a function which produces the logical AND value of this and the other function.

Note: this function will throw a ClassCastException if the current function return type is not Boolean.

Parameters:

func - the function to AND with

Returns:

the function builder

and

@Nonnull
public Func1Builder<T,java.lang.Boolean> and(@Nonnull
                                                       Func0<java.lang.Boolean> func)

Returns a function which produces the logical AND value of this and the other function.

Note: this function will throw a ClassCastException if the current function return type is not Boolean.

Parameters:

func - the function to AND with

Returns:

the function builder

or

@Nonnull
public Func1Builder<T,java.lang.Boolean> or(Func1<? super T,java.lang.Boolean> func)

Returns a function which produces the logical OR value of this and the other function.

Note: this function will throw a ClassCastException if the current function return type is not Boolean.

Parameters:

func - the function to OR with

Returns:

the function builder

or

@Nonnull
public Func1Builder<T,java.lang.Boolean> or(@Nonnull
                                                      Func0<java.lang.Boolean> func)

Returns a function which produces the logical AND value of this and the other function.

Note: this function will throw a ClassCastException if the current function return type is not Boolean.

Parameters:

func - the function to AND with

Returns:

the function builder

xor

@Nonnull
public Func1Builder<T,java.lang.Boolean> xor(@Nonnull
                                                       Func1<? super T,java.lang.Boolean> func)

Returns a function which produces the logical XOR value of this and the other function.

Note: this function will throw a ClassCastException if the current function return type is not Boolean.

Parameters:

func - the function to XOR with

Returns:

the function builder

xor

@Nonnull
public Func1Builder<T,java.lang.Boolean> xor(@Nonnull
                                                       Func0<java.lang.Boolean> func)

Returns a function which produces the logical AND value of this and the other function.

Note: this function will throw a ClassCastException if the current function return type is not Boolean.

Parameters:

func - the function to AND with

Returns:

the function builder

composeTo

@Nonnull
public <V> Func1Builder<T,V> composeTo(@Nonnull
                                                 Func1<? super U,? extends V> func)

Compose this function with the other function by supplying the output of this function as input for the other function and return its result, e.g., func(this(T)).

Type Parameters:

V - the new return type

Parameters:

func - the function to compose with

Returns:

the function builder with the new return type

composeFrom

@Nonnull
public <V> Func1Builder<V,U> composeFrom(@Nonnull
                                                   Func1<? super V,? extends T> func)

Compose this function with the other function by supplying the output of this function as input for the other function and return its result, e.g., this(func(V)).

Type Parameters:

V - the outer parameter type

Parameters:

func - the function to compose with

Returns:

the function builder with the new return type

from

@Nonnull
public static <T,U> Func1Builder<T,U> from(@Nonnull
                                                     Action0 action,
                                                     U result)

Construct a function which invokes the given action and returns a constant value.

Type Parameters:

T - the function parameter type

U - the return type

Parameters:

action - the action to invoke on each function invocation

result - the return value by this function

Returns:

the function builder

from

@Nonnull
public static <T,U> Func1Builder<T,U> from(@Nonnull
                                                     java.lang.Runnable run,
                                                     U result)

Construct a function which invokes the given runnable and returns a constant value.

Type Parameters:

T - the function parameter type

U - the return type

Parameters:

run - the runnable to wrap

result - the return value by this function

Returns:

the function builder

from

@Nonnull
public static <T,U> Func1Builder<T,U> from(@Nonnull
                                                     Action1<? super T> action,
                                                     U result)

Construct a function which invokes the given action and returns a constant value.

Type Parameters:

T - the function parameter type

U - the return type

Parameters:

action - the action to invoke on each function invocation

result - the return value by this function

Returns:

the function builder

from

@Nonnull
public static <T,U> Func1Builder<T,U> from(@Nonnull
                                                     java.util.concurrent.Callable<? extends U> f)

Wrap the given function into a new builder.

Type Parameters:

T - the parameter type

U - the return type

Parameters:

f - the function to wrap

Returns:

the function builder

from

@Nonnull
public static Func1Builder<java.lang.Integer,java.lang.Integer> from(@Nonnull
                                                                               int... values)

Returns an indexer function which returns the corresponding array element.

Parameters:

values - the array of values

Returns:

the function builder

from

@Nonnull
public static Func1Builder<java.lang.Integer,java.lang.Double> from(@Nonnull
                                                                              double... values)

Returns an indexer function which returns the corresponding array element.

Parameters:

values - the array of values

Returns:

the function builder

from

@Nonnull
public static Func1Builder<java.lang.Integer,java.lang.Long> from(@Nonnull
                                                                            long... values)

Returns an indexer function which returns the corresponding array element.

Parameters:

values - the array of values

Returns:

the function builder

fromDoubles

@Nonnull
public static Func1Builder<java.lang.Integer,java.lang.Double> fromDoubles(@Nonnull
                                                                                     java.util.List<? extends java.lang.Number> values)

Returns an indexer function which returns the corresponding list element.

Parameters:

values - the list of numbers

Returns:

the function builder

fromInts

@Nonnull
public static Func1Builder<java.lang.Integer,java.lang.Integer> fromInts(@Nonnull
                                                                                   java.util.List<? extends java.lang.Number> values)

Returns an indexer function which returns the corresponding list element.

Parameters:

values - the list of numbers

Returns:

the function builder

fromLongs

@Nonnull
public static Func1Builder<java.lang.Integer,java.lang.Long> fromLongs(@Nonnull
                                                                                 java.util.List<? extends java.lang.Number> values)

Returns an indexer function which returns the corresponding list element.

Parameters:

values - the list of numbers

Returns:

the function builder