org.openzen.zengarden.watched

Class GuardedString

java.lang.Object

org.openzen.zengarden.watched.GuardedString

All Implemented Interfaces:

WatchedString, WatchedValue<java.lang.String>

public class GuardedString
extends java.lang.Object
implements WatchedString

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

Constructor Summary

Constructors

Constructor and Description
GuardedString(WatchedString value, Predicate<java.lang.String> test)

Method Summary

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

apply, bind, bindTo, getUpdates, of

Constructor Detail

GuardedString

public GuardedString(WatchedString value,
                     Predicate<java.lang.String> test)

Method Detail

get

public java.lang.String get()

Specified by:

get in interface WatchedString

set

public void set(java.lang.String value)

Specified by:

set in interface WatchedString

lock

public WatchedString lock()

Specified by:

lock in interface WatchedString

Specified by:

lock in interface WatchedValue<java.lang.String>

guard

public WatchedString guard(Predicate<java.lang.String> test)

Specified by:

guard in interface WatchedString

whenGoingToChange

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

Parameters:

listener - listener to register

Returns:

listener handle (used to remove the listener)

whenChanged

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

Specified by:

whenChanged in interface WatchedValue<java.lang.String>