io.aeron.cluster.codecs

Enum SnapshotMark

java.lang.Object

java.lang.Enum<SnapshotMark>

io.aeron.cluster.codecs.SnapshotMark

All Implemented Interfaces:

Serializable, Comparable<SnapshotMark>

public enum SnapshotMark
extends Enum<SnapshotMark>

Mark within a snapshot.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BEGIN Begin marker for a snapshot.
END End marker for a snapshot.
NULL_VAL To be used to represent not present or null.
SECTION Section marker for a snapshot.

Method Summary

Modifier and Type	Method and Description
static SnapshotMark	get(int value) Lookup the enum value representing the value.
int	value() The raw encoded value in the Java type representation.
static SnapshotMark	valueOf(String name) Returns the enum constant of this type with the specified name.
static SnapshotMark[]	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

BEGIN

public static final SnapshotMark BEGIN

Begin marker for a snapshot.

SECTION

public static final SnapshotMark SECTION

Section marker for a snapshot.

END

public static final SnapshotMark END

End marker for a snapshot.

NULL_VAL

public static final SnapshotMark NULL_VAL

To be used to represent not present or null.

Method Detail

values

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

Returns:

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

valueOf

public static SnapshotMark 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

value

public int value()

The raw encoded value in the Java type representation.

Returns:

the raw value encoded.

get

public static SnapshotMark get(int value)

Lookup the enum value representing the value.

Parameters:

value - encoded to be looked up.

Returns:

the enum value representing the value.