Package org.apache.camel.component.vertx.websocket

Enum VertxWebsocketEvent

java.lang.Object

java.lang.Enum<VertxWebsocketEvent>

org.apache.camel.component.vertx.websocket.VertxWebsocketEvent

All Implemented Interfaces:

Serializable, Comparable<VertxWebsocketEvent>

public enum VertxWebsocketEvent
extends Enum<VertxWebsocketEvent>

Events that may be fired during the lifecycle of a WebSocket

Enum Constant Summary

Enum Constants

Enum Constant	Description
CLOSE	The WebSocket connection was closed.
ERROR	An error was encountered with the WebSocket.
MESSAGE	The WebSocket received a message.
OPEN	The WebSocket connection was opened.

Method Summary

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

The WebSocket connection was closed.

ERROR

public static final VertxWebsocketEvent ERROR

An error was encountered with the WebSocket.

MESSAGE

public static final VertxWebsocketEvent MESSAGE

The WebSocket received a message.

OPEN

public static final VertxWebsocketEvent OPEN

The WebSocket connection was opened.

Method Detail

values

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

Returns:

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

valueOf

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