Package org.java_websocket

Enum WebSocket.Role

java.lang.Object

java.lang.Enum<WebSocket.Role>

org.java_websocket.WebSocket.Role

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<WebSocket.Role>

Enclosing interface:

WebSocket

public static enum WebSocket.Role
extends java.lang.Enum<WebSocket.Role>

Enum which represents the states a websocket may be in

Enum Constant Summary

Enum Constants

Enum Constant	Description
CLIENT
SERVER

Method Summary

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

CLIENT

public static final WebSocket.Role CLIENT

SERVER

public static final WebSocket.Role SERVER

Method Detail

values

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

Returns:

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

valueOf

public static WebSocket.Role 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