Package org.atmosphere.room

Enum Class RoomAction

java.lang.Object

java.lang.Enum<RoomAction>

org.atmosphere.room.RoomAction

All Implemented Interfaces:

Serializable, Comparable<RoomAction>, Constable

public enum RoomAction
extends Enum<RoomAction>

Actions that can be performed on a Room. Used by RoomAuthorizer to authorize operations.

Since:

4.0

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BROADCAST
JOIN
LEAVE
SEND_TO

Method Summary

Modifier and Type	Method	Description
static RoomAction	valueOf(String name)	Returns the enum constant of this class with the specified name.
static RoomAction[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

JOIN

public static final RoomAction JOIN

LEAVE

public static final RoomAction LEAVE

BROADCAST

public static final RoomAction BROADCAST

SEND_TO

public static final RoomAction SEND_TO

Method Details

values

public static RoomAction[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static RoomAction valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null