arez

Interface Disposable

All Known Implementing Classes:

Component, ComputedValue, Node, Observable, Observer

public interface Disposable

Interface that allows caller to release any resources associated with element. It is safe to invoke dispose() multiple times on a element. Dispose is considered a state modifying action and must be called either within an action where mutation is true or else it will start it's own transaction before performing dispose. Once an element is disposed, no other methods should be invoked on element.

Method Summary

Modifier and Type	Method and Description
static Disposable	asDisposable(java.lang.Object object) Cast specified object to instance of Disposable.
void	dispose() Dispose the element.
static void	dispose(java.lang.Object object) Dispose the supplied object if it is Disposable, else do nothing.
boolean	isDisposed() Return true if dispose() has been called on object.
static boolean	isDisposed(java.lang.Object object) Return true if the parameter is Disposable and has been disposed, else return false.

Method Detail

dispose

void dispose()

Dispose the element. See Disposable for a description of the implications.

isDisposed

boolean isDisposed()

Return true if dispose() has been called on object. This is very useful when the Disposable is a @Computed value representing the selected item in a UI component but the item can be disposed by other agents within the system. (i.e. The item was removed from the server).

Returns:

true if dispose has been called.

dispose

static void dispose(@Nonnull
                    java.lang.Object object)

Dispose the supplied object if it is Disposable, else do nothing.

Parameters:

object - the object to dispose.

isDisposed

static boolean isDisposed(@Nonnull
                          java.lang.Object object)

Return true if the parameter is Disposable and has been disposed, else return false.

Parameters:

object - the object to check disposed state.

Returns:

true if the parameter is Disposable and has been disposed, else return false.

asDisposable

@Nonnull
static Disposable asDisposable(@Nonnull
                                        java.lang.Object object)

Cast specified object to instance of Disposable. Invariant checks will verify that the cast is valid before proceeding.

Parameters:

object - the object to cast to Disposable.

Returns:

the object cast to Disposable.