Enum Class WebSocketTransportFormat

java.lang.Object

java.lang.Enum<WebSocketTransportFormat>

io.fluxzero.common.websocket.WebSocketTransportFormat

All Implemented Interfaces:

Serializable, Comparable<WebSocketTransportFormat>, Constable

public enum WebSocketTransportFormat
extends Enum<WebSocketTransportFormat>

Wire formats supported by the Fluxzero websocket transport.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BINARY	Native binary transport.
CBOR	Jackson CBOR transport.
JSON	Existing JSON transport.

Method Summary

Modifier and Type	Method	Description
static WebSocketTransportFormat	valueOf(String name)	Returns the enum constant of this class with the specified name.
static WebSocketTransportFormat[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

BINARY

public static final WebSocketTransportFormat BINARY

Native binary transport. Serialized messages use a patchable envelope with opaque payload and metadata bytes; protocol values without a compact representation use CBOR.

JSON

public static final WebSocketTransportFormat JSON

Existing JSON transport. Serialized byte[] fields are represented as base64 by Jackson.

CBOR

public static final WebSocketTransportFormat CBOR

Jackson CBOR transport. This keeps the JSON object model but writes byte[] fields as native binary.

Method Details

values

public static WebSocketTransportFormat[] 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 WebSocketTransportFormat 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