async.common
Enum MessageHandle.MessageState

java.lang.Object
  extended by java.lang.Enum<MessageHandle.MessageState>
      extended by async.common.MessageHandle.MessageState
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<MessageHandle.MessageState>
Enclosing interface:
MessageHandle

public static enum MessageHandle.MessageState
extends java.lang.Enum<MessageHandle.MessageState>

The state of the Message.

Author:
Michael Parker

Enum Constant Summary
CANCELLED
          The message could not be sent because the queue was full, it was explicitly cancelled, or no connection to the remote node exists.
ENQUEUED
          The message is enqueued and is awaiting sending to the remote node.
SENDING
          The message is currently being sent to the remote node.
SENT
          The message has been sent to the remote node.
 
Method Summary
static MessageHandle.MessageState valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static MessageHandle.MessageState[] values()
          Returns an array containing the constants of this enum type, in the order they're 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

ENQUEUED

public static final MessageHandle.MessageState ENQUEUED
The message is enqueued and is awaiting sending to the remote node.


SENDING

public static final MessageHandle.MessageState SENDING
The message is currently being sent to the remote node.


SENT

public static final MessageHandle.MessageState SENT
The message has been sent to the remote node.


CANCELLED

public static final MessageHandle.MessageState CANCELLED
The message could not be sent because the queue was full, it was explicitly cancelled, or no connection to the remote node exists.

Method Detail

values

public static final MessageHandle.MessageState[] values()
Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:
for(MessageHandle.MessageState c : MessageHandle.MessageState.values())
        System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they're declared

valueOf

public static MessageHandle.MessageState valueOf(java.lang.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:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name