Module io.github.mmm.value.observable

Package io.github.mmm.value.observable

Interface WritableObservableValue<V>

Type Parameters:

V - type of the value.

All Superinterfaces:

EventSource<ObservableEvent<V>,ObservableEventListener<? super V>>, ObservableValue<V>, ReadableValue<V>, Supplier<V>, WritableValue<V>

All Known Implementing Classes:

AbstractWritableObservableValue

public interface WritableObservableValue<V>
extends ObservableValue<V>, WritableValue<V>

ObservableValue that is writable and allows to set its value.

Since:

1.0.0

Method Summary

Modifier and Type	Method	Description
void	bindOneWay(ObservableValue<? extends V> observable)	Creates a unidirection binding for this object. ATTENTION: An unidirectional binding is very strict.
void	bindTwoWay(WritableObservableValue<V> other)	Create a bidirectional binding between this object and the given one.
boolean	isBoundOneWay()
void	unbindOneWay()	Removes the unidirectional binding from this object.
void	unbindTwoWay(WritableObservableValue<V> other)	Removes a bidirectional binding between this object and the given one.

Methods inherited from interface io.github.mmm.event.EventSource

addListener, addListener, addWeakListener, removeListener

Methods inherited from interface io.github.mmm.value.observable.ObservableValue

toString

Methods inherited from interface io.github.mmm.value.ReadableValue

get, getSafe

Methods inherited from interface io.github.mmm.value.WritableValue

set

Method Details

bindOneWay

void bindOneWay(ObservableValue<? extends V> observable)

Creates a unidirection binding for this object.
ATTENTION:
An unidirectional binding is very strict. It makes this object to appear exactly as the ObservableValue it is bound to. After creating the unidirectional binding, calls to WritableValue.set(Object) will fail. This is very different to an bidirectional binding.

Parameters:

observable - the ObservableValue this object should be bound to.

See Also:

• unbindOneWay()
• isBoundOneWay()

unbindOneWay

void unbindOneWay()

Removes the unidirectional binding from this object. If this object is not bound, this method has no effect.

See Also:

• bindOneWay(ObservableValue)

isBoundOneWay

boolean isBoundOneWay()

Returns:

true if this object is bound, false otherwise.

See Also:

• bindOneWay(ObservableValue)

bindTwoWay

void bindTwoWay(WritableObservableValue<V> other)

Create a bidirectional binding between this object and the given one. After a bidirectional binding, WritableValue.set(Object) on this object will propagate its value to the bound one and vice versa. Bidirectional bindings exists independently of unidirectional bindings. However, it is bad practice to combine both. It is possible to have multiple bidirectional bindings for the same object.

Parameters:

other - the other WritableObservableValue to bind bidirectional.

See Also:

• unbindTwoWay(WritableObservableValue)

unbindTwoWay

void unbindTwoWay(WritableObservableValue<V> other)

Removes a bidirectional binding between this object and the given one. If no bidirectional binding between these objects exists, this method has no effect. It is possible to unbind in inverse order. So to unbind two bidirectional bound objects it does not matter if you call unbindBidirectional on the first with the second as argument or vice versa.

Parameters:

other - the other WritableObservableValue to unbind bidirectional.

See Also:

• bindTwoWay(WritableObservableValue)