hu.akarnokd.reactive4java.util

Class Func2Builder<T,U,V>

java.lang.Object

hu.akarnokd.reactive4java.util.Func2Builder<T,U,V>

Type Parameters:

T - the function first parameter type

U - the function second parameter type

V - the return type

All Implemented Interfaces:

Func2<T,U,V>

public class Func2Builder<T,U,V>
extends java.lang.Object
implements Func2<T,U,V>

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

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

Since:

0.96.1

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Func2Builder(Func2<T,U,V> f) Construct an instance of this builder with the wrapped function.

Method Summary

Modifier and Type	Method and Description
static <T,U> Func2Builder<T,U,java.lang.Boolean>	alwaysFalse()
static <T,U> Func2Builder<T,U,java.lang.Boolean>	alwaysTrue()
Func2Builder<T,U,java.lang.Boolean>	and(Func0<java.lang.Boolean> func) Returns a function which produces the logical AND value of this and the other function.
Func2Builder<T,U,java.lang.Boolean>	and(Func2<? super T,? super U,java.lang.Boolean> func) Returns a function which produces the logical AND value of this and the other function.
static <T,U,V> Func2Builder<T,U,V>	from(Action0 action, V result) Construct a function which invokes the given action and returns a constant value.
static <T,U,V> Func2Builder<T,U,V>	from(Action2<? super T,? super U> action, V result) Construct a function which invokes the given action and returns a constant value.
static <T,U,V> Func2Builder<T,U,V>	from(java.util.concurrent.Callable<? extends V> f) Wrap the given function into a new builder.
static <T> Func2Builder<T,T,java.lang.Integer>	from(java.util.Comparator<? super T> comp) Wraps the given comparator into a 2 parameter function.
static Func2Builder<java.lang.Integer,java.lang.Integer,java.lang.Double>	from(double[][] matrix) Returns a matrix indexer function.
static <T,U,V> Func2Builder<T,U,V>	from(Func0<V> f) Wraps the given Func0 function into a Func2 object which ignores its parameter T.
static <T,U,V> Func2Builder<T,U,V>	from(Func2<T,U,V> f) Wrap the given function into a function builder instance.
static Func2Builder<java.lang.Integer,java.lang.Integer,java.lang.Integer>	from(int[][] matrix) Returns a matrix indexer function.
static Func2Builder<java.lang.Integer,java.lang.Integer,java.lang.Long>	from(long[][] matrix) Returns a matrix indexer function.
static <T,U,V> Func2Builder<T,U,V>	from(java.lang.Runnable run, V result) Construct a function which invokes the given runnable and returns a constant value.
static <T> Func2Builder<java.lang.Integer,java.lang.Integer,T>	from(T[][] matrix) Returns a matrix indexer function.
static <T,U,V> Func2Builder<T,U,V>	from(V value) Wraps the given value and the function returns this value regardless of the parameters.
V	invoke(T param1, U param2) The method that gets invoked with two parameters.
Func2Builder<T,U,java.lang.Boolean>	not() Returns a function which takes the logical not of the wrapped boolean returning function.
Func2Builder<T,U,java.lang.Boolean>	or(Func0<java.lang.Boolean> func) Returns a function which produces the logical AND value of this and the other function.
Func2Builder<T,U,java.lang.Boolean>	or(Func2<? super T,? super U,java.lang.Boolean> func) Returns a function which produces the logical OR value of this and the other function.
java.util.Comparator<T>	toComparator() Convert this two parameter function into a comparator.
Func0Builder<V>	toFunc0(T param1, U param2) Convert this function into a zero parameter function builder by fixing the parameter to the given values.
Func2Builder<T,U,java.lang.Boolean>	xor(Func0<java.lang.Boolean> func) Returns a function which produces the logical AND value of this and the other function.
Func2Builder<T,U,java.lang.Boolean>	xor(Func2<? super T,? super U,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 Func2<T,U,V> f

The wrapped function.

Constructor Detail

Func2Builder

protected Func2Builder(@Nonnull
                       Func2<T,U,V> f)

Construct an instance of this builder with the wrapped function.

Parameters:

f - the function to wrap

Method Detail

from

@Nonnull
public static <T,U,V> Func2Builder<T,U,V> from(@Nonnull
                                                         Func2<T,U,V> f)

Wrap the given function into a function builder instance.

Type Parameters:

T - the function first parameter type

U - the function second parameter type

V - the return type

Parameters:

f - the function to wrap

Returns:

the function builder

from

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

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

Type Parameters:

T - the function first parameter type

U - the function second parameter type

V - the return type

Parameters:

f - the function to wrap

Returns:

the function builder

from

@Nonnull
public static <T,U,V> Func2Builder<T,U,V> from(V 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 function parameter type, irrelevant

V - the return type

Parameters:

value - the value to return

Returns:

the function builder

invoke

public V invoke(T param1,
                U param2)

Description copied from interface: Func2

The method that gets invoked with two parameters.

Specified by:

invoke in interface Func2<T,U,V>

Parameters:

param1 - the first parameter value

param2 - the second parameter value

Returns:

the return object

alwaysTrue

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

Type Parameters:

T - the parameter type (irrelevant)

U - the parameter type (irrelevant)

Returns:

a function builder which returns always true.

alwaysFalse

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

Type Parameters:

T - the parameter type (irrelevant)

U - the parameter type (irrelevant)

Returns:

a function builder which retuns always false.

toFunc0

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

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

Parameters:

param1 - the fixed parameter value

param2 - the fixed parameter value

Returns:

the function builder

not

@Nonnull
public Func2Builder<T,U,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 Func2Builder<T,U,java.lang.Boolean> and(@Nonnull
                                                         Func2<? super T,? super U,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 Func2Builder<T,U,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 Func2Builder<T,U,java.lang.Boolean> or(@Nonnull
                                                        Func2<? super T,? super U,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 Func2Builder<T,U,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 Func2Builder<T,U,java.lang.Boolean> xor(@Nonnull
                                                         Func2<? super T,? super U,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 Func2Builder<T,U,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

from

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

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

Type Parameters:

T - the function first parameter type

U - the function second parameter type

V - 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,V> Func2Builder<T,U,V> from(@Nonnull
                                                         java.lang.Runnable run,
                                                         V result)

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

Type Parameters:

T - the function first parameter type

U - the function second parameter type

V - 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,V> Func2Builder<T,U,V> from(@Nonnull
                                                         Action2<? super T,? super U> action,
                                                         V result)

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

Type Parameters:

T - the function first parameter type

U - the function second parameter type

V - 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,V> Func2Builder<T,U,V> from(@Nonnull
                                                         java.util.concurrent.Callable<? extends V> f)

Wrap the given function into a new builder.

Type Parameters:

T - the function first parameter type

U - the function second parameter type

V - the return type

Parameters:

f - the function to wrap

Returns:

the function builder

from

@Nonnull
public static <T> Func2Builder<T,T,java.lang.Integer> from(@Nonnull
                                                                     java.util.Comparator<? super T> comp)

Wraps the given comparator into a 2 parameter function.

Type Parameters:

T - the value type

Parameters:

comp - the comparator to wrap

Returns:

the function builder

toComparator

@Nonnull
public java.util.Comparator<T> toComparator()

Convert this two parameter function into a comparator.

Note, if the parameter types are not the same or the return type is not Integer you might expect to get a ClassCastException.

Returns:

the comparator representing this function

from

@Nonnull
public static <T> Func2Builder<java.lang.Integer,java.lang.Integer,T> from(@Nonnull
                                                                                     T[][] matrix)

Returns a matrix indexer function.

Type Parameters:

T - the element type

Parameters:

matrix - the matrix to index

Returns:

the function builder

from

@Nonnull
public static Func2Builder<java.lang.Integer,java.lang.Integer,java.lang.Integer> from(@Nonnull
                                                                                                 int[][] matrix)

Returns a matrix indexer function.

Parameters:

matrix - the matrix to index

Returns:

the function builder

from

@Nonnull
public static Func2Builder<java.lang.Integer,java.lang.Integer,java.lang.Double> from(@Nonnull
                                                                                                double[][] matrix)

Returns a matrix indexer function.

Parameters:

matrix - the matrix to index

Returns:

the function builder

from

@Nonnull
public static Func2Builder<java.lang.Integer,java.lang.Integer,java.lang.Long> from(@Nonnull
                                                                                              long[][] matrix)

Returns a matrix indexer function.

Parameters:

matrix - the matrix to index

Returns:

the function builder