org.openzen.zengarden.watched

Class GuardedObject<T>

java.lang.Object

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

All Implemented Interfaces:

WatchedObject<T>, WatchedValue<T>

public class GuardedObject<T>
extends java.lang.Object
implements WatchedObject<T>

Guarded version of a WatchedObject. Performs validation before applying the value, does nothing if validation fails.

Constructor Summary

Constructors

Constructor and Description
GuardedObject(WatchedObject<T> value, Predicate<T> test)

Method Summary

Modifier and Type	Method and Description
T	get()
WatchedObject<T>	guard(Predicate<T> test)
WatchedObject<T>	lock()
void	set(T value)
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.WatchedObject

of

Constructor Detail

GuardedObject

public GuardedObject(WatchedObject<T> value,
                     Predicate<T> test)

Method Detail

get

public T get()

Specified by:

get in interface WatchedObject<T>

set

public void set(T value)

Specified by:

set in interface WatchedObject<T>

lock

public WatchedObject<T> lock()

Specified by:

lock in interface WatchedObject<T>

Specified by:

lock in interface WatchedValue<T>

guard

public WatchedObject<T> guard(Predicate<T> test)

Specified by:

guard in interface WatchedObject<T>

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>