Module io.inverno.mod.http.base

Package io.inverno.mod.http.base.ws

Enum Class WebSocketFrame.Kind

java.lang.Object

java.lang.Enum<WebSocketFrame.Kind>

io.inverno.mod.http.base.ws.WebSocketFrame.Kind

All Implemented Interfaces:

Serializable, Comparable<WebSocketFrame.Kind>, Constable

Enclosing interface:

WebSocketFrame

public static enum WebSocketFrame.Kind
extends Enum<WebSocketFrame.Kind>

WebSocket frame type as defined by RFC 6455 Section 5.

Since:

1.5

Author:

Jeremy Kuhn

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	Indicates a BINARY data frame.
CLOSE	Indicates a CLOSE control frame.
CONTINUATION	Indicates a CONTINUATION data frame.
PING	Indicates a PING control frame.
PONG	Indicates a PONG control frame.
TEXT	Indicates a TEXT data frame.

Method Summary

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

PING

public static final WebSocketFrame.Kind PING

Indicates a PING control frame.

PONG

public static final WebSocketFrame.Kind PONG

Indicates a PONG control frame.

CLOSE

public static final WebSocketFrame.Kind CLOSE

Indicates a CLOSE control frame.

CONTINUATION

public static final WebSocketFrame.Kind CONTINUATION

Indicates a CONTINUATION data frame.

TEXT

public static final WebSocketFrame.Kind TEXT

Indicates a TEXT data frame.

BINARY

public static final WebSocketFrame.Kind BINARY

Indicates a BINARY data frame.

Method Details

values

public static WebSocketFrame.Kind[] 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 WebSocketFrame.Kind 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