org.ojai.store.cdc

Enum ChangeOp

java.lang.Object

java.lang.Enum<ChangeOp>

org.ojai.store.cdc.ChangeOp

All Implemented Interfaces:

Serializable, Comparable<ChangeOp>

@API.Public
public enum ChangeOp
extends Enum<ChangeOp>

This enumeration identifies the change event associated with the current change node.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DELETE All values older than or equal to the delete operation timestamp were deleted.
DELETE_EXACT The operation deleted the current field, or a version thereof, whose timestamp was same as that of the current change node.
MERGE The current (Map) field was merged with the specified value.
NULL The current change node does not have an operation.
PUT This operation added another version of the field into the store.
SET The current field was set to the specified value

Method Summary

Modifier and Type	Method and Description
byte	getCode() Returns the numerical code of the enumeration.
static ChangeOp	valueOf(String name) Returns the enum constant of this type with the specified name.
static ChangeOp[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NULL

public static final ChangeOp NULL

The current change node does not have an operation. For example, the event of the node is an END_ARRAY or END_MAP operation.

SET

public static final ChangeOp SET

The current field was set to the specified value

MERGE

public static final ChangeOp MERGE

The current (Map) field was merged with the specified value.

DELETE

public static final ChangeOp DELETE

All values older than or equal to the delete operation timestamp were deleted.

DELETE_EXACT

public static final ChangeOp DELETE_EXACT

The operation deleted the current field, or a version thereof, whose timestamp was same as that of the current change node.

PUT

public static final ChangeOp PUT

This operation added another version of the field into the store. For a multi-version DocumentStore, this event is emitted instead of SET.

Method Detail

values

public static ChangeOp[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ChangeOp c : ChangeOp.values())
    System.out.println(c);

Returns:

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

valueOf

public static ChangeOp valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

getCode

public byte getCode()

Returns the numerical code of the enumeration.