org.codefx.libfx.concurrent.when

Class ExecuteWhen<T>

java.lang.Object

org.codefx.libfx.concurrent.when.ExecuteWhen<T>

Type Parameters:

T - the type the ObservableValue which will be observed by the constructed instance wraps

public class ExecuteWhen<T>
extends Object

Builder for ExecuteAlwaysWhen and ExecuteOnceWhen.

Example

A typical use would look like this:

        ObservableValue<State> workerState;
        ExecuteWhen.on(workerState)
                .when(state -> state == State.SUCCEEDED)
                .thenOnce(state -> logSuccess())
                .executeWhen();
 

Method Summary

Modifier and Type	Method and Description
static <T> ExecuteWhen<T>	on(javafx.beans.value.ObservableValue<T> observable) Creates a new builder.
ExecuteAlwaysWhen<T>	thenAlways(Consumer<? super T> action) Creates an instance which: observes the ObservableValue (specified for this builder's construction) for new values checks each new value against the condition set with when(Predicate) (calling which is required) executes the specified action every time a value fulfills the condition Note that the observation does not start until ExecuteAlwaysWhen.executeWhen() is called.
ExecuteOnceWhen<T>	thenOnce(Consumer<? super T> action) Creates an instance which: observes the ObservableValue (specified for this builder's construction) for new values checks each new value against the condition set with when(Predicate) (calling which is required) executes the specified action once if a value fulfills the condition Note that the observation does not start until ExecuteOnceWhen.executeWhen() is called.
ExecuteWhen<T>	when(Predicate<? super T> condition) Specifies the condition the observable's value must fulfill in order for the action to be executed.

Methods inherited from class java.lang.Object

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

Method Detail

on

public static <T> ExecuteWhen<T> on(javafx.beans.value.ObservableValue<T> observable)

Creates a new builder. The built instance of Execute...When will observe the specified observable.

Type Parameters:

T - the type the ObservableValue which will be observed by the constructed instance wraps

Parameters:

observable - the ObservableValue which will be observed by the created Execute...When instances

Returns:

a new builder instance

when

public ExecuteWhen<T> when(Predicate<? super T> condition)

Specifies the condition the observable's value must fulfill in order for the action to be executed.

Parameters:

condition - the condition as a Predicate

Returns:

this builder

thenOnce

public ExecuteOnceWhen<T> thenOnce(Consumer<? super T> action)
                            throws IllegalStateException

Creates an instance which:

• observes the ObservableValue (specified for this builder's construction) for new values
• checks each new value against the condition set with when(Predicate) (calling which is required)
• executes the specified action once if a value fulfills the condition

Note that the observation does not start until ExecuteOnceWhen.executeWhen() is called. See ExecuteOnceWhen for details.

Parameters:

action - the Consumer of the value which passed the condition

Returns:

an instance of ExecuteOnceWhen

Throws:

IllegalStateException - if when(Predicate) was not called

thenAlways

public ExecuteAlwaysWhen<T> thenAlways(Consumer<? super T> action)
                                throws IllegalStateException

Creates an instance which:

• observes the ObservableValue (specified for this builder's construction) for new values
• checks each new value against the condition set with when(Predicate) (calling which is required)
• executes the specified action every time a value fulfills the condition

Note that the observation does not start until ExecuteAlwaysWhen.executeWhen() is called. See ExecuteAlwaysWhen for details.

Parameters:

action - the Consumer of the value which passed the condition

Returns:

an instance of ExecuteOnceWhen

Throws:

IllegalStateException - if when(Predicate) was not called