org.wildfly.clustering.marshalling.spi

Enum IndexSerializer

java.lang.Object

java.lang.Enum<IndexSerializer>

org.wildfly.clustering.marshalling.spi.IndexSerializer

All Implemented Interfaces:

Serializable, Comparable<IndexSerializer>, IntSerializer

public enum IndexSerializer
extends Enum<IndexSerializer>
implements IntSerializer

Various strategies for marshalling an array/collection index (i.e. an unsigned integer).

Author:

Paul Ferraro

Enum Constant Summary

Enum Constants

Enum Constant and Description
INTEGER
UNSIGNED_BYTE
UNSIGNED_SHORT
VARIABLE Reads/write an unsigned integer using a variable-length format.

Method Summary

Modifier and Type	Method and Description
static IntSerializer	select(int size) Returns the most efficient externalizer for a given index size.
static IndexSerializer	valueOf(String name) Returns the enum constant of this type with the specified name.
static IndexSerializer[]	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

Methods inherited from interface org.wildfly.clustering.marshalling.spi.IntSerializer

readInt, size, writeInt

Enum Constant Detail

UNSIGNED_BYTE

public static final IndexSerializer UNSIGNED_BYTE

UNSIGNED_SHORT

public static final IndexSerializer UNSIGNED_SHORT

INTEGER

public static final IndexSerializer INTEGER

VARIABLE

public static final IndexSerializer VARIABLE

Reads/write an unsigned integer using a variable-length format. Format requires between 1 and 5 bytes, depending on the index size. Smaller values require fewer bytes. Logic lifted directly from org.infinispan.commons.io.UnsignedNumeric.

Method Detail

values

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

Returns:

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

valueOf

public static IndexSerializer 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

select

public static IntSerializer select(int size)

Returns the most efficient externalizer for a given index size.

Parameters:

size - the size of the index

Returns:

an index externalizer