com.neeve.sma

Enum MessageChannel.PreserveJoinPolicy

java.lang.Object

java.lang.Enum<MessageChannel.PreserveJoinPolicy>

com.neeve.sma.MessageChannel.PreserveJoinPolicy

All Implemented Interfaces:

Serializable, Comparable<MessageChannel.PreserveJoinPolicy>

Enclosing interface:

MessageChannel

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

Enumerates preferences for preserving a channel join.

When close(flags), is called the flag MessageChannel.PRESERVE_CHANNEL_JOINS controls whether or not leave(0) is called when close() is called for the channel.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Default Use the default behavior on close() in determining whether to call leave(flags).
Leave Call leave(0) on close().
Preserve Don't call leave(0) on close().

Method Summary

Methods

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

Default

public static final MessageChannel.PreserveJoinPolicy Default

Use the default behavior on close() in determining whether to call leave(flags).

The default behavior is to leave the channel unless close(PRESERVE_CHANNEL_JOINS) is explicitly called.

Leave

public static final MessageChannel.PreserveJoinPolicy Leave

Call leave(0) on close().

Preserve

public static final MessageChannel.PreserveJoinPolicy Preserve

Don't call leave(0) on close().

Method Detail

values

public static MessageChannel.PreserveJoinPolicy[] 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.PreserveJoinPolicy c : MessageChannel.PreserveJoinPolicy.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.PreserveJoinPolicy 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