Package org.wildfly.clustering.session

Enum Class IdentifierMarshaller

java.lang.Object

java.lang.Enum<IdentifierMarshaller>

org.wildfly.clustering.session.IdentifierMarshaller

All Implemented Interfaces:

Serializable, Comparable<IdentifierMarshaller>, Constable, Marshallability, Marshaller<String,ByteBuffer>

public enum IdentifierMarshaller
extends Enum<IdentifierMarshaller>
implements Marshaller<String,ByteBuffer>

Generic strategies for marshalling a string-based session identifier.

Author:

Paul Ferraro

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
BASE64	Specific optimization for Base64-encoded identifiers (e.g.
HEX	Specific optimization for hex-encoded identifiers (e.g.
ISO_LATIN_1

Field Summary

Fields inherited from interface org.wildfly.clustering.marshalling.Marshallability

TRUE

Method Summary

Modifier and Type	Method	Description
boolean	isMarshallable(Object object)	Indicates whether the specified object can be marshalled.
boolean	validate(String id)	Indicates whether or not the specified identifier is valid for this serializer.
static IdentifierMarshaller	valueOf(String name)	Returns the enum constant of this class with the specified name.
static IdentifierMarshaller[]	values()	Returns an array containing the constants of this enum class, 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

Methods inherited from interface org.wildfly.clustering.marshalling.Marshaller

read, write

Enum Constant Details

ISO_LATIN_1

public static final IdentifierMarshaller ISO_LATIN_1

BASE64

public static final IdentifierMarshaller BASE64

Specific optimization for Base64-encoded identifiers (e.g. Undertow).

HEX

public static final IdentifierMarshaller HEX

Specific optimization for hex-encoded identifiers (e.g. Tomcat).

Method Details

values

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

isMarshallable

public boolean isMarshallable(Object object)

Description copied from interface: Marshallability

Indicates whether the specified object can be marshalled.

Specified by:

isMarshallable in interface Marshallability

Parameters:

object - an object to be marshalled

Returns:

true, if the specified object can be marshalled, false otherwise

validate

public boolean validate(String id)

Indicates whether or not the specified identifier is valid for this serializer.

Parameters:

id - an identifier

Returns:

true, if the specified identifier is valid, false otherwise.