Package org.eclipse.jetty.websocket.api

Enum WebSocketBehavior

java.lang.Object

java.lang.Enum<WebSocketBehavior>

org.eclipse.jetty.websocket.api.WebSocketBehavior

All Implemented Interfaces:

Serializable, Comparable<WebSocketBehavior>, java.lang.constant.Constable

public enum WebSocketBehavior
extends Enum<WebSocketBehavior>

Behavior for how the WebSocket should operate.

This dictated by the RFC 6455 spec in various places, where certain behavior must be performed depending on operation as a CLIENT vs a SERVER

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
CLIENT
SERVER

Method Summary

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

CLIENT

public static final WebSocketBehavior CLIENT

SERVER

public static final WebSocketBehavior SERVER

Method Details

values

public static WebSocketBehavior[] values()

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

Returns:

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

valueOf

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