Enum Class PeriodMarshaller

java.lang.Object

java.lang.Enum<PeriodMarshaller>

org.wildfly.clustering.marshalling.protostream.time.PeriodMarshaller

All Implemented Interfaces:

Serializable, Comparable<PeriodMarshaller>, Constable, org.infinispan.protostream.BaseMarshaller<Period>, org.infinispan.protostream.ProtobufTagMarshaller<Period>, Marshallable<Period>, ProtoStreamMarshaller<Period>, Readable<Period>, Writable<Period>

public enum PeriodMarshaller
extends Enum<PeriodMarshaller>
implements ProtoStreamMarshaller<Period>

Marshaller for Period instances, using the following strategy:

1. Marshal Period.ZERO as zero bytes
2. Marshal number of years of period as signed integer
3. Marshal number of months of period as signed integer
4. Marshal number of days of period as signed integer

Author:

Paul Ferraro

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<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	Singleton instance

Field Summary

Fields inherited from interface org.infinispan.protostream.BaseMarshaller

EMPTY

Method Summary

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

Methods inherited from class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.infinispan.protostream.BaseMarshaller

getSubClassNames

Methods inherited from interface Marshallable

size

Methods inherited from interface ProtoStreamMarshaller

getTypeName, read, wrap, wrap, write

Enum Constant Details

INSTANCE

public static final PeriodMarshaller INSTANCE

Singleton instance

Method Details

values

public static PeriodMarshaller[] 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 PeriodMarshaller 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 Period readFrom(ProtoStreamReader reader)
                throws IOException

Description copied from interface: Readable

Reads an object from the specified reader.

Specified by:

readFrom in interface Readable<Period>

Parameters:

reader - a ProtoStream reader

Returns:

the read object

Throws:

IOException - if the object could not be read

writeTo

public void writeTo(ProtoStreamWriter writer,
 Period period)
             throws IOException

Description copied from interface: Writable

Writes the specified object to the specified writer.

Specified by:

writeTo in interface Writable<Period>

Parameters:

writer - a ProtoStream writer

period - the object to be written

Throws:

IOException - if the object could not be written

getJavaClass

public Class<? extends Period> 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<Period>

Specified by:

getJavaClass in interface Marshallable<Period>

Returns:

the type of object handled by this marshallable instance.