com.dyuproject.protostuff.runtime

Class EnumIO<E extends java.lang.Enum<E>>

java.lang.Object

com.dyuproject.protostuff.runtime.EnumIO<E>

All Implemented Interfaces:

PolymorphicSchema.Factory

Direct Known Subclasses:

EnumIO.ByMapping, EnumIO.ByName

public abstract class EnumIO<E extends java.lang.Enum<E>>
extends java.lang.Object
implements PolymorphicSchema.Factory

Determines how enums are serialized/deserialized. Default is BY_NUMBER. To enable BY_NAME, set the property "protostuff.runtime.enums_by_name=true".

Author:

David Yu

Date created:

Oct 20, 2010

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EnumIO.ByMapping<E extends java.lang.Enum<E>>
static class	EnumIO.ByName<E extends java.lang.Enum<E>> Reads the enum by its name.
static class	EnumIO.Eager
static class	EnumIO.Lazy
static class	EnumIO.Wrapper

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.Class<E>	enumClass The enum class.

Constructor Summary

Constructors

Constructor and Description
EnumIO(java.lang.Class<E> enumClass, IdStrategy strategy)

Method Summary

Modifier and Type	Method and Description
MapSchema.MessageFactory	getEnumMapFactory() Returns the factory for an EnumMap (lazy).
CollectionSchema.MessageFactory	getEnumSetFactory() Returns the factory for an EnumSet (lazy).
<V> java.util.EnumMap<E,V>	newEnumMap() Returns an empty EnumMap.
java.util.EnumSet<E>	newEnumSet() Returns an empty EnumSet.
PolymorphicSchema	newSchema(java.lang.Class<?> typeClass, IdStrategy strategy, PolymorphicSchema.Handler handler)
abstract E	readFrom(Input input) Read the enum from the input.
static java.lang.Class<?>	resolveEnumClass(java.lang.Class<?> clazz)
abstract void	transfer(Pipe pipe, Input input, Output output, int number, boolean repeated) Transfers the Enum from the input to the output.
abstract void	writeTo(Output output, int number, java.lang.Enum<?> e, boolean repeated) Writes the Enum to the output.

Methods inherited from class java.lang.Object

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

Field Detail

enumClass

public final java.lang.Class<E extends java.lang.Enum<E>> enumClass

The enum class.

Constructor Detail

EnumIO

public EnumIO(java.lang.Class<E> enumClass,
              IdStrategy strategy)

Method Detail

resolveEnumClass

public static java.lang.Class<?> resolveEnumClass(java.lang.Class<?> clazz)

newSchema

public PolymorphicSchema newSchema(java.lang.Class<?> typeClass,
                                   IdStrategy strategy,
                                   PolymorphicSchema.Handler handler)

Specified by:

newSchema in interface PolymorphicSchema.Factory

getEnumSetFactory

public CollectionSchema.MessageFactory getEnumSetFactory()

Returns the factory for an EnumSet (lazy).

getEnumMapFactory

public MapSchema.MessageFactory getEnumMapFactory()

Returns the factory for an EnumMap (lazy).

newEnumSet

public java.util.EnumSet<E> newEnumSet()

Returns an empty EnumSet.

newEnumMap

public <V> java.util.EnumMap<E,V> newEnumMap()

Returns an empty EnumMap.

readFrom

public abstract E readFrom(Input input)
                    throws java.io.IOException

Read the enum from the input.

Throws:

java.io.IOException

writeTo

public abstract void writeTo(Output output,
                             int number,
                             java.lang.Enum<?> e,
                             boolean repeated)
                      throws java.io.IOException

Writes the Enum to the output.

Throws:

java.io.IOException

transfer

public abstract void transfer(Pipe pipe,
                              Input input,
                              Output output,
                              int number,
                              boolean repeated)
                       throws java.io.IOException

Transfers the Enum from the input to the output.

Throws:

java.io.IOException