io.protostuff.runtime

Class EnumIO<E extends Enum<E>>

java.lang.Object

io.protostuff.runtime.EnumIO<E>

All Implemented Interfaces:

PolymorphicSchema.Factory

Direct Known Subclasses:

EnumIO.ByName, EnumIO.ByNumber

public abstract class EnumIO<E extends Enum<E>>
extends 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.ByName<E extends Enum<E>> Reads the enum by its name.
static class	EnumIO.ByNumber<E extends Enum<E>> Reads the enum by its number.

Field Summary

Fields

Modifier and Type	Field and Description
Class<E>	enumClass The enum class.
ArraySchemas.Base	genericElementSchema
IdStrategy	strategy

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
String	getAlias(Enum<?> element)
E	getByAlias(String alias)
E	getByTag(int tag)
MapSchema.MessageFactory	getEnumMapFactory() Returns the factory for an EnumMap (lazy).
CollectionSchema.MessageFactory	getEnumSetFactory() Returns the factory for an EnumSet (lazy).
int	getTag(Enum<?> element)
<V> EnumMap<E,V>	newEnumMap() Returns an empty EnumMap.
EnumSet<E>	newEnumSet() Returns an empty EnumSet.
PolymorphicSchema	newSchema(Class<?> typeClass, IdStrategy strategy, PolymorphicSchema.Handler handler)
abstract E	readFrom(Input input) Read the enum from the input.
static void	transfer(Pipe pipe, Input input, Output output, int number, boolean repeated, IdStrategy strategy) Transfers the Enum from the input to the output.
void	writeTo(Output output, int number, boolean repeated, Enum<?> e) 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 Class<E extends Enum<E>> enumClass

The enum class.

strategy

public final IdStrategy strategy

genericElementSchema

public final ArraySchemas.Base genericElementSchema

Constructor Detail

EnumIO

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

Method Detail

writeTo

public void writeTo(Output output,
           int number,
           boolean repeated,
           Enum<?> e)
             throws IOException

Writes the Enum to the output.

Throws:

IOException

transfer

public static void transfer(Pipe pipe,
            Input input,
            Output output,
            int number,
            boolean repeated,
            IdStrategy strategy)
                     throws IOException

Transfers the Enum from the input to the output.

Throws:

IOException

newSchema

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

Specified by:

newSchema in interface PolymorphicSchema.Factory

getTag

public int getTag(Enum<?> element)

getAlias

public String getAlias(Enum<?> element)

getByTag

public E getByTag(int tag)

getByAlias

public E getByAlias(String alias)

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 EnumSet<E> newEnumSet()

Returns an empty EnumSet.

newEnumMap

public <V> EnumMap<E,V> newEnumMap()

Returns an empty EnumMap.

readFrom

public abstract E readFrom(Input input)
                                    throws IOException

Read the enum from the input.

Throws:

IOException