Module is.codion.common.reactive

Package is.codion.common.reactive.value

Class AbstractValue.AbstractBuilder<T,B extends Value.Builder<T,B>>

java.lang.Object

is.codion.common.reactive.value.AbstractValue.AbstractBuilder<T,B>

Type Parameters:

T - the value type

B - the builder type

All Implemented Interfaces:

Value.Builder<T,B>

Enclosing class:

AbstractValue<T>

public abstract static class AbstractValue.AbstractBuilder<T,B extends Value.Builder<T,B>>
extends Object

An abstract base class for a value builder

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractBuilder()	Instantiates a new builder
protected	AbstractBuilder(T nullValue)	Instantiates a new builder

Method Summary

Modifier and Type	Method	Description
final B	changeConsumer(Consumer<ValueChange<? super T>> consumer)
final B	changeListener(Runnable listener)
final B	consumer(Consumer<? super T> consumer)
final B	link(Observable<T> observable)	Links the given observable to the resulting value
final B	link(Value<T> originalValue)	Links the given value to the resulting value
final B	listener(Runnable listener)
final B	locked(boolean locked)
final B	notify(Value.Notify notify)
protected T	prepareInitialValue()
final B	validator(Value.Validator<? super T> validator)	Adds a validator to the resulting value
final B	value(T value)
final B	weakChangeConsumer(Consumer<ValueChange<? super T>> weakConsumer)
final B	weakChangeListener(Runnable weakListener)
final B	weakConsumer(Consumer<? super T> weakConsumer)
final B	weakListener(Runnable weakListener)
final B	when(Predicate<T> predicate, Runnable listener)	Adds a conditional listener
final B	when(Predicate<T> predicate, Consumer<? super T> consumer)	Adds a conditional consumer
final B	when(T value, Runnable listener)	Adds a conditional listener
final B	when(T value, Consumer<? super T> consumer)	Adds a conditional consumer

Methods inherited from class java.lang.Object

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

Methods inherited from interface is.codion.common.reactive.value.Value.Builder

build

Constructor Details

AbstractBuilder

protected AbstractBuilder()

Instantiates a new builder

AbstractBuilder

protected AbstractBuilder(T nullValue)

Instantiates a new builder

Parameters:

nullValue - the null value, also used as the initial value

Throws:

NullPointerException - in case nullValue is null

Method Details

value

public final B value(T value)

Specified by:

value in interface Value.Builder<T,B extends Value.Builder<T,B>>

Parameters:

value - the initial value

Returns:

this builder instance

notify

public final B notify(Value.Notify notify)

Specified by:

notify in interface Value.Builder<T,B extends Value.Builder<T,B>>

Parameters:

notify - the notify policy for this value, default Value.Notify.CHANGED

Returns:

this builder instance

validator

public final B validator(Value.Validator<? super T> validator)

Description copied from interface: Value.Builder

Adds a validator to the resulting value

Specified by:

validator in interface Value.Builder<T,B extends Value.Builder<T,B>>

Parameters:

validator - the validator to add

Returns:

this builder instance

locked

public final B locked(boolean locked)

Specified by:

locked in interface Value.Builder<T,B extends Value.Builder<T,B>>

Parameters:

locked - true if the value should be locked

Returns:

this builder instance

See Also:

• Value.locked()

link

public final B link(Value<T> originalValue)

Description copied from interface: Value.Builder

Links the given value to the resulting value

Specified by:

link in interface Value.Builder<T,B extends Value.Builder<T,B>>

Parameters:

originalValue - the original value to link

Returns:

this builder instance

See Also:

• Value.link(Value)

link

public final B link(Observable<T> observable)

Description copied from interface: Value.Builder

Links the given observable to the resulting value

Specified by:

link in interface Value.Builder<T,B extends Value.Builder<T,B>>

Parameters:

observable - the value to link

Returns:

this builder instance

See Also:

• Value.link(Observable)

listener

public final B listener(Runnable listener)

Specified by:

listener in interface Value.Builder<T,B extends Value.Builder<T,B>>

Parameters:

listener - a listener to add

Returns:

this builder instance

consumer

public final B consumer(Consumer<? super T> consumer)

Specified by:

consumer in interface Value.Builder<T,B extends Value.Builder<T,B>>

Parameters:

consumer - a consumer to add

Returns:

this builder instance

weakListener

public final B weakListener(Runnable weakListener)

Specified by:

weakListener in interface Value.Builder<T,B extends Value.Builder<T,B>>

Parameters:

weakListener - a weak listener to add

Returns:

this builder instance

weakConsumer

public final B weakConsumer(Consumer<? super T> weakConsumer)

Specified by:

weakConsumer in interface Value.Builder<T,B extends Value.Builder<T,B>>

Parameters:

weakConsumer - a weak consumer to add

Returns:

this builder instance

changeListener

public final B changeListener(Runnable listener)

Specified by:

changeListener in interface Value.Builder<T,B extends Value.Builder<T,B>>

Parameters:

listener - a change listener to add

Returns:

this builder instance

See Also:

• Value.changed()

changeConsumer

public final B changeConsumer(Consumer<ValueChange<? super T>> consumer)

Specified by:

changeConsumer in interface Value.Builder<T,B extends Value.Builder<T,B>>

Parameters:

consumer - a change consumer to add

Returns:

this builder instance

See Also:

• Value.changed()

weakChangeListener

public final B weakChangeListener(Runnable weakListener)

Specified by:

weakChangeListener in interface Value.Builder<T,B extends Value.Builder<T,B>>

Parameters:

weakListener - a weak change listener to add

Returns:

this builder instance

See Also:

• Value.changed()

weakChangeConsumer

public final B weakChangeConsumer(Consumer<ValueChange<? super T>> weakConsumer)

Specified by:

weakChangeConsumer in interface Value.Builder<T,B extends Value.Builder<T,B>>

Parameters:

weakConsumer - a weak change consumer to add

Returns:

this builder instance

See Also:

• Value.changed()

when

public final B when(T value,
 Runnable listener)

Description copied from interface: Value.Builder

Adds a conditional listener

Specified by:

when in interface Value.Builder<T,B extends Value.Builder<T,B>>

Parameters:

value - the value on which to run

listener - the listener

Returns:

this builder instance

when

public final B when(T value,
 Consumer<? super T> consumer)

Description copied from interface: Value.Builder

Adds a conditional consumer

Specified by:

when in interface Value.Builder<T,B extends Value.Builder<T,B>>

Parameters:

value - the value to consume

consumer - the consumer

Returns:

this builder instance

when

public final B when(Predicate<T> predicate,
 Runnable listener)

Description copied from interface: Value.Builder

Adds a conditional listener

Specified by:

when in interface Value.Builder<T,B extends Value.Builder<T,B>>

Parameters:

predicate - the predicate on which to run

listener - the runnable

Returns:

this builder instance

when

public final B when(Predicate<T> predicate,
 Consumer<? super T> consumer)

Description copied from interface: Value.Builder

Adds a conditional consumer

Specified by:

when in interface Value.Builder<T,B extends Value.Builder<T,B>>

Parameters:

predicate - the predicate on which to consume the value

consumer - the consumer to use

Returns:

this builder instance

prepareInitialValue

protected T prepareInitialValue()

Returns:

the initial value