Package org.wildfly.clustering.marshalling.protostream

Enum Class ByteBufferMarshalledKeyMarshaller

java.lang.Object

java.lang.Enum<ByteBufferMarshalledKeyMarshaller>

org.wildfly.clustering.marshalling.protostream.ByteBufferMarshalledKeyMarshaller

All Implemented Interfaces:

Serializable, Comparable<ByteBufferMarshalledKeyMarshaller>, Constable, org.infinispan.protostream.BaseMarshaller<ByteBufferMarshalledKey<Object>>, org.infinispan.protostream.ProtobufTagMarshaller<ByteBufferMarshalledKey<Object>>, Marshallable<ByteBufferMarshalledKey<Object>>, ProtoStreamMarshaller<ByteBufferMarshalledKey<Object>>, Readable<ByteBufferMarshalledKey<Object>>, Writable<ByteBufferMarshalledKey<Object>>

public enum ByteBufferMarshalledKeyMarshaller
extends Enum<ByteBufferMarshalledKeyMarshaller>
implements ProtoStreamMarshaller<ByteBufferMarshalledKey<Object>>

ProtoStreamMarshaller for a ByteBufferMarshalledKey.

Author:

Paul Ferraro

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Nested classes/interfaces inherited from interface org.infinispan.protostream.ProtobufTagMarshaller

org.infinispan.protostream.ProtobufTagMarshaller.OperationContext, org.infinispan.protostream.ProtobufTagMarshaller.ReadContext, org.infinispan.protostream.ProtobufTagMarshaller.WriteContext

Enum Constant Summary

Enum Constants

Enum Constant	Description
INSTANCE

Method Summary

Modifier and Type	Method	Description
Class<? extends ByteBufferMarshalledKey<Object>>	getJavaClass()	Returns the type of object handled by this marshallable instance.
ByteBufferMarshalledKey<Object>	readFrom(ProtoStreamReader reader)	Reads an object from the specified reader.
OptionalInt	size(ProtoStreamSizeOperation operation, ByteBufferMarshalledKey<Object> key)	Computes the size of the specified object.
static ByteBufferMarshalledKeyMarshaller	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ByteBufferMarshalledKeyMarshaller[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.
void	writeTo(ProtoStreamWriter writer, ByteBufferMarshalledKey<Object> key)	Writes the specified object to the specified writer.

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.protostream.ProtoStreamMarshaller

getTypeName, read, wrap, wrap, write

Enum Constant Details

INSTANCE

public static final ByteBufferMarshalledKeyMarshaller INSTANCE

Method Details

values

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

readFrom

public ByteBufferMarshalledKey<Object> readFrom(ProtoStreamReader reader)
                                         throws IOException

Description copied from interface: Readable

Reads an object from the specified reader.

Specified by:

readFrom in interface Readable<ByteBufferMarshalledKey<Object>>

Parameters:

reader - a ProtoStream reader

Returns:

the read object

Throws:

IOException - if the object could not be read

writeTo

public void writeTo(ProtoStreamWriter writer,
 ByteBufferMarshalledKey<Object> key)
             throws IOException

Description copied from interface: Writable

Writes the specified object to the specified writer.

Specified by:

writeTo in interface Writable<ByteBufferMarshalledKey<Object>>

Parameters:

writer - a ProtoStream writer

key - the object to be written

Throws:

IOException - if the object could not be written

size

public OptionalInt size(ProtoStreamSizeOperation operation,
 ByteBufferMarshalledKey<Object> key)

Description copied from interface: Marshallable

Computes the size of the specified object.

Specified by:

size in interface Marshallable<ByteBufferMarshalledKey<Object>>

Parameters:

operation - the marshalling operation

key - the value whose size is to be calculated

Returns:

an optional buffer size, only present if the buffer size could be computed

getJavaClass

public Class<? extends ByteBufferMarshalledKey<Object>> getJavaClass()

Description copied from interface: Marshallable

Returns the type of object handled by this marshallable instance.

Specified by:

getJavaClass in interface org.infinispan.protostream.BaseMarshaller<ByteBufferMarshalledKey<Object>>

Specified by:

getJavaClass in interface Marshallable<ByteBufferMarshalledKey<Object>>

Returns:

the type of object handled by this marshallable instance.