com.neeve.sma

Enum MessageChannel.State

java.lang.Object

java.lang.Enum<MessageChannel.State>

com.neeve.sma.MessageChannel.State

All Implemented Interfaces:

Serializable, Comparable<MessageChannel.State>

Enclosing interface:

MessageChannel

public static enum MessageChannel.State
extends Enum<MessageChannel.State>

Enumerates the different channel states.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Closed Indicates that a channel has been closed.
Closing Indicates that a channel is being closed A channel transitions to this state when it in the process of being closed
Failed Indicates that a channel has failed.
Open Indicates a channel is open and ready for operation.

Method Summary

Methods

Modifier and Type	Method and Description
static MessageChannel.State	valueOf(String name) Returns the enum constant of this type with the specified name.
static MessageChannel.State[]	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

Open

public static final MessageChannel.State Open

Indicates a channel is open and ready for operation.

Closing

public static final MessageChannel.State Closing

Indicates that a channel is being closed

A channel transitions to this state when it in the process of being closed

Failed

public static final MessageChannel.State Failed

Indicates that a channel has failed.

A channel transitions to this state when it's container binding fails and before the binding dispatches the failure event. This state can only be set in channels whose bindings supports failure.

Closed

public static final MessageChannel.State Closed

Indicates that a channel has been closed.

A channel transitions to this state when explicitly closed by the user or implicitly closed by a binding.

Method Detail

values

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

Returns:

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

valueOf

public static MessageChannel.State 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