Package net.apartium.cocoabeans.state

Class Watcher<T>

java.lang.Object

net.apartium.cocoabeans.state.Watcher<T>

Type Parameters:

T - element type

All Implemented Interfaces:

Observer

Direct Known Subclasses:

AttachedWatcher

@AvailableSince("0.0.39")
public class Watcher<T>
extends Object
implements Observer

An observer implementation attaching an action to an observable instance, performing it when its state changes and a heartbeat is triggered

See Also:

• Observable
• Observer
• AttachedWatcher

Field Summary

Fields

Modifier and Type	Field	Description
protected final Observable<T>	depends

Constructor Summary

Constructors

Constructor	Description
Watcher(Observable<T> depends, Consumer<T> consumer)	Constructs a new instance

Method Summary

Modifier and Type	Method	Description
void	detach()	Detaches the current watcher from its target observable.
void	flagAsDirty(Observable<?> observable)	Flag listener as dirty
void	heartbeat()	Trigger a heartbeat on this instance.

Methods inherited from class java.lang.Object

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

Field Details

depends

protected final Observable<T> depends

Constructor Details

Watcher

public Watcher(Observable<T> depends,
 Consumer<T> consumer)

Constructs a new instance

Parameters:

depends - parent state

consumer - action to perform on change

Method Details

heartbeat

public void heartbeat()

Trigger a heartbeat on this instance. If the value of the underlying observable has changed, trigger the action.

detach

public void detach()

Detaches the current watcher from its target observable.

flagAsDirty

public void flagAsDirty(Observable<?> observable)

Flag listener as dirty

Specified by:

flagAsDirty in interface Observer

Parameters:

observable - marking observable