org.openzen.zengarden.watched

Class GuardedDouble

java.lang.Object

org.openzen.zengarden.watched.GuardedDouble

All Implemented Interfaces:

WatchedDouble, WatchedValue<java.lang.Double>

public class GuardedDouble
extends java.lang.Object
implements WatchedDouble

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

Constructor Summary

Constructors

Constructor and Description
GuardedDouble(WatchedDouble value, DoublePredicate test)

Method Summary

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

of

Constructor Detail

GuardedDouble

public GuardedDouble(WatchedDouble value,
                     DoublePredicate test)

Method Detail

get

public double get()

Specified by:

get in interface WatchedDouble

set

public void set(double value)

Specified by:

set in interface WatchedDouble

lock

public WatchedDouble lock()

Specified by:

lock in interface WatchedDouble

Specified by:

lock in interface WatchedValue<java.lang.Double>

guard

public WatchedDouble guard(DoublePredicate test)

Specified by:

guard in interface WatchedDouble

whenGoingToChange

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

Parameters:

listener - listener to register

Returns:

listener handle (used to remove the listener)

whenChanged

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

Specified by:

whenChanged in interface WatchedValue<java.lang.Double>