Package org.wildfly.clustering.marshalling.protostream.util

Enum ComparatorMarshaller

java.lang.Object

java.lang.Enum<ComparatorMarshaller>

org.wildfly.clustering.marshalling.protostream.util.ComparatorMarshaller

All Implemented Interfaces:

Serializable, Comparable<ComparatorMarshaller>, FieldReadable<Comparator<?>>, FieldSetMarshaller<Comparator<?>,Comparator<?>>, FieldSetMarshaller.Simple<Comparator<?>>, Writable<Comparator<?>>

public enum ComparatorMarshaller
extends Enum<ComparatorMarshaller>
implements FieldSetMarshaller.Simple<Comparator<?>>

Marshaller for the fields of a Comparator.

Author:

Paul Ferraro

Nested Class Summary

Nested classes/interfaces inherited from interface org.wildfly.clustering.marshalling.protostream.FieldSetMarshaller

FieldSetMarshaller.Simple<T>, FieldSetMarshaller.Supplied<T,V extends Supplier<T>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
INSTANCE

Method Summary

Modifier and Type	Method	Description
Comparator<?>	createInitialValue()	Returns a builder for use with #readField(ProtoStreamReader, Object).
int	getFields()	Returns the number of fields in this field set
Comparator<?>	readFrom(ProtoStreamReader reader, int index, org.infinispan.protostream.descriptors.WireType type, Comparator<?> comparator)	Reads a single field from the specified reader.
static ComparatorMarshaller	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ComparatorMarshaller[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.
void	writeTo(ProtoStreamWriter writer, Comparator<?> comparator)	Writes the specified object to the specified writer.

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

nextIndex

Methods inherited from interface org.wildfly.clustering.marshalling.protostream.FieldSetMarshaller.Simple

build

Enum Constant Detail

INSTANCE

public static final ComparatorMarshaller INSTANCE

Method Detail

values

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

Returns:

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

valueOf

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

createInitialValue

public Comparator<?> createInitialValue()

Description copied from interface: FieldSetMarshaller

Returns a builder for use with #readField(ProtoStreamReader, Object). May return a shared instance, if the builder type is immutable, or a new instance, if the builder is mutable.

Specified by:

createInitialValue in interface FieldSetMarshaller<Comparator<?>,Comparator<?>>

Returns:

a builder.

getFields

public int getFields()

Description copied from interface: FieldReadable

Returns the number of fields in this field set

Specified by:

getFields in interface FieldReadable<Comparator<?>>

Returns:

a number of fields

readFrom

public Comparator<?> readFrom(ProtoStreamReader reader,
                              int index,
                              org.infinispan.protostream.descriptors.WireType type,
                              Comparator<?> comparator)
                       throws IOException

Description copied from interface: FieldReadable

Reads a single field from the specified reader.

Specified by:

readFrom in interface FieldReadable<Comparator<?>>

Parameters:

reader - a reader

index - the zero-based index, relative to this field set, of the field to be read

type - the wire type of the field to be read

comparator - the current value

Returns:

the read value

Throws:

IOException - if a field could not be read

writeTo

public void writeTo(ProtoStreamWriter writer,
                    Comparator<?> comparator)
             throws IOException

Description copied from interface: Writable

Writes the specified object to the specified writer.

Specified by:

writeTo in interface Writable<Comparator<?>>

Parameters:

writer - a ProtoStream writer

comparator - the object to be written

Throws:

IOException - if the object could not be written