com.squareup.okhttp.ws

Enum WebSocket.PayloadType

java.lang.Object

java.lang.Enum<WebSocket.PayloadType>

com.squareup.okhttp.ws.WebSocket.PayloadType

All Implemented Interfaces:

Serializable, Comparable<WebSocket.PayloadType>

Enclosing interface:

WebSocket

public static enum WebSocket.PayloadType
extends Enum<WebSocket.PayloadType>

The format of a message payload.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BINARY Arbitrary binary data.
TEXT UTF8-encoded text data.

Method Summary

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

TEXT

public static final WebSocket.PayloadType TEXT

UTF8-encoded text data.

BINARY

public static final WebSocket.PayloadType BINARY

Arbitrary binary data.

Method Detail

values

public static WebSocket.PayloadType[] 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.PayloadType c : WebSocket.PayloadType.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.PayloadType 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