org.onosproject.store.cluster.messaging.impl

Enum InternalMessage.Status

java.lang.Object

java.lang.Enum<InternalMessage.Status>

org.onosproject.store.cluster.messaging.impl.InternalMessage.Status

All Implemented Interfaces:

Serializable, Comparable<InternalMessage.Status>

Enclosing class:

InternalMessage

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

Message status.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ERROR_HANDLER_EXCEPTION Response status signifying an exception handling the message.
ERROR_NO_HANDLER Response status signifying no registered handler.
OK All ok.
PROTOCOL_EXCEPTION Response status signifying invalid message structure.

Method Summary

Modifier and Type	Method and Description
static InternalMessage.Status	forId(int id) Returns the status enum associated with the given ID.
int	id() Returns the unique status ID.
static InternalMessage.Status	valueOf(String name) Returns the enum constant of this type with the specified name.
static InternalMessage.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

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 InternalMessage.Status OK

All ok.

ERROR_NO_HANDLER

public static final InternalMessage.Status ERROR_NO_HANDLER

Response status signifying no registered handler.

ERROR_HANDLER_EXCEPTION

public static final InternalMessage.Status ERROR_HANDLER_EXCEPTION

Response status signifying an exception handling the message.

PROTOCOL_EXCEPTION

public static final InternalMessage.Status PROTOCOL_EXCEPTION

Response status signifying invalid message structure.

Method Detail

values

public static InternalMessage.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 (InternalMessage.Status c : InternalMessage.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 InternalMessage.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

id

public int id()

Returns the unique status ID.

Returns:

the unique status ID.

forId

public static InternalMessage.Status forId(int id)

Returns the status enum associated with the given ID.

Parameters:

id - the status ID.

Returns:

the status enum for the given ID.