net.sf.mmm.util.property.api

Class AbstractProperty<V>

java.lang.Object

net.sf.mmm.util.property.api.AbstractProperty<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:

AbstractValueProperty

public abstract class AbstractProperty<V>
extends Object
implements WritableProperty<V>, Cloneable

This is the implementation of WritableProperty.

Since:

8.0.0

Author:

hohwille

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AbstractProperty.PropertyBuilder<T extends AbstractProperty<? extends V>> Implementation of Builder to build a copy of the property.

Field Summary

Fields

Modifier and Type	Field and Description
private Bean	bean
private String	name
private AbstractValidator<? super V>	validator

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
AbstractProperty(String name, Bean bean) The constructor.
AbstractProperty(String name, Bean bean, AbstractValidator<? super V> validator) The constructor.

Method Summary

Modifier and Type	Method and Description
protected void	assignValueFrom(javafx.beans.value.ObservableValue<? extends V> observableValue) Assigns the value from the ObservableValue (typically a WritableProperty) to this property.
protected AbstractProperty<V>	clone()
protected AbstractProperty<V>	copy()
AbstractProperty<V>	copy(AbstractValidator<? super V> newValidator) Creates a new empty instance of this property with the given new parameters.
AbstractProperty<V>	copy(Bean newBean) Creates a new empty instance of this property with the given new parameters.
AbstractProperty<V>	copy(Bean newBean, AbstractValidator<? super V> newValidator) Creates a new empty instance of this property with the given new parameters.
AbstractProperty<V>	copy(String newName, Bean newBean) Creates a new empty instance of this property with the given new parameters.
AbstractProperty<V>	copy(String newName, Bean newBean, AbstractValidator<? super V> newValidator) Creates a new empty instance of this property with the given new parameters.
boolean	equals(Object obj)
protected abstract void	fireValueChangedEvent() Sends notifications to all attached InvalidationListeners and ChangeListeners.
Bean	getBean()
protected JsonUtil	getJsonUtil()
String	getName()
AbstractValidator<? super V>	getValidator()
int	hashCode()
boolean	isMandatory()
void	toJson(javax.json.stream.JsonGenerator json) Serializes this object as JSON (JavaScript-Object-Notation).
protected abstract void	toJson(javax.json.stream.JsonGenerator json, V value)
String	toString()
abstract ObjectValidatorBuilder<? extends V,? extends AbstractProperty.PropertyBuilder<? extends AbstractProperty<? extends V>>,?>	withValdidator()
protected <PROPERTY extends AbstractProperty<? extends V>,BUILDER extends ObjectValidatorBuilder<? extends V,AbstractProperty.PropertyBuilder<PROPERTY>,?>> BUILDER	withValdidator(Function<AbstractProperty.PropertyBuilder<PROPERTY>,BUILDER> factory)

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, getReadOnly, isReadOnly, isValid, validate

Methods inherited from interface javafx.beans.property.Property

bind, bindBidirectional, isBound, unbind, unbindBidirectional

Methods inherited from interface javafx.beans.value.WritableValue

getValue, setValue

Methods inherited from interface net.sf.mmm.util.lang.api.attribute.AttributeWriteValue

setValue

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

getType

Methods inherited from interface javafx.beans.value.ObservableValue

addListener, getValue, removeListener

Methods inherited from interface javafx.beans.Observable

addListener, removeListener

Methods inherited from interface net.sf.mmm.util.lang.api.attribute.AttributeReadValue

getValue

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

fromJson

Field Detail

name

private String name

bean

private Bean bean

validator

private AbstractValidator<? super V> validator

Constructor Detail

AbstractProperty

public AbstractProperty(String name,
                        Bean bean)

The constructor.

Parameters:

name - - see getName().

bean - - see getBean().

AbstractProperty

public AbstractProperty(String name,
                        Bean bean,
                        AbstractValidator<? super V> validator)

The constructor.

Parameters:

name - - see getName().

bean - - see getBean().

validator - - see WritableProperty.validate().

Method Detail

getName

public String getName()

Specified by:

getName in interface javafx.beans.property.ReadOnlyProperty<V>

Specified by:

getName in interface AttributeReadName

Specified by:

getName in interface PropertyPath<V>

Specified by:

getName in interface ReadableProperty<V>

Returns:

the name of the property. By convention it should start with a capital letter followed by alpha-numeric characters. The name of a single property must especially not contain the dot character (.) that is used to separate segments in a path.

getBean

public Bean getBean()

Specified by:

getBean in interface javafx.beans.property.ReadOnlyProperty<V>

Specified by:

getBean in interface ReadableProperty<V>

clone

protected AbstractProperty<V> clone()

Overrides:

clone in class Object

copy

protected AbstractProperty<V> copy()

Returns:

a new empty instance of this property.

copy

public final AbstractProperty<V> copy(Bean newBean)

Creates a new empty instance of this property with the given new parameters.

Parameters:

newBean - the new bean.

Returns:

the new property instance.

copy

public final AbstractProperty<V> copy(AbstractValidator<? super V> newValidator)

Creates a new empty instance of this property with the given new parameters.

Parameters:

newValidator - the new validator.

Returns:

the new property instance.

copy

public final AbstractProperty<V> copy(Bean newBean,
                                      AbstractValidator<? super V> newValidator)

Creates a new empty instance of this property with the given new parameters.

Parameters:

newBean - the new bean.

newValidator - the new validator.

Returns:

the new property instance.

copy

public final AbstractProperty<V> copy(String newName,
                                      Bean newBean)

Creates a new empty instance of this property with the given new parameters.

Parameters:

newName - the new name.

newBean - the new bean.

Returns:

the new property instance.

copy

public final AbstractProperty<V> copy(String newName,
                                      Bean newBean,
                                      AbstractValidator<? super V> newValidator)

Creates a new empty instance of this property with the given new parameters.

Parameters:

newName - the new name.

newBean - the new bean.

newValidator - the new validator.

Returns:

the new property instance.

assignValueFrom

protected void assignValueFrom(javafx.beans.value.ObservableValue<? extends V> observableValue)

Assigns the value from the ObservableValue (typically a WritableProperty) to this property. Can be overridden to avoid boxing overhead.

Parameters:

observableValue - the property to assign the value from.

fireValueChangedEvent

protected abstract void fireValueChangedEvent()

Sends notifications to all attached InvalidationListeners and ChangeListeners. This method is called when the value is changed, either manually by calling WritableValue.setValue(Object) or in case of a bound property, if the binding becomes invalid.

getValidator

public final AbstractValidator<? super V> getValidator()

Returns:

the AbstractValidator.

isMandatory

public final boolean isMandatory()

Specified by:

isMandatory in interface WritableProperty<V>

Returns:

true if this property is mandatory (a value of null is NOT valid.

withValdidator

protected <PROPERTY extends AbstractProperty<? extends V>,BUILDER extends ObjectValidatorBuilder<? extends V,AbstractProperty.PropertyBuilder<PROPERTY>,?>> BUILDER withValdidator(Function<AbstractProperty.PropertyBuilder<PROPERTY>,BUILDER> factory)

Type Parameters:

PROPERTY - the generic type of the AbstractProperty.

BUILDER - the generic type of the ObjectValidatorBuilder for <VALUE>.

Parameters:

factory - the Function to use as factory for the builder.

Returns:

a new builder for the validator of this property with a parent-builder to create a copy(AbstractValidator) of this property with the configured validator.

withValdidator

public abstract ObjectValidatorBuilder<? extends V,? extends AbstractProperty.PropertyBuilder<? extends AbstractProperty<? extends V>>,?> withValdidator()

Returns:

a new builder for the validator of this property with a parent-builder to create a copy(AbstractValidator) of this property with the configured validator.

toString

public final String toString()

Overrides:

toString in class Object

getJsonUtil

protected final JsonUtil getJsonUtil()

Returns:

the JsonUtil.

toJson

public final void toJson(javax.json.stream.JsonGenerator json)

Description copied from interface: JsonSupport

Serializes this object as JSON (JavaScript-Object-Notation).

Specified by:

toJson in interface JsonSupport

Parameters:

json - the JsonGenerator where to write this object to. Has to be in JsonGenerator.writeStartObject() state.

See Also:

JsonUtil.write(JsonGenerator, String, Object)

toJson

protected abstract void toJson(javax.json.stream.JsonGenerator json,
                               V value)

Parameters:

json - the JsonGenerator.

value - the value.

See Also:

toJson(JsonGenerator)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object