AbstractValue (Codion Framework API 0.17.16)

java.lang.Object
- is.codion.common.value.AbstractValue<T>

Type Parameters:

T - the value type

All Implemented Interfaces:

EventDataListener<T>, EventObserver<T>, Value<T>, ValueObserver<T>, Supplier<T>

Direct Known Subclasses:

AbstractComponentValue
```
public abstract class AbstractValue<T>
extends Object
implements Value<T>
```
An abstract Value implementation handling everything except the value itself.

The constructor parameter notifyOnSet specifies whether this Value instance should automatically call notifyValueChange() when the value is changed via set(Object). Some implementations may want to do this manually.

Nested Class Summary
- Nested classes/interfaces inherited from interface is.codion.common.value.Value
  Value.Validator<T>

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`AbstractValue()`
`protected`	`AbstractValue(T nullValue)` Creates an `AbstractValue` instance, which does not notify on set.
`protected`	`AbstractValue(T nullValue, boolean notifyOnSet)` Creates an `AbstractValue` instance.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addDataListener(EventDataListener<T> listener)` Adds `listener` to this `EventObserver`, adding the same listener a second time has no effect.
`void`	`addListener(EventListener listener)` Adds `listener` to this `EventObserver`, adding the same listener a second time has no effect.
`void`	`addValidator(Value.Validator<T> validator)` Adds a validator to this `Value`.
`protected EventObserver<T>`	`changeObserver()`
`boolean`	`isNullable()` If false then get() is guaranteed to never return null.
`void`	`link(Value<T> originalValue)` Creates a bidirectional link between this and the given original value, so that changes in one are reflected in the other.
`void`	`link(ValueObserver<T> originalValueObserver)` Creates a unidirectional link between this value and the given original value observer, so that changes in the original value are reflected in this one.
`Set<Value<T>>`	`linkedValues()`
`protected void`	`notifyValueChange()` Triggers the change event for this value, using the current value, indicating that the underlying value has changed or at least that it may have changed
`ValueObserver<T>`	`observer()` Returns a `ValueObserver` notified each time this value changes.
`void`	`onEvent(T data)` Called when the event occurs.
`void`	`removeDataListener(EventDataListener<T> listener)` Removes `listener` from this `EventObserver`
`void`	`removeListener(EventListener listener)` Removes `listener` from this `EventObserver`
`void`	`removeValidator(Value.Validator<T> validator)` Removes the given validator from this value
`void`	`set(T value)` Sets the value
`protected abstract void`	`setValue(T value)` Sets the actual internal value.
`void`	`unlink(Value<T> originalValue)` Unlinks this value from the given original value
`void`	`unlink(ValueObserver<T> originalValueObserver)` Unlinks this value from the given original value observer
`Collection<Value.Validator<T>>`	`validators()`

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.value.Value
propertyValue, value, value, value, value, value

Methods inherited from interface is.codion.common.value.ValueObserver
equalTo, isNotNull, isNull, toOptional

Methods inherited from interface java.util.function.Supplier
get

- Constructor Detail
  - AbstractValue
```
protected AbstractValue()
```
  - AbstractValue
```
protected AbstractValue(T nullValue)
```
    Creates an AbstractValue instance, which does not notify on set.
    
    Parameters:
    
    nullValue - the value to use instead of null
  - AbstractValue
```
protected AbstractValue(T nullValue,
                        boolean notifyOnSet)
```
    Creates an AbstractValue instance.
    
    Parameters:
    
    nullValue - the value to use instead of null
    
    notifyOnSet - specifies whether to automatically call notifyValueChange() when the value is changed via set(Object)
- Method Detail
  - set
```
public final void set(T value)
```
    Description copied from interface: Value
    
    Sets the value
    
    Specified by:
    
    set in interface Value<T>
    
    Parameters:
    
    value - the value
  - observer
```
public final ValueObserver<T> observer()
```
    Description copied from interface: Value
    
    Returns a ValueObserver notified each time this value changes.
    
    Specified by:
    
    observer in interface Value<T>
    
    Returns:
    
    a ValueObserver for this value
  - isNullable
```
public final boolean isNullable()
```
    Description copied from interface: ValueObserver
    
    If false then get() is guaranteed to never return null.
    
    Specified by:
    
    isNullable in interface ValueObserver<T>
    
    Returns:
    
    true if this value can be null
  - onEvent
```
public final void onEvent(T data)
```
    Description copied from interface: EventDataListener
    
    Called when the event occurs.
    
    Specified by:
    
    onEvent in interface EventDataListener<T>
    
    Parameters:
    
    data - information relating to the event.
  - addListener
```
public final void addListener(EventListener listener)
```
    Description copied from interface: EventObserver
    
    Adds listener to this EventObserver, adding the same listener a second time has no effect.
    
    Specified by:
    
    addListener in interface EventObserver<T>
    
    Parameters:
    
    listener - the listener to add
  - removeListener
```
public final void removeListener(EventListener listener)
```
    Description copied from interface: EventObserver
    
    Removes listener from this EventObserver
    
    Specified by:
    
    removeListener in interface EventObserver<T>
    
    Parameters:
    
    listener - the listener to remove
  - addDataListener
```
public final void addDataListener(EventDataListener<T> listener)
```
    Description copied from interface: EventObserver
    
    Adds listener to this EventObserver, adding the same listener a second time has no effect.
    
    Specified by:
    
    addDataListener in interface EventObserver<T>
    
    Parameters:
    
    listener - the listener to add
  - removeDataListener
```
public final void removeDataListener(EventDataListener<T> listener)
```
    Description copied from interface: EventObserver
    
    Removes listener from this EventObserver
    
    Specified by:
    
    removeDataListener in interface EventObserver<T>
    
    Parameters:
    
    listener - the listener to remove
  - link
```
public final void link(Value<T> originalValue)
```
    Description copied from interface: Value
    
    Creates a bidirectional link between this and the given original value, so that changes in one are reflected in the other. Note that after a call to this method this value is the same as originalValue.
    
    Specified by:
    
    link in interface Value<T>
    
    Parameters:
    
    originalValue - the original value to link this value to
  - unlink
```
public final void unlink(Value<T> originalValue)
```
    Description copied from interface: Value
    
    Unlinks this value from the given original value
    
    Specified by:
    
    unlink in interface Value<T>
    
    Parameters:
    
    originalValue - the original value to unlink from this one
  - link
```
public final void link(ValueObserver<T> originalValueObserver)
```
    Description copied from interface: Value
    
    Creates a unidirectional link between this value and the given original value observer, so that changes in the original value are reflected in this one. Note that after a call to this method the value of this value is the same as the original value.
    
    Specified by:
    
    link in interface Value<T>
    
    Parameters:
    
    originalValueObserver - the original value to link this value to
  - unlink
```
public final void unlink(ValueObserver<T> originalValueObserver)
```
    Description copied from interface: Value
    
    Unlinks this value from the given original value observer
    
    Specified by:
    
    unlink in interface Value<T>
    
    Parameters:
    
    originalValueObserver - the original value observer to unlink
  - linkedValues
```
public final Set<Value<T>> linkedValues()
```
    Specified by:
    
    linkedValues in interface Value<T>
    
    Returns:
    
    an unmodifiable set containing the values that have been linked to this value
  - addValidator
```
public final void addValidator(Value.Validator<T> validator)
```
    Description copied from interface: Value
    
    Adds a validator to this Value. Adding the same validator again has no effect.
    
    Specified by:
    
    addValidator in interface Value<T>
    
    Parameters:
    
    validator - the validator
  - removeValidator
```
public final void removeValidator(Value.Validator<T> validator)
```
    Description copied from interface: Value
    
    Removes the given validator from this value
    
    Specified by:
    
    removeValidator in interface Value<T>
    
    Parameters:
    
    validator - the validator
  - validators
```
public final Collection<Value.Validator<T>> validators()
```
    Specified by:
    
    validators in interface Value<T>
    
    Returns:
    
    the validators
  - setValue
```
protected abstract void setValue(T value)
```
    Sets the actual internal value.
    
    Parameters:
    
    value - the value
  - changeObserver
```
protected EventObserver<T> changeObserver()
```
    Returns:
    
    the change observer to use when adding listeners to this value
  - notifyValueChange
```
protected final void notifyValueChange()
```
    Triggers the change event for this value, using the current value, indicating that the underlying value has changed or at least that it may have changed

Class AbstractValue<T>

Nested Class Summary

Nested classes/interfaces inherited from interface is.codion.common.value.Value

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Methods inherited from interface is.codion.common.value.ValueObserver

Methods inherited from interface java.util.function.Supplier

Constructor Detail

AbstractValue

AbstractValue

AbstractValue

Method Detail

set

observer

isNullable

onEvent

addListener

removeListener

addDataListener

removeDataListener

link

unlink

link

unlink

linkedValues

addValidator

removeValidator

validators

setValue

changeObserver

notifyValueChange