org.openzen.zengarden.watched

Class GuardedInt

java.lang.Object

org.openzen.zengarden.watched.GuardedInt

All Implemented Interfaces:

WatchedInt, WatchedValue<java.lang.Integer>

public class GuardedInt
extends java.lang.Object
implements WatchedInt

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

Constructor Summary

Constructors

Constructor and Description
GuardedInt(WatchedInt value, IntPredicate test)

Method Summary

Modifier and Type	Method and Description
int	get()
WatchedInt	guard(IntPredicate test)
WatchedInt	lock()
void	set(int value)
ListenerHandle<?>	whenChanged(EventListener<AfterChangeEvent<java.lang.Integer>> listener)
ListenerHandle<?>	whenGoingToChange(EventListener<BeforeChangeEvent<java.lang.Integer>> 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.WatchedInt

of

Constructor Detail

GuardedInt

public GuardedInt(WatchedInt value,
                  IntPredicate test)

Method Detail

get

public int get()

Specified by:

get in interface WatchedInt

set

public void set(int value)

Specified by:

set in interface WatchedInt

lock

public WatchedInt lock()

Specified by:

lock in interface WatchedInt

Specified by:

lock in interface WatchedValue<java.lang.Integer>

whenGoingToChange

public ListenerHandle<?> whenGoingToChange(EventListener<BeforeChangeEvent<java.lang.Integer>> 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<java.lang.Integer>

Parameters:

listener - listener to register

Returns:

listener handle (used to remove the listener)

whenChanged

public ListenerHandle<?> whenChanged(EventListener<AfterChangeEvent<java.lang.Integer>> listener)

Specified by:

whenChanged in interface WatchedValue<java.lang.Integer>

guard

public WatchedInt guard(IntPredicate test)

Specified by:

guard in interface WatchedInt