org.openzen.zengarden.watched

Class AbstractWatchedValue<T>

java.lang.Object

org.openzen.zengarden.watched.AbstractWatchedValue<T>

Type Parameters:

T - value type

All Implemented Interfaces:

WatchedValue<T>

Direct Known Subclasses:

BasicWatchedBoolean, BasicWatchedDouble, BasicWatchedInt, BasicWatchedLong, BasicWatchedObject, BasicWatchedString

public abstract class AbstractWatchedValue<T>
extends java.lang.Object
implements WatchedValue<T>

Abstract implementation for a WatchedValue. Contains listener handling.

Constructor Summary

Constructors

Constructor and Description
AbstractWatchedValue()

Method Summary

Modifier and Type	Method and Description
protected boolean	onBeforeChange(T oldValue, T newValue) Calls all event listeners.
protected void	onChanged(T oldValue, T newValue)
ListenerHandle<?>	whenChanged(EventListener<AfterChangeEvent<T>> listener)
ListenerHandle<?>	whenGoingToChange(EventListener<BeforeChangeEvent<T>> listener) Subscribes for value changes.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openzen.zengarden.watched.WatchedValue

lock

Constructor Detail

AbstractWatchedValue

public AbstractWatchedValue()

Method Detail

onBeforeChange

protected boolean onBeforeChange(T oldValue,
                                 T newValue)

Calls all event listeners. Also returns the canceled status.

Parameters:

oldValue - old value

newValue - new value

Returns:

true if the event was canceled, false otherwise

onChanged

protected void onChanged(T oldValue,
                         T newValue)

whenGoingToChange

public ListenerHandle<?> whenGoingToChange(EventListener<BeforeChangeEvent<T>> listener)

Description copied from interface: WatchedValue

Subscribes for value changes. The listener will be called before the value has been changed.

Specified by:

whenGoingToChange in interface WatchedValue<T>

Parameters:

listener - listener to register

Returns:

listener handle (used to remove the listener)

whenChanged

public ListenerHandle<?> whenChanged(EventListener<AfterChangeEvent<T>> listener)

Specified by:

whenChanged in interface WatchedValue<T>