hu.akarnokd.reactive4java.util

Class Actions

java.lang.Object

hu.akarnokd.reactive4java.util.Actions

public final class Actions
extends java.lang.Object

Helper class for Action interfaces.

Method Summary

Modifier and Type	Method and Description
static <T> Action0	asAction(Func0<T> func) Converts the given parameterless function into an action, which when invoked, invokes the original function and ignores its result.
static <T,U> Action1<T>	asAction(Func1<? super T,U> func) Converts the given 1 parameter function into an action, which when invoked, invokes the original function and ignores its result.
static <T,U,V> Action2<T,U>	asAction(Func2<? super T,? super U,V> func) Converts the given 2 parameter function into an action, which when invoked, invokes the original function and ignores its result.
static <T> Action0	asAction0(Func0<T> run) Wrap the supplied no-parameter function into an action.
static Action0	asAction0(java.lang.Runnable run) Wrap the supplied runnable into an action.
static <E extends java.lang.Exception> Action0E<E>	asAction0E(Action0 action) Wrap the given exception-less action.
static Action0E<java.io.IOException>	asAction0E(java.io.Closeable closeable) Wraps the given closeable instance into an Action0E.
static <T> Action1<T>	asAction1(Action0 run) Wrap the parameterless action into an Action1.
static <T,U> Action1<T>	asAction1(Func1<T,U> run) Wrap the supplied one-parameter function into an action.
static <T> Action1<T>	asAction1(java.lang.Runnable run) Wrap the supplied runnable into an action.
static <T,E extends java.lang.Exception> Action1E<T,E>	asAction1E(Action1<? super T> action) Wrap the given exception-less action.
static <T,U> Action2<T,U>	asAction2(Action0 run) Wrap the parameterless action into an Action2.
static <T,U,E extends java.lang.Exception> Action2E<T,U,E>	asAction2E(Action2<? super T,? super U> action) Wrap the given exception-less action.
static java.lang.Runnable	asRunnable(Action0 action) Wrap the given action into a runnable instance.
static Action0E<java.io.IOException>	close(java.io.Closeable c) Creates an action which will close the given closeable.
static Action0	closeSilently(java.io.Closeable c) Wraps the closeable into action and suppresses any close exception.
static <T,U> Action2<T,U>	dualAction(Action1<? super T> first, Action1<? super U> second) Returns a composite two parameter action from the supplied two actions which will be invoked for each of the parameters.
static <T,U,E extends java.lang.Exception> Action2E<T,U,E>	dualAction(Action1E<? super T,? extends E> first, Action1E<? super U,? extends E> second) Returns a composite two parameter action from the supplied two actions which will be invoked for each of the parameters; and allows throwing an exception.
static Action0	noAction0()
static <T> Action1<T>	noAction1() Returns an action which does nothing with its parameter.
static <T,U> Action2<T,U>	noAction2() Returns an action which does nothing with its parameter.

Methods inherited from class java.lang.Object

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

Method Detail

asAction0

@Nonnull
public static <T> Action0 asAction0(@Nonnull
                                              Func0<T> run)

Wrap the supplied no-parameter function into an action. The function's return value is ignored.

Type Parameters:

T - the return type of the function, irrelevant

Parameters:

run - the original runnable

Returns:

the Action0 wrapping the runnable

asAction0

@Nonnull
public static Action0 asAction0(@Nonnull
                                          java.lang.Runnable run)

Wrap the supplied runnable into an action.

Parameters:

run - the original runnable

Returns:

the Action0 wrapping the runnable

asAction1

@Nonnull
public static <T,U> Action1<T> asAction1(@Nonnull
                                                   Func1<T,U> run)

Wrap the supplied one-parameter function into an action. The function's return value is ignored.

Type Parameters:

T - the parameter type

U - the return type, irrelevant

Parameters:

run - the original runnable

Returns:

the Action0 wrapping the runnable

asAction1

@Nonnull
public static <T> Action1<T> asAction1(@Nonnull
                                                 Action0 run)

Wrap the parameterless action into an Action1. The function's return value is ignored.

Type Parameters:

T - the parameter type

Parameters:

run - the original action

Returns:

the Action0 wrapping the runnable

asAction2

@Nonnull
public static <T,U> Action2<T,U> asAction2(@Nonnull
                                                     Action0 run)

Wrap the parameterless action into an Action2. The function's return value is ignored.

Type Parameters:

T - the first parameter type

U - the second parameter type

Parameters:

run - the original action

Returns:

the Action0 wrapping the runnable

asAction1

@Nonnull
public static <T> Action1<T> asAction1(@Nonnull
                                                 java.lang.Runnable run)

Wrap the supplied runnable into an action.

Type Parameters:

T - the parameter type

Parameters:

run - the original runnable

Returns:

the Action0 wrapping the runnable

asRunnable

@Nonnull
public static java.lang.Runnable asRunnable(@Nonnull
                                                      Action0 action)

Wrap the given action into a runnable instance.

Parameters:

action - the target action

Returns:

the wrapper runnable

noAction0

@Nonnull
public static Action0 noAction0()

Returns:

returns an empty action which does nothing.

noAction1

@Nonnull
public static <T> Action1<T> noAction1()

Returns an action which does nothing with its parameter.

Type Parameters:

T - the type of the parameter (irrelevant)

Returns:

the action

Since:

0.96

noAction2

@Nonnull
public static <T,U> Action2<T,U> noAction2()

Returns an action which does nothing with its parameter.

Type Parameters:

T - the type of the first parameter (irrelevant)

U - the type of the second parameter (irrelevant)

Returns:

the action

Since:

0.96

dualAction

@Nonnull
public static <T,U> Action2<T,U> dualAction(@Nonnull
                                                      Action1<? super T> first,
                                                      @Nonnull
                                                      Action1<? super U> second)

Returns a composite two parameter action from the supplied two actions which will be invoked for each of the parameters.

Type Parameters:

T - the first parameter type

U - the second parameter type

Parameters:

first - the first action reacting to the first parameter

second - the second action reacting to the second parameter

Returns:

the action composite

Since:

0.96

dualAction

@Nonnull
public static <T,U,E extends java.lang.Exception> Action2E<T,U,E> dualAction(@Nonnull
                                                                                       Action1E<? super T,? extends E> first,
                                                                                       @Nonnull
                                                                                       Action1E<? super U,? extends E> second)

Returns a composite two parameter action from the supplied two actions which will be invoked for each of the parameters; and allows throwing an exception.

Type Parameters:

T - the first parameter type

U - the second parameter type

E - the exception type

Parameters:

first - the first action reacting to the first parameter

second - the second action reacting to the second parameter

Returns:

the action composite

Since:

0.96

asAction0E

@Nonnull
public static <E extends java.lang.Exception> Action0E<E> asAction0E(@Nonnull
                                                                               Action0 action)

Wrap the given exception-less action.

Type Parameters:

E - the exception type

Parameters:

action - the action to wrap

Returns:

the action with exception

Since:

0.96

asAction1E

@Nonnull
public static <T,E extends java.lang.Exception> Action1E<T,E> asAction1E(@Nonnull
                                                                                   Action1<? super T> action)

Wrap the given exception-less action.

Type Parameters:

T - the parameter type

E - the exception type

Parameters:

action - the action to wrap

Returns:

the action with exception

Since:

0.96

asAction2E

@Nonnull
public static <T,U,E extends java.lang.Exception> Action2E<T,U,E> asAction2E(@Nonnull
                                                                                       Action2<? super T,? super U> action)

Wrap the given exception-less action.

Type Parameters:

T - the first parameter type

U - the second parameter type

E - the exception type

Parameters:

action - the action to wrap

Returns:

the action with exception

Since:

0.96

close

@Nonnull
public static Action0E<java.io.IOException> close(@Nonnull
                                                            java.io.Closeable c)

Creates an action which will close the given closeable.

Parameters:

c - the closeable

Returns:

the action

Since:

0.96

closeSilently

@Nonnull
public static Action0 closeSilently(@Nonnull
                                              java.io.Closeable c)

Wraps the closeable into action and suppresses any close exception.

Parameters:

c - the closeable

Returns:

the action

Since:

0.96

asAction

@Nonnull
public static <T> Action0 asAction(@Nonnull
                                             Func0<T> func)

Converts the given parameterless function into an action, which when invoked, invokes the original function and ignores its result.

Type Parameters:

T - the function's return type

Parameters:

func - the function to wrap

Returns:

the created action

Since:

0.96

asAction

@Nonnull
public static <T,U> Action1<T> asAction(@Nonnull
                                                  Func1<? super T,U> func)

Converts the given 1 parameter function into an action, which when invoked, invokes the original function and ignores its result.

Type Parameters:

T - the action/function parameter

U - the function's return type

Parameters:

func - the function to wrap

Returns:

the created action

Since:

0.96

asAction

@Nonnull
public static <T,U,V> Action2<T,U> asAction(@Nonnull
                                                      Func2<? super T,? super U,V> func)

Converts the given 2 parameter function into an action, which when invoked, invokes the original function and ignores its result.

Type Parameters:

T - the first action/function parameter

U - the second action/function parameter

V - the function's return type

Parameters:

func - the function to wrap

Returns:

the created action

Since:

0.96

asAction0E

@Nonnull
public static Action0E<java.io.IOException> asAction0E(@Nonnull
                                                                 java.io.Closeable closeable)

Wraps the given closeable instance into an Action0E.

Parameters:

closeable - the closeable to call

Returns:

the Action0E created