com.diffplug.common.rx

Interface Chit

All Known Implementing Classes:

Chit.Settable

public interface Chit

Makes it possible to receive a notification when a resource is disposed. Oftentimes, a UI resource (such as a dialog) is subject to disposal. There might be a long-running task in a non-UI thread which should be cancelled if the dialog is closed. This interface provides a clean abstraction for guaranteeing that an action is taken in response to a resource being disposed, with exact semantics on the UI thread, and eventually-consistent semantics on other threads.

See Also:

com.diffplug.common.swt.SwtRx#disposableEar(Widget)

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Chit.Settable The standard implementation of DisposableEar.

Method Summary

Modifier and Type	Method and Description
static Chit	alreadyDisposed() Returns a Chit which has already been disposed.
default Runnable	guard(Runnable delegate) Wraps the runnable such that it will only run iff the disposable has not been disposed, according to isDisposed().
boolean	isDisposed() Returns whether the resource is disposed.
void	runWhenDisposed(Runnable whenDisposed) Adds a listener which will run when the given element is disposed.
static Chit.Settable	settable() Creates a Settable Disposable ear.

Method Detail

isDisposed

boolean isDisposed()

Returns whether the resource is disposed. May be called from any thread, and may suffer from glitches, but only of the kind where the resource is actually disposed but this method incorrectly returns false due to a threading glitch which will eventually be resolved.

runWhenDisposed

void runWhenDisposed(Runnable whenDisposed)

Adds a listener which will run when the given element is disposed. The runnable might be executed on any thread. If the element has already been disposed (subject to the glitch constraints of isDisposed()), the runnable will be executed immediately.

guard

default Runnable guard(Runnable delegate)

Wraps the runnable such that it will only run iff the disposable has not been disposed, according to isDisposed().

alreadyDisposed

static Chit alreadyDisposed()

Returns a Chit which has already been disposed.

settable

static Chit.Settable settable()

Creates a Settable Disposable ear.