Class AbstractTextComponentValue<C extends JTextComponent, T>

Type Parameters:
C - the component type
T - the value type
All Implemented Interfaces:
Listeners.Superseding, Observable<T>, Observer<T>, Sensor, Value<T>, ComponentValue<C,T>

public abstract class AbstractTextComponentValue<C extends JTextComponent, T> extends AbstractComponentValue<C,T>
An abstract ComponentValue implementation for a text component. Handles value notification.
  • Constructor Details

    • AbstractTextComponentValue

      protected AbstractTextComponentValue(C component)
      Instantiates a new AbstractTextComponentValue, with the UpdateOn.VALUE_CHANGE update on policy and no null value.
      Parameters:
      component - the component
    • AbstractTextComponentValue

      protected AbstractTextComponentValue(C component, @Nullable T nullValue)
      Instantiates a new AbstractTextComponentValue, with the UpdateOn.VALUE_CHANGE update on policy.
      Parameters:
      component - the component
      nullValue - the value to use instead of null
    • AbstractTextComponentValue

      protected AbstractTextComponentValue(C component, @Nullable T nullValue, UpdateOn updateOn)
      Instantiates a new AbstractComponentValue
      Parameters:
      component - the component
      nullValue - the value to use instead of null
      updateOn - the update on policy
      Throws:
      NullPointerException - in case component is null
  • Method Details

    • validateChanges

      protected final boolean validateChanges()
      Returns false, a text edit being validated by the document filter, if any, before it is applied, and notified in steps, such as when replacing a selection.
      Overrides:
      validateChanges in class AbstractComponentValue<C extends JTextComponent, T>
      Returns:
      false
    • observable

      public Observable<T> observable()
      Specified by:
      observable in interface Value<T>
      Returns:
      a read-only Observable instance for this value
    • changed

      public final ChangeObserver<T> changed()
      Description copied from interface: Observable
      The default implementation returns a new ChangeObserver instance on each call, but subclasses are free to return the same instance.

      Note that when a new instance is returned per call, a listener added through one changed() instance can only be removed through that same instance; retain it if the listener must later be removed.

      The instance subscribes to this observable only while it, its ChangeObserver.previous() or its ChangeObserver.current() has listeners or consumers, so one never listened to costs nothing, and one whose listeners and consumers are all removed is left to be collected. One whose weak listeners and consumers have all been collected unsubscribes at the next change.

      The observer is notified when this observable notifies a value differing from the one before, by Objects.deepEquals(Object, Object). An equal value, a refreshed instance for example, isn't reported, but replaces the one before as the Change.previous() of the next change.

      Specified by:
      changed in interface Observable<T>
      Returns:
      a ChangeObserver instance notified when this observable has changed
    • locked

      public final Value.Locked locked()
      Description copied from interface: Value

      Locking a value prevents it from being changed, it does not prevent it from being set.

      Note that locking a value does not prevent linked values from being changed.

      A locked value in a linked value chain, may cause it to go out of sync, since any subsequent linked values will not be updated after a locked value is encountered.

      Specified by:
      locked in interface Value<T>
      Returns:
      the Value.Locked instance controlling whether this value is locked
    • isNullable

      public final boolean isNullable()
      Description copied from interface: Observable
      If false then get() is guaranteed to never return null.
      Specified by:
      isNullable in interface Observable<T>
      Returns:
      true if this observable can be null
    • 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.

      The two behave as one logical value: either end validates against both ends' validators, before either is written, so the pair can not come to hold a value one end rejects. This holds for any Value, Value.validate(Object) being the gate.

      Each end updates the other from a listener, notified in turn with the others, so the pair can diverge where that update does not happen: a listener added before it throwing, which ends the notification, or the other end locked. A non-null value linked to a nullable one holding null holds its null value in its place.

      Cycle detection reaches as far as the framework's own link bookkeeping, which means every value extending AbstractValue. A Value implemented from scratch keeps its own links, if it has any, so a cycle running through one is not detected - the reciprocal update guard still keeps a single link from cycling back on itself.

      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(Observable<T> observable)
      Description copied from interface: Value
      Creates a unidirectional link between this value and the given observable, so that changes in the observable are reflected in this one. Note that after a call to this method the value of this value is the same as the observable.
      Specified by:
      link in interface Value<T>
      Parameters:
      observable - the observable to link this value to
    • unlink

      public final void unlink(Observable<T> observable)
      Description copied from interface: Value
      Unlinks this value from the given observable
      Specified by:
      unlink in interface Value<T>
      Parameters:
      observable - the observable to unlink
    • addValidator

      public final boolean addValidator(Value.Validator<? super 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
      Returns:
      true if this value did not already contain the specified validator
    • removeValidator

      public final boolean removeValidator(Value.Validator<? super 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
      Returns:
      true if this value contained the specified validator
    • validate

      public final void validate(T value)
      Description copied from interface: Value
      Validates the given value using all validators, as Value.set(Object) does, the null value standing in for null in case of a non-null value.
      Specified by:
      validate in interface Value<T>
      Parameters:
      value - the value to validate
    • notifyObserver

      protected final void notifyObserver()
      Notifies the underlying observer that the underlying value has changed or at least that it may have changed, in case shouldNotify(Object) allows it.
    • createObservable

      protected Observable<T> createObservable()
      Returns:
      a new Observable instance representing this value