org.ojai.store.cdc

Enum ChangeEvent

java.lang.Object

java.lang.Enum<ChangeEvent>

org.ojai.store.cdc.ChangeEvent

All Implemented Interfaces:

Serializable, Comparable<ChangeEvent>

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

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
END_ARRAY The reader reached the end of an ARRAY.
END_MAP The reader reached the end of a MAP.
NODE The reader arrived at a scalar field or a field that was deleted.
NULL The reader arrived at a field which does not have an event or event information is not available.
START_ARRAY The reader arrived at beginning of an ARRAY.
START_MAP The reader arrived at beginning of a MAP.

Method Summary

Modifier and Type	Method and Description
byte	getCode() Returns the numerical code of the enumeration.
static ChangeEvent	valueOf(String name) Returns the enum constant of this type with the specified name.
static ChangeEvent[]	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 ChangeEvent NULL

The reader arrived at a field which does not have an event or event information is not available.

NODE

public static final ChangeEvent NODE

The reader arrived at a scalar field or a field that was deleted.

START_MAP

public static final ChangeEvent START_MAP

The reader arrived at beginning of a MAP.

END_MAP

public static final ChangeEvent END_MAP

The reader reached the end of a MAP.

START_ARRAY

public static final ChangeEvent START_ARRAY

The reader arrived at beginning of an ARRAY.

END_ARRAY

public static final ChangeEvent END_ARRAY

The reader reached the end of an ARRAY.

Method Detail

values

public static ChangeEvent[] 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 (ChangeEvent c : ChangeEvent.values())
    System.out.println(c);

Returns:

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

valueOf

public static ChangeEvent 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.