Package org.microproxy.http

Enum Class WebSocketMessage.Type

java.lang.Object

java.lang.Enum<WebSocketMessage.Type>

org.microproxy.http.WebSocketMessage.Type

All Implemented Interfaces:

Serializable, Comparable<WebSocketMessage.Type>, Constable

Enclosing class:

WebSocketMessage

public static enum WebSocketMessage.Type
extends Enum<WebSocketMessage.Type>

The kind of data a message carries (its first frame's opcode).

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
BINARY	A binary message (WebSocketFrame.OPCODE_BINARY).
TEXT	A text message: UTF-8 (WebSocketFrame.OPCODE_TEXT).

Method Summary

Modifier and Type	Method	Description
int	opcode()	The opcode of the first frame of a message of this type.
static WebSocketMessage.Type	valueOf(String name)	Returns the enum constant of this class with the specified name.
static WebSocketMessage.Type[]	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

TEXT

public static final WebSocketMessage.Type TEXT

A text message: UTF-8 (WebSocketFrame.OPCODE_TEXT).

BINARY

public static final WebSocketMessage.Type BINARY

A binary message (WebSocketFrame.OPCODE_BINARY).

Method Details

values

public static WebSocketMessage.Type[] 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 WebSocketMessage.Type 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

opcode

public int opcode()

The opcode of the first frame of a message of this type.

Returns:

WebSocketFrame.OPCODE_TEXT or WebSocketFrame.OPCODE_BINARY