Package io.ably.lib.liveobjects.state

Enum Class ObjectStateEvent

java.lang.Object

java.lang.Enum<ObjectStateEvent>

io.ably.lib.liveobjects.state.ObjectStateEvent

All Implemented Interfaces:

Serializable, Comparable<ObjectStateEvent>, Constable

public enum ObjectStateEvent
extends Enum<ObjectStateEvent>

Represents the synchronization state of Ably Objects.

This enum is used to notify listeners about state changes in the synchronization process. Clients can register an ObjectStateChange.Listener to receive these events.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
SYNCED	Indicates that synchronization has completed successfully and objects are in sync.
SYNCING	Indicates that synchronization between local and remote objects is in progress.

Method Summary

Modifier and Type	Method	Description
static ObjectStateEvent	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ObjectStateEvent[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SYNCING

public static final ObjectStateEvent SYNCING

Indicates that synchronization between local and remote objects is in progress.

SYNCED

public static final ObjectStateEvent SYNCED

Indicates that synchronization has completed successfully and objects are in sync.

Method Details

values

public static ObjectStateEvent[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static ObjectStateEvent valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null