Enum Class ModelWebSocketCodec

java.lang.Object

java.lang.Enum<ModelWebSocketCodec>

io.fluxzero.common.api.modeling.ModelWebSocketCodec

All Implemented Interfaces:

WebSocketPayloadCodec, Serializable, Comparable<ModelWebSocketCodec>, Constable

public enum ModelWebSocketCodec
extends Enum<ModelWebSocketCodec>
implements WebSocketPayloadCodec

Compact websocket representation for model commits and model-event reads.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
INSTANCE

Method Summary

Modifier and Type	Method	Description
JsonType	tryDecode(byte[] bytes, WebSocketTransportFormat format)	Returns the decoded value, or null when the bytes do not belong to this codec.
byte[]	tryEncode(JsonType value, WebSocketTransportFormat format)	Returns a compact representation, or null when this codec does not own the value.
static ModelWebSocketCodec	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ModelWebSocketCodec[]	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

INSTANCE

public static final ModelWebSocketCodec INSTANCE

Method Details

values

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

tryEncode

public byte[] tryEncode(JsonType value,
 WebSocketTransportFormat format)
                 throws IOException

Description copied from interface: WebSocketPayloadCodec

Returns a compact representation, or null when this codec does not own the value.

Specified by:

tryEncode in interface WebSocketPayloadCodec

Throws:

IOException

tryDecode

public JsonType tryDecode(byte[] bytes,
 WebSocketTransportFormat format)
                   throws IOException

Description copied from interface: WebSocketPayloadCodec

Returns the decoded value, or null when the bytes do not belong to this codec.

Specified by:

tryDecode in interface WebSocketPayloadCodec

Throws:

IOException