arez

Class Component

java.lang.Object

arez.Component

All Implemented Interfaces:

Disposable

public final class Component
extends java.lang.Object
implements Disposable

The component is an abstraction representation of a reactive component within Arez. Each component is made up of one or more of the core Arez reactive elements: Observables, Observers or ComputedValues.

Method Summary

Modifier and Type	Method and Description
void	complete() The toolkit user should call this method when the component is complete.
void	dispose() Dispose the element.
java.lang.Object	getId() Return the unique id of the component.
java.lang.String	getName() Return the unique name of the component.
java.lang.String	getType() Return the component type.
boolean	isComplete() Return true if the creation of this component is complete.
boolean	isDisposed() Return true if dispose() has been called on object.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface arez.Disposable

asDisposable, dispose, isDisposed

Method Detail

getType

@Nonnull
public java.lang.String getType()

Return the component type. This is an opaque string specified by the user.

Returns:

the component type.

getId

@Nonnull
public java.lang.Object getId()

Return the unique id of the component. This will return null for singletons.

Returns:

the unique id of the component.

getName

@Nonnull
public java.lang.String getName()

Return the unique name of the component.

Returns:

the name of the component.

dispose

public void dispose()

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

Specified by:

dispose in interface Disposable

isDisposed

public 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).

Specified by:

isDisposed in interface Disposable

Returns:

true if dispose has been called.

toString

@Nonnull
public final java.lang.String toString()

Overrides:

toString in class java.lang.Object

isComplete

public boolean isComplete()

Return true if the creation of this component is complete.

Returns:

true if the creation of this component is complete, false otherwise.

complete

public void complete()

The toolkit user should call this method when the component is complete. After this method has been invoked the user should not attempt to define any more Observables, Observers or ComputedValues on the component.