Package org.wildfly.clustering.marshalling.protostream.time

Enum Class DurationMarshaller

java.lang.Object

java.lang.Enum<DurationMarshaller>

org.wildfly.clustering.marshalling.protostream.time.DurationMarshaller

All Implemented Interfaces:

Serializable, Comparable<DurationMarshaller>, Constable, FieldReadable<Duration>, FieldSetMarshaller<Duration,Duration>, FieldSetMarshaller.Simple<Duration>, Writable<Duration>

public enum DurationMarshaller
extends Enum<DurationMarshaller>
implements FieldSetMarshaller.Simple<Duration>

Marshaller for Duration instances, using the following strategy:

1. Marshal Duration.ZERO as zero bytes
2. Marshal number of seconds of duration as unsigned long
3. Marshal sub-second value of duration as unsigned integer, using millisecond precision, if possible

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.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
Duration	createInitialValue()	Returns a builder for use with FieldReadable.readFrom(ProtoStreamReader, int, WireType, Object).
int	getFields()	Returns the number of fields in this field set
Duration	readFrom(ProtoStreamReader reader, int index, org.infinispan.protostream.descriptors.WireType type, Duration duration)	Reads a single field from the specified reader.
static DurationMarshaller	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DurationMarshaller[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.
void	writeTo(ProtoStreamWriter writer, Duration duration)	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.FieldReadable

nextIndex

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

asMarshaller, asMarshaller

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

build

Enum Constant Details

INSTANCE

public static final DurationMarshaller INSTANCE

Method Details

values

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

createInitialValue

public Duration createInitialValue()

Description copied from interface: FieldSetMarshaller

Returns a builder for use with FieldReadable.readFrom(ProtoStreamReader, int, WireType, 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<Duration,Duration>

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<Duration>

Returns:

a number of fields

readFrom

public Duration readFrom(ProtoStreamReader reader,
 int index,
 org.infinispan.protostream.descriptors.WireType type,
 Duration duration)
                  throws IOException

Description copied from interface: FieldReadable

Reads a single field from the specified reader.

Specified by:

readFrom in interface FieldReadable<Duration>

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

duration - the current value

Returns:

the read value

Throws:

IOException - if a field could not be read

writeTo

public void writeTo(ProtoStreamWriter writer,
 Duration duration)
             throws IOException

Description copied from interface: Writable

Writes the specified object to the specified writer.

Specified by:

writeTo in interface Writable<Duration>

Parameters:

writer - a ProtoStream writer

duration - the object to be written

Throws:

IOException - if the object could not be written