org.wildfly.clustering.marshalling.protostream.time

Enum DurationMarshaller

java.lang.Object

java.lang.Enum<DurationMarshaller>

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

All Implemented Interfaces:

Serializable, Comparable<DurationMarshaller>, FieldSetMarshaller<Duration,Duration>

public enum DurationMarshaller
extends Enum<DurationMarshaller>
implements FieldSetMarshaller<Duration,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

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE

Method Summary

Modifier and Type	Method and Description
Duration	getBuilder() Returns a builder for use with FieldSetMarshaller.readField(ProtoStreamReader, int, Object).
int	getFields() Returns the number of fields written by this marshaller.
Duration	readField(ProtoStreamReader reader, int index, Duration duration) Reads a single field from the specified reader at the specified index.
static DurationMarshaller	valueOf(String name) Returns the enum constant of this type with the specified name.
static DurationMarshaller[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
void	writeFields(ProtoStreamWriter writer, int startIndex, Duration duration) Writes the set of fields from the specified object to the specified writer beginning at the specified index.

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 DurationMarshaller INSTANCE

Method Detail

values

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

Returns:

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

valueOf

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

getBuilder

public Duration getBuilder()

Description copied from interface: FieldSetMarshaller

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

Specified by:

getBuilder in interface FieldSetMarshaller<Duration,Duration>

Returns:

a builder.

getFields

public int getFields()

Description copied from interface: FieldSetMarshaller

Returns the number of fields written by this marshaller.

Specified by:

getFields in interface FieldSetMarshaller<Duration,Duration>

Returns:

a positive number

readField

public Duration readField(ProtoStreamReader reader,
                          int index,
                          Duration duration)
                   throws IOException

Description copied from interface: FieldSetMarshaller

Reads a single field from the specified reader at the specified index.

Specified by:

readField in interface FieldSetMarshaller<Duration,Duration>

Parameters:

reader - a ProtoStream reader

index - the field index

duration - the builder to be populated with the read field

Returns:

the builder containing the read field

Throws:

IOException - if the field could not be read

writeFields

public void writeFields(ProtoStreamWriter writer,
                        int startIndex,
                        Duration duration)
                 throws IOException

Description copied from interface: FieldSetMarshaller

Writes the set of fields from the specified object to the specified writer beginning at the specified index.

Specified by:

writeFields in interface FieldSetMarshaller<Duration,Duration>

Parameters:

writer - a ProtoStream writer

startIndex - the start index for the embedded fields

duration - the value to be written

Throws:

IOException - if the value could not be written