Package io.ably.lib.liveobjects.message

Enum Class ObjectOperationAction

java.lang.Object

java.lang.Enum<ObjectOperationAction>

io.ably.lib.liveobjects.message.ObjectOperationAction

All Implemented Interfaces:

Serializable, Comparable<ObjectOperationAction>, Constable

public enum ObjectOperationAction
extends Enum<ObjectOperationAction>

The action of an ObjectOperation, defining the type of operation that was applied to an object on a channel.

Spec: OOP2 / PAOOP2a

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
COUNTER_CREATE	Creates a new LiveCounter object.
COUNTER_INC	Increments the value of a LiveCounter object.
MAP_CLEAR	Removes all entries from a LiveMap object.
MAP_CREATE	Creates a new LiveMap object.
MAP_REMOVE	Removes a key from a LiveMap object.
MAP_SET	Sets the value at a key of a LiveMap object.
OBJECT_DELETE	Deletes (tombstones) an object.
UNKNOWN	Future-compatibility fallback for an action not recognized by this version of the client library.

Method Summary

Modifier and Type	Method	Description
static ObjectOperationAction	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ObjectOperationAction[]	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

MAP_CREATE

public static final ObjectOperationAction MAP_CREATE

Creates a new LiveMap object. Spec: OOP2

MAP_SET

public static final ObjectOperationAction MAP_SET

Sets the value at a key of a LiveMap object. Spec: OOP2

MAP_REMOVE

public static final ObjectOperationAction MAP_REMOVE

Removes a key from a LiveMap object. Spec: OOP2

COUNTER_CREATE

public static final ObjectOperationAction COUNTER_CREATE

Creates a new LiveCounter object. Spec: OOP2

COUNTER_INC

public static final ObjectOperationAction COUNTER_INC

Increments the value of a LiveCounter object. Spec: OOP2

OBJECT_DELETE

public static final ObjectOperationAction OBJECT_DELETE

Deletes (tombstones) an object. Spec: OOP2

MAP_CLEAR

public static final ObjectOperationAction MAP_CLEAR

Removes all entries from a LiveMap object. Spec: OOP2

UNKNOWN

public static final ObjectOperationAction UNKNOWN

Future-compatibility fallback for an action not recognized by this version of the client library.

Method Details

values

public static ObjectOperationAction[] 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 ObjectOperationAction 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