Package dev.prozilla.pine.common.property.observable

Class ObservableProperty<T>

java.lang.Object

dev.prozilla.pine.common.property.VariableProperty<T>

dev.prozilla.pine.common.property.MutableProperty<T>

dev.prozilla.pine.common.property.observable.ObservableProperty<T>

All Implemented Interfaces:

Destructible

Direct Known Subclasses:

ConfigOption, SelectionProperty

public class ObservableProperty<T>
extends MutableProperty<T>
implements Destructible

A property that triggers observers whenever its value changes.

Field Summary

Fields

Modifier and Type	Field	Description
protected Logger	logger

Fields inherited from class dev.prozilla.pine.common.property.VariableProperty

random

Constructor Summary

Constructors

Constructor	Description
ObservableProperty()	Creates an observable property without an initial value.
ObservableProperty(T initialValue)	Creates an observable property with an initial value.

Method Summary

Modifier and Type	Method	Description
Observer<T>	addObserver(Observer<T> observer)
void	destroy()	Removes all observers.
protected Logger	getLogger()
protected void	onValueChange(T oldValue, T newValue)	Triggers all observers with the newValue whenever the value changes.
void	read(Observer<T> reader)	Adds an observer that is immediately called with the current value.
void	removeObserver(Observer<T> observer)
void	setLogger(Logger logger)	Sets the logger of this property, which is used to log errors thrown by observers.

Methods inherited from class dev.prozilla.pine.common.property.MutableProperty

getValue, setValue

Methods inherited from class dev.prozilla.pine.common.property.VariableProperty

exists, hasValue

Methods inherited from class java.lang.Object

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

Field Details

logger

protected Logger logger

Constructor Details

ObservableProperty

public ObservableProperty()

Creates an observable property without an initial value.

ObservableProperty

public ObservableProperty(T initialValue)

Creates an observable property with an initial value.

Parameters:

initialValue - The initial value

Method Details

read

public void read(Observer<T> reader)

Adds an observer that is immediately called with the current value.

This is the equivalent of calling MutableProperty.getValue(), then doing something with that value, and then adding an observer which does the same thing each time the value changes.

Parameters:

reader - The observer

addObserver

public Observer<T> addObserver(Observer<T> observer)

removeObserver

public void removeObserver(Observer<T> observer)

setLogger

public void setLogger(Logger logger)

Sets the logger of this property, which is used to log errors thrown by observers.

onValueChange

protected void onValueChange(T oldValue,
 T newValue)

Triggers all observers with the newValue whenever the value changes.

Overrides:

onValueChange in class MutableProperty<T>

Parameters:

oldValue - The previous value

newValue - The new value

getLogger

protected Logger getLogger()

destroy

public void destroy()

Removes all observers.

Specified by:

destroy in interface Destructible