net.openhft.lang.io.serialization.impl

Enum ByteBufferMarshaller

java.lang.Object

java.lang.Enum<ByteBufferMarshaller>

net.openhft.lang.io.serialization.impl.ByteBufferMarshaller

All Implemented Interfaces:

Serializable, Comparable<ByteBufferMarshaller>, BytesMarshaller<ByteBuffer>, CompactBytesMarshaller<ByteBuffer>

public enum ByteBufferMarshaller
extends Enum<ByteBufferMarshaller>
implements CompactBytesMarshaller<ByteBuffer>

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE

Field Summary

Fields inherited from interface net.openhft.lang.io.serialization.CompactBytesMarshaller

BYTE_BUFFER_CODE, CLASS_CODE, DATE_CODE, DOUBLE_CODE, INT_CODE, LIST_CODE, LONG_CODE, MAP_CODE, SET_CODE, STRING_CODE, STRINGZ_CODE, STRINGZ_MAP_CODE

Method Summary

Methods

Modifier and Type	Method and Description
byte	code()
protected ByteBuffer	newByteBuffer(int length)
ByteBuffer	read(Bytes bytes) Reads and returns an object from bytes.
ByteBuffer	read(Bytes bytes, ByteBuffer byteBuffer) Reads and returns an object from bytes, reusing the given object, if possible.
static ByteBufferMarshaller	valueOf(String name) Returns the enum constant of this type with the specified name.
static ByteBufferMarshaller[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
void	write(Bytes bytes, ByteBuffer byteBuffer) Write the object out to the bytes.

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

INSTANCE

public static final ByteBufferMarshaller INSTANCE

Method Detail

values

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

Returns:

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

valueOf

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

code

public byte code()

Specified by:

code in interface CompactBytesMarshaller<ByteBuffer>

Returns:

the code for this marshaller

write

public void write(Bytes bytes,
         ByteBuffer byteBuffer)

Description copied from interface: BytesMarshaller

Write the object out to the bytes.

Specified by:

write in interface BytesMarshaller<ByteBuffer>

Parameters:

bytes - to write to

byteBuffer - the object to write

read

public ByteBuffer read(Bytes bytes)

Description copied from interface: BytesMarshaller

Reads and returns an object from bytes.

Specified by:

read in interface BytesMarshaller<ByteBuffer>

Parameters:

bytes - to read

Returns:

the read object

read

public ByteBuffer read(Bytes bytes,
              @Nullable
              ByteBuffer byteBuffer)

Description copied from interface: BytesMarshaller

Reads and returns an object from bytes, reusing the given object, if possible.

Specified by:

read in interface BytesMarshaller<ByteBuffer>

Parameters:

bytes - to read

byteBuffer - an object to reuse, if possible. null could be passed, in this case a new object should be allocated anyway.

Returns:

the read object

newByteBuffer

protected ByteBuffer newByteBuffer(int length)