Module stasgora.observetree

Package io.github.stasgora.observetree

Class SettableProperty<T>

java.lang.Object

io.github.stasgora.observetree.Observable

io.github.stasgora.observetree.SettableProperty<T>

Type Parameters:

T - the type of the actual observable data type

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

SettableObservable

public class SettableProperty<T>
extends Observable
implements Serializable

A wrapper class that encapsulates another object - modelValue - and notifies it's listeners when it is set. equals() method is used to determine if defaultValue was changed. It supports defaultValue for the modelValue that can be set and reset to.

Author:

Stanisław Góra

See Also:

SettableObservable, Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected T	defaultValue	Default value of the encapsulated object
protected T	modelValue	Current value of the encapsulated object

Fields inherited from class io.github.stasgora.observetree.Observable

notificationMethod

Constructor Summary

Constructors

Constructor	Description
SettableProperty()	Constructs a new, empty SettableProperty with null modelValue
SettableProperty(T modelValue)	Constructs a new SettableProperty with the specified modelValue

Method Summary

Modifier and Type	Method	Description
T	get()	Returns the current modelValue of this SettableProperty
T	getDefaultValue()	Returns the defaultValue of this SettableProperty
void	modify(UnaryOperator<T> operator)	Modifies the modelValue of this SettableProperty inline
boolean	present()	Checks if the modelValue is not null
void	resetToDefaultValue()	Sets the modelValue of this SettableProperty to the defaultValue.
void	saveAsDefaultValue()	Sets the defaultValue of this SettableProperty to be equal to the current modelValue
void	set(T modelValue)	Sets the modelValue of this SettableProperty
void	setAndNotify(T modelValue)	Sets the modelValue and calls Observable.notifyListeners()
void	setDefaultValue(T defaultValue)	Sets the defaultValue of this SettableProperty

Methods inherited from class io.github.stasgora.observetree.Observable

add, add, add, addChild, addListener, addListener, addListener, addParent, addSubObservable, clearListeners, copyListeners, getChildren, getParents, isValueChanged, notifyListeners, onValueChanged, remove, removeChild, removeListener, removeParent, removeSubObservable, setUnchanged

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

modelValue

protected T modelValue

Current value of the encapsulated object

defaultValue

protected T defaultValue

Default value of the encapsulated object

Constructor Detail

SettableProperty

public SettableProperty()

Constructs a new, empty SettableProperty with null modelValue

SettableProperty

public SettableProperty(T modelValue)

Constructs a new SettableProperty with the specified modelValue

Parameters:

modelValue - a value to be set

Method Detail

present

public boolean present()

Checks if the modelValue is not null

Returns:

false if the modelValue is null, true otherwise

get

public T get()

Returns the current modelValue of this SettableProperty

Returns:

the current modelValue

set

public void set(T modelValue)

Sets the modelValue of this SettableProperty

Parameters:

modelValue - value to be set

setAndNotify

public void setAndNotify(T modelValue)

Sets the modelValue and calls Observable.notifyListeners()

Parameters:

modelValue - value to be set

modify

public void modify(UnaryOperator<T> operator)

Modifies the modelValue of this SettableProperty inline

Parameters:

operator - operation to be performed on modelValue

resetToDefaultValue

public void resetToDefaultValue()

Sets the modelValue of this SettableProperty to the defaultValue. If the defaultValue is null no action will be performed.

getDefaultValue

public T getDefaultValue()

Returns the defaultValue of this SettableProperty

Returns:

the defaultValue of this object

setDefaultValue

public void setDefaultValue(T defaultValue)

Sets the defaultValue of this SettableProperty

Parameters:

defaultValue - value to be set

saveAsDefaultValue

public void saveAsDefaultValue()

Sets the defaultValue of this SettableProperty to be equal to the current modelValue