io.aeron.cluster.codecs

Enum AdminResponseCode

java.lang.Object

java.lang.Enum<AdminResponseCode>

io.aeron.cluster.codecs.AdminResponseCode

All Implemented Interfaces:

Serializable, Comparable<AdminResponseCode>

public enum AdminResponseCode
extends Enum<AdminResponseCode>

Response code for an admin command request.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ERROR An error occurred during admin operation.
NULL_VAL To be used to represent not present or null.
OK Command was submitted or executed successfully.
UNAUTHORISED_ACCESS Admin request was not authorised.

Method Summary

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

OK

public static final AdminResponseCode OK

Command was submitted or executed successfully.

ERROR

public static final AdminResponseCode ERROR

An error occurred during admin operation.

UNAUTHORISED_ACCESS

public static final AdminResponseCode UNAUTHORISED_ACCESS

Admin request was not authorised.

NULL_VAL

public static final AdminResponseCode NULL_VAL

To be used to represent not present or null.

Method Detail

values

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

Returns:

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

valueOf

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

Lookup the enum value representing the value.

Parameters:

value - encoded to be looked up.

Returns:

the enum value representing the value.