io.atomix.protocols.raft.protocol

Enum RaftResponse.Status

java.lang.Object

java.lang.Enum<RaftResponse.Status>

io.atomix.protocols.raft.protocol.RaftResponse.Status

All Implemented Interfaces:

Serializable, Comparable<RaftResponse.Status>

Enclosing interface:

RaftResponse

public static enum RaftResponse.Status
extends Enum<RaftResponse.Status>

Response status.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ERROR Indicates a response containing an error.
OK Indicates a successful response status.

Method Summary

Modifier and Type	Method and Description
static RaftResponse.Status	forId(int id) Returns the status for the given identifier.
byte	id() Returns the status identifier.
static RaftResponse.Status	valueOf(String name) Returns the enum constant of this type with the specified name.
static RaftResponse.Status[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

OK

public static final RaftResponse.Status OK

Indicates a successful response status.

ERROR

public static final RaftResponse.Status ERROR

Indicates a response containing an error.

Method Detail

values

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

Returns:

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

valueOf

public static RaftResponse.Status 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

forId

public static RaftResponse.Status forId(int id)

Returns the status for the given identifier.

Parameters:

id - The status identifier.

Returns:

The status for the given identifier.

Throws:

IllegalArgumentException - if id is not 0 or 1

id

public byte id()

Returns the status identifier.

Returns:

The status identifier.