org.phoenixframework.channels

Enum ChannelEvent

java.lang.Object

java.lang.Enum<ChannelEvent>

org.phoenixframework.channels.ChannelEvent

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ChannelEvent>

public enum ChannelEvent
extends java.lang.Enum<ChannelEvent>

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLOSE
ERROR
JOIN
LEAVE
REPLY

Method Summary

Modifier and Type	Method and Description
static ChannelEvent	getEvent(java.lang.String phxEvent)
java.lang.String	getPhxEvent()
static ChannelEvent	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ChannelEvent[]	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

CLOSE

public static final ChannelEvent CLOSE

ERROR

public static final ChannelEvent ERROR

JOIN

public static final ChannelEvent JOIN

REPLY

public static final ChannelEvent REPLY

LEAVE

public static final ChannelEvent LEAVE

Method Detail

values

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

Returns:

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

valueOf

public static ChannelEvent 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

java.lang.NullPointerException - if the argument is null

getEvent

public static ChannelEvent getEvent(java.lang.String phxEvent)

getPhxEvent

public java.lang.String getPhxEvent()