AbstractValueProperty (JavaDocs for mmm-all dev-SNAPSHOT)

java.lang.Object
- net.sf.mmm.util.property.api.AbstractProperty<V>
- - net.sf.mmm.util.property.api.AbstractValueProperty<V>

Type Parameters:

V - is the generic type of the value.

All Implemented Interfaces:

Cloneable, javafx.beans.Observable, javafx.beans.property.Property<V>, javafx.beans.property.ReadOnlyProperty<V>, javafx.beans.value.ObservableValue<V>, javafx.beans.value.WritableValue<V>, JsonSupport, AttributeReadName, AttributeReadValue<V>, AttributeWriteValue<V>, PropertyPath<V>, ReadableProperty<V>, WritableProperty<V>

Direct Known Subclasses:

AbstractContainerProperty, AbstractRegularProperty
```
public abstract class AbstractValueProperty<V>
extends AbstractProperty<V>
```
This is the implementation of WritableProperty.

Since:

8.0.0

Author:

hohwille

Nested Class Summary
- Nested classes/interfaces inherited from class net.sf.mmm.util.property.api.AbstractProperty
  AbstractProperty.PropertyBuilder<T extends AbstractProperty<? extends V>>

Field Summary

Fields
Modifier and Type	Field and Description
`private javafx.beans.value.ObservableValue<? extends V>`	`binding`
`private javafx.beans.InvalidationListener`	`bindingListener`
`private Supplier<? extends V>`	`expression`
`private boolean`	`readOnly`
`private AbstractValueProperty<V>`	`readOnlyProperty`
`private ValidationFailure`	`validationResult`

Fields inherited from interface net.sf.mmm.util.property.api.WritableProperty
NO_PROPERTIES

Fields inherited from interface net.sf.mmm.util.json.api.JsonSupport
PROPERTY_TYPE

Constructor Summary

Constructors
Constructor and Description
`AbstractValueProperty(String name, Bean bean)` The constructor.
`AbstractValueProperty(String name, Bean bean, AbstractValidator<? super V> validator)` The constructor.
`AbstractValueProperty(String name, Bean bean, Supplier<? extends V> expression)` The constructor.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`bind(javafx.beans.value.ObservableValue<? extends V> observable)`
`void`	`bindBidirectional(javafx.beans.property.Property<V> other)`
`(package private) void`	`bindInternal(javafx.beans.value.ObservableValue<? extends V> observable)`
`protected void`	`clearValidationResult()` Clears the cached internal `validation` result.
`protected AbstractValueProperty<V>`	`copy()`
`protected abstract V`	`doGetValue()`
`protected abstract boolean`	`doSetValue(V newValue)` Called from `setValue(Object)`.
`boolean`	`equals(Object obj)`
`WritableProperty<V>`	`getReadOnly()`
`V`	`getValue()` This method gets the value of this object.
`int`	`hashCode()`
`protected void`	`invalidated()` May be overridden to receive invalidation notifications.
`boolean`	`isBound()`
`boolean`	`isReadOnly()`
`boolean`	`isValid()`
`protected void`	`markInvalid()` Invalidates this property.
`protected void`	`requireWritable()`
`void`	`setValue(V value)` This method sets the `value`.
`void`	`unbind()`
`void`	`unbindBidirectional(javafx.beans.property.Property<V> other)`
`ValidationFailure`	`validate()`

Methods inherited from class net.sf.mmm.util.property.api.AbstractProperty
assignValueFrom, clone, copy, copy, copy, copy, copy, fireValueChangedEvent, getBean, getJsonUtil, getName, getValidator, isMandatory, toJson, toJson, toString, withValdidator, withValdidator

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.sf.mmm.util.property.api.WritableProperty
getReadOnly

Methods inherited from interface net.sf.mmm.util.property.api.ReadableProperty
getType

Methods inherited from interface javafx.beans.value.ObservableValue
addListener, removeListener

Methods inherited from interface javafx.beans.Observable
addListener, removeListener

Methods inherited from interface net.sf.mmm.util.json.api.JsonSupport
fromJson

- Field Detail
  - validationResult
```
private ValidationFailure validationResult
```
  - readOnly
```
private boolean readOnly
```
  - readOnlyProperty
```
private AbstractValueProperty<V> readOnlyProperty
```
  - binding
```
private javafx.beans.value.ObservableValue<? extends V> binding
```
  - bindingListener
```
private javafx.beans.InvalidationListener bindingListener
```
  - expression
```
private Supplier<? extends V> expression
```
- Constructor Detail
  - AbstractValueProperty
```
public AbstractValueProperty(String name,
                             Bean bean)
```
    The constructor.
    
    Parameters:
    
    name - - see AbstractProperty.getName().
    
    bean - - see AbstractProperty.getBean().
  - AbstractValueProperty
```
public AbstractValueProperty(String name,
                             Bean bean,
                             AbstractValidator<? super V> validator)
```
    The constructor.
    
    Parameters:
    
    name - - see AbstractProperty.getName().
    
    bean - - see AbstractProperty.getBean().
    
    validator - - see validate().
  - AbstractValueProperty
```
public AbstractValueProperty(String name,
                             Bean bean,
                             Supplier<? extends V> expression)
```
    The constructor.
    
    Parameters:
    
    name - - see AbstractProperty.getName().
    
    bean - - see AbstractProperty.getBean().
    
    expression - the Supplier providing the actual value.
- Method Detail
  - copy
```
protected AbstractValueProperty<V> copy()
```
    Overrides:
    
    copy in class AbstractProperty<V>
    
    Returns:
    
    a new empty instance of this property.
  - getValue
```
public final V getValue()
```
    Description copied from interface: AttributeReadValue
    
    This method gets the value of this object.
    
    Returns:
    
    the value of this object. May be null unless otherwise stated.
  - doGetValue
```
protected abstract V doGetValue()
```
    Returns:
    
    the internal value.
  - bind
```
public void bind(javafx.beans.value.ObservableValue<? extends V> observable)
```
  - bindInternal
```
void bindInternal(javafx.beans.value.ObservableValue<? extends V> observable)
```
  - unbind
```
public void unbind()
```
  - isBound
```
public boolean isBound()
```
  - bindBidirectional
```
public void bindBidirectional(javafx.beans.property.Property<V> other)
```
  - unbindBidirectional
```
public void unbindBidirectional(javafx.beans.property.Property<V> other)
```
  - setValue
```
public void setValue(V value)
```
    Description copied from interface: AttributeWriteValue
    
    This method sets the value.
    
    Parameters:
    
    value - is the new value. May be null unless otherwise stated.
  - requireWritable
```
protected final void requireWritable()
                              throws ReadOnlyException
```
    Throws:
    
    ReadOnlyException - if this property is read-only.
  - doSetValue
```
protected abstract boolean doSetValue(V newValue)
```
    Called from setValue(Object).
    
    Parameters:
    
    newValue - the new value to set.
    
    Returns:
    
    true if the value has changed, false otherwise.
  - markInvalid
```
protected void markInvalid()
```
    Invalidates this property.
  - invalidated
```
protected void invalidated()
```
    May be overridden to receive invalidation notifications.
  - isValid
```
public boolean isValid()
```
    Returns:
    
    true if valid, false otherwise.
    
    See Also:
    
    WritableProperty.validate()
  - clearValidationResult
```
protected void clearValidationResult()
```
    Clears the cached internal validation result. Has to be called if the value has changed (from an external call).
  - validate
```
public ValidationFailure validate()
```
    Returns:
    
    the ValidationFailure or null if the value is valid.
    
    See Also:
    
    ValueValidator.validate(Object)
  - getReadOnly
```
public WritableProperty<V> getReadOnly()
```
    Returns:
    
    the read only view on this property.
  - isReadOnly
```
public final boolean isReadOnly()
```
    Returns:
    
    true if this property is read-only and WritableValue.setValue(Object) will fail with an exception, false otherwise.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AbstractProperty<V>
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AbstractProperty<V>

Class AbstractValueProperty<V>

Nested Class Summary

Nested classes/interfaces inherited from class net.sf.mmm.util.property.api.AbstractProperty

Field Summary

Fields inherited from interface net.sf.mmm.util.property.api.WritableProperty

Fields inherited from interface net.sf.mmm.util.json.api.JsonSupport

Constructor Summary

Method Summary

Methods inherited from class net.sf.mmm.util.property.api.AbstractProperty

Methods inherited from class java.lang.Object

Methods inherited from interface net.sf.mmm.util.property.api.WritableProperty

Methods inherited from interface net.sf.mmm.util.property.api.ReadableProperty

Methods inherited from interface javafx.beans.value.ObservableValue

Methods inherited from interface javafx.beans.Observable

Methods inherited from interface net.sf.mmm.util.json.api.JsonSupport

Field Detail

validationResult

readOnly

readOnlyProperty

binding

bindingListener

expression

Constructor Detail

AbstractValueProperty

AbstractValueProperty

AbstractValueProperty

Method Detail

copy

getValue

doGetValue

bind

bindInternal

unbind

isBound

bindBidirectional

unbindBidirectional

setValue

requireWritable

doSetValue

markInvalid

invalidated

isValid

clearValidationResult

validate

getReadOnly

isReadOnly

hashCode

equals