hu.akarnokd.reactive4java.util

Class Func0Builder<T>

java.lang.Object

hu.akarnokd.reactive4java.util.Func0Builder<T>

Type Parameters:

T - the return type

All Implemented Interfaces:

Func0<T>

public final class Func0Builder<T>
extends java.lang.Object
implements Func0<T>

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

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

Since:

0.96.1

Field Summary

Fields

Modifier and Type	Field and Description
protected Func0<T>	f The wrapped function.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Func0Builder(Func0<T> f) Constructs an instance of this builder with the wrapped function.

Method Summary

Modifier and Type	Method and Description
static Func0Builder<java.lang.Boolean>	alwaysFalse()
static Func0Builder<java.lang.Boolean>	alwaysTrue()
Func0Builder<java.lang.Boolean>	and(Func0<java.lang.Boolean> func) Returns a function which produces the logical AND value of this and the other function.
static <T> Func0Builder<T>	from(Action0 action, T result) Construct a function which invokes the given action and returns a constant value.
static Func0Builder<java.lang.Boolean>	from(java.util.concurrent.atomic.AtomicBoolean value) Construct a function from the given atomic variable.
static Func0Builder<java.lang.Integer>	from(java.util.concurrent.atomic.AtomicInteger value) Construct a function from the given atomic variable.
static Func0Builder<java.lang.Long>	from(java.util.concurrent.atomic.AtomicLong value) Construct a function from the given atomic variable.
static <T> Func0Builder<T>	from(java.util.concurrent.atomic.AtomicReference<? extends T> value) Construct a function from the given atomic variable reference.
static <T> Func0Builder<T>	from(java.util.concurrent.Callable<? extends T> call) Construct a function from the given callable instance.
static <T> Func0Builder<T>	from(Func0<T> f) Construct a function builder from the given existing function.
static <T> Func0Builder<T>	from(java.lang.ref.Reference<? extends T> ref) Wraps the given reference object into a function call.
static <T> Func0Builder<T>	from(java.lang.Runnable run, T result) Construct a function which invokes the given runnable and returns a constant value.
static <T> Func0Builder<T>	from(T value) Construct a function which returns a constant value.
T	invoke() The function body to invoke.
Func0Builder<java.lang.Boolean>	not() Returns a function which takes the logical not of the wrapped boolean returning function.
Func0Builder<java.lang.Boolean>	or(Func0<java.lang.Boolean> func) Returns a function which produces the logical OR value of this and the other function.
java.util.concurrent.Callable<T>	toCallable()
<U> Func1Builder<U,T>	toFunc1()
<U,V> Func2Builder<U,V,T>	toFunc2()
Func0Builder<java.lang.Boolean>	xor(Func0<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 Func0<T> f

The wrapped function.

Constructor Detail

Func0Builder

protected Func0Builder(@Nonnull
                       Func0<T> f)

Constructs an instance of this builder with the wrapped function.

Parameters:

f - the function to wrap

Method Detail

invoke

public T invoke()

Description copied from interface: Func0

The function body to invoke.

Specified by:

invoke in interface Func0<T>

Returns:

the return type

from

@Nonnull
public static <T> Func0Builder<T> from(@Nonnull
                                                 Func0<T> f)

Construct a function builder from the given existing function.

Type Parameters:

T - the return type

Parameters:

f - the function to wrap

Returns:

the function builder

from

public static <T> Func0Builder<T> from(T value)

Construct a function which returns a constant value.

Type Parameters:

T - the value type

Parameters:

value - the value returned by the function

Returns:

the function builder

from

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

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

Type Parameters:

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

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

Type Parameters:

T - 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> Func0Builder<T> from(@Nonnull
                                                 java.util.concurrent.Callable<? extends T> call)

Construct a function from the given callable instance.

Type Parameters:

T - the return type

Parameters:

call - the callable instance

Returns:

the function builder

from

@Nonnull
public static Func0Builder<java.lang.Boolean> from(@Nonnull
                                                             java.util.concurrent.atomic.AtomicBoolean value)

Construct a function from the given atomic variable.

Parameters:

value - the atomic variable

Returns:

the function builder

from

@Nonnull
public static Func0Builder<java.lang.Integer> from(@Nonnull
                                                             java.util.concurrent.atomic.AtomicInteger value)

Construct a function from the given atomic variable.

Parameters:

value - the atomic variable

Returns:

the function builder

from

@Nonnull
public static Func0Builder<java.lang.Long> from(@Nonnull
                                                          java.util.concurrent.atomic.AtomicLong value)

Construct a function from the given atomic variable.

Parameters:

value - the atomic variable

Returns:

the function builder

from

@Nonnull
public static <T> Func0Builder<T> from(@Nonnull
                                                 java.util.concurrent.atomic.AtomicReference<? extends T> value)

Construct a function from the given atomic variable reference.

Type Parameters:

T - the value type of the reference

Parameters:

value - the atomic variable

Returns:

the function builder

alwaysTrue

@Nonnull
public static Func0Builder<java.lang.Boolean> alwaysTrue()

Returns:

a function builder which returns always true.

alwaysFalse

@Nonnull
public static Func0Builder<java.lang.Boolean> alwaysFalse()

Returns:

a function builder which retuns always false.

from

@Nonnull
public static <T> Func0Builder<T> from(@Nonnull
                                                 java.lang.ref.Reference<? extends T> ref)

Wraps the given reference object into a function call.

Note that the function may return null if the reference's object gets garbage collected.

Type Parameters:

T - the referenced object type

Parameters:

ref - the reference to wrap

Returns:

the function builder

not

@Nonnull
public Func0Builder<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 Func0Builder<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 Func0Builder<java.lang.Boolean> or(@Nonnull
                                                    Func0<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

xor

@Nonnull
public Func0Builder<java.lang.Boolean> xor(@Nonnull
                                                     Func0<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

toCallable

@Nonnull
public java.util.concurrent.Callable<T> toCallable()

Returns:

convert this function into a callable instance.

toFunc1

@Nonnull
public <U> Func1Builder<U,T> toFunc1()

Type Parameters:

U - the function parameter (irrelevant)

Returns:

convert this function by wrapping it into a 1 parameter function builder.

toFunc2

@Nonnull
public <U,V> Func2Builder<U,V,T> toFunc2()

Type Parameters:

U - the function first parameter (irrelevant)

V - the function second parameter (irrelevant)

Returns:

convert this function by wrapping it into a 1 parameter function builder.