net.maritimecloud.message

Class MessageEnumSerializer<T extends MessageEnum>

java.lang.Object

net.maritimecloud.message.ValueSerializer<T>

net.maritimecloud.message.MessageEnumSerializer<T>

Type Parameters:

T - the type of enum

public abstract class MessageEnumSerializer<T extends MessageEnum>
extends ValueSerializer<T>

A parser for creating message enums based on an integer or string value.

Author:

Kasper Nielsen

Field Summary

Fields inherited from class net.maritimecloud.message.ValueSerializer

BINARY, BOOLEAN, DECIMAL, DOUBLE, FLOAT, INT, INT64, POSITION, POSITION_TIME, TEXT, TIMESTAMP, VARINT

Constructor Summary

Constructors

Constructor and Description
MessageEnumSerializer()

Method Summary

Modifier and Type	Method and Description
abstract T	from(int value) Creates the enum from the specified integer value.
abstract T	from(String name) Creates the enum from the specified string
T	read(ValueReader reader) Parses a message from the specified reader
void	write(T value, ValueWriter writer)

Methods inherited from class net.maritimecloud.message.ValueSerializer

listOf, mappingTo, setOf, write

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MessageEnumSerializer

public MessageEnumSerializer()

Method Detail

from

public abstract T from(int value)
                throws IOException

Creates the enum from the specified integer value.

Parameters:

value - the integer value to create the enum from

Returns:

the new enum

Throws:

IOException

from

public abstract T from(String name)
                throws IOException

Creates the enum from the specified string

Parameters:

name - the string value of this enum

Returns:

the string value of this enum

Throws:

IOException

read

public final T read(ValueReader reader)
             throws IOException

Parses a message from the specified reader

Specified by:

read in class ValueSerializer<T extends MessageEnum>

Parameters:

reader - the serializer to create the from

Returns:

the message that was constructed from the reader

Throws:

IOException - if the message could not be read

write

public final void write(T value,
                        ValueWriter writer)
                 throws IOException

Specified by:

write in class ValueSerializer<T extends MessageEnum>

Throws:

IOException