io.aeron.cluster.codecs

Enum ClusterAction

java.lang.Object

java.lang.Enum<ClusterAction>

io.aeron.cluster.codecs.ClusterAction

All Implemented Interfaces:

Serializable, Comparable<ClusterAction>

public enum ClusterAction
extends Enum<ClusterAction>

Action to be taken by cluster nodes.

Enum Constant Summary

Enum Constants

Enum Constant and Description
NULL_VAL To be used to represent not present or null.
RESUME Resume ingress to the cluster.
SNAPSHOT Snapshot state in the cluster.
SUSPEND Suspend ingress to the cluster.

Method Summary

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

SUSPEND

public static final ClusterAction SUSPEND

Suspend ingress to the cluster.

RESUME

public static final ClusterAction RESUME

Resume ingress to the cluster.

SNAPSHOT

public static final ClusterAction SNAPSHOT

Snapshot state in the cluster.

NULL_VAL

public static final ClusterAction NULL_VAL

To be used to represent not present or null.

Method Detail

values

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

Returns:

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

valueOf

public static ClusterAction 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 ClusterAction get(int value)

Lookup the enum value representing the value.

Parameters:

value - encoded to be looked up.

Returns:

the enum value representing the value.