com.gluonhq.charm.connect.service

Interface CharmObservable

All Known Subinterfaces:

CharmObservableList<E>, CharmObservableObject<T>

public interface CharmObservable

Property Summary

Type	Property and Description
javafx.beans.property.ReadOnlyObjectProperty<java.lang.Throwable>	exception
javafx.beans.property.ReadOnlyObjectProperty<CharmObservable.State>	state

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CharmObservable.State The possible states a CharmObservable can be in.

Method Summary

Modifier and Type	Method and Description
javafx.beans.property.ReadOnlyObjectProperty<java.lang.Throwable>	exceptionProperty()
java.lang.Throwable	getException() In case an exception occurred during processing, this method will return the exception.
java.lang.String	getIdentifier() Returns the unique identifier that is associated with this instance.
CharmObservable.State	getState() Return the current state of this observable.
StorageWhere	getStorageWhere() Returns the system where this instance will be stored.
javafx.beans.property.ReadOnlyObjectProperty<CharmObservable.State>	stateProperty()
void	sync() Performs a synchronization of this observable with the underlying storage system.

Property Detail

state

javafx.beans.property.ReadOnlyObjectProperty<CharmObservable.State> stateProperty

See Also:

getState()

exception

javafx.beans.property.ReadOnlyObjectProperty<java.lang.Throwable> exceptionProperty

See Also:

getException()

Method Detail

getState

CharmObservable.State getState()

Return the current state of this observable.

Returns:

the current state

stateProperty

javafx.beans.property.ReadOnlyObjectProperty<CharmObservable.State> stateProperty()

See Also:

getState()

getException

java.lang.Throwable getException()

In case an exception occurred during processing, this method will return the exception. Otherwise, null will be returned.

Returns:

the exception, if one has occurred; otherwise null.

exceptionProperty

javafx.beans.property.ReadOnlyObjectProperty<java.lang.Throwable> exceptionProperty()

See Also:

getException()

getIdentifier

java.lang.String getIdentifier()

Returns the unique identifier that is associated with this instance.

Returns:

the unique identifier of this observable instance

getStorageWhere

StorageWhere getStorageWhere()

Returns the system where this instance will be stored.

Returns:

the storage system where this observable instance will be stored

sync

void sync()

Performs a synchronization of this observable with the underlying storage system.