io.protostuff.runtime

Class IdStrategy

java.lang.Object

io.protostuff.runtime.IdStrategy

Direct Known Subclasses:

DefaultIdStrategy

public abstract class IdStrategy
extends Object

This base class handles all the IO for reading and writing polymorphic fields. When a field's type is polymorphic/dynamic (e.g interface/abstract/object), the type (id) needs to be written (ahead) before its value/content to be able to deserialize it correctly.

The underlying impl will determine how the type (id) should be written.

An IdStrategy is standalone if the primaryGroup is not set.

Author:

Leo Romanoff, David Yu

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	IdStrategy.Factory Responsible for instantiating custom IdStrategy impls.
static class	IdStrategy.UnknownTypeException Thrown when a type is not known by the IdStrategy.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALLOW_NULL_ARRAY_ELEMENT
static int	AUTO_LOAD_POLYMORPHIC_CLASSES
static int	COLLECTION_SCHEMA_ON_REPEATED_FIELDS
static int	DEFAULT_FLAGS
static int	ENUMS_BY_NAME
int	flags
int	groupId
static int	MORPH_COLLECTION_INTERFACES
static int	MORPH_MAP_INTERFACES
static int	MORPH_NON_FINAL_POJOS
static int	POJO_SCHEMA_ON_COLLECTION_FIELDS
static int	POJO_SCHEMA_ON_MAP_FIELDS
IdStrategy	primaryGroup

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IdStrategy(int flags, IdStrategy primaryGroup, int groupId)

Method Summary

Methods

Modifier and Type	Method and Description
protected static <T> T	createMessageInstance(Class<T> clazz)
protected abstract CollectionSchema.MessageFactory	getCollectionFactory(Class<?> clazz) Returns the CollectionSchema.MessageFactory.
abstract <T> Delegate<T>	getDelegate(Class<? super T> typeClass) Returns the delegate.
abstract <T> HasDelegate<T>	getDelegateWrapper(Class<? super T> typeClass) Returns the delegate.
protected abstract EnumIO<? extends Enum<?>>	getEnumIO(Class<?> enumClass) Returns the EnumIO.
protected abstract MapSchema.MessageFactory	getMapFactory(Class<?> clazz) Returns the MapSchema.MessageFactory.
abstract <T> HasSchema<T>	getSchemaWrapper(Class<T> typeClass, boolean create) Returns the schema wrapper.
abstract boolean	isDelegateRegistered(Class<?> typeClass) Returns true if there is a Delegate explicitly registered for the typeClass.
abstract boolean	isRegistered(Class<?> typeClass) Returns true if the typeClass is explicitly registered.
protected <T> Schema<T>	newSchema(Class<T> typeClass) Generates a schema from the given class.
protected abstract Class<?>	resolveArrayComponentTypeFrom(Input input, boolean mapped)
protected abstract Class<?>	resolveClassFrom(Input input, boolean mapped, boolean array)
protected abstract CollectionSchema.MessageFactory	resolveCollectionFrom(Input input)
protected abstract <T> HasDelegate<T>	resolveDelegateFrom(Input input)
protected abstract EnumIO<?>	resolveEnumFrom(Input input)
protected abstract MapSchema.MessageFactory	resolveMapFrom(Input input)
protected abstract <T> HasSchema<T>	resolvePojoFrom(Input input, int fieldNumber)
protected abstract void	transferArrayId(Input input, Output output, int fieldNumber, boolean mapped)
protected abstract void	transferClassId(Input input, Output output, int fieldNumber, boolean mapped, boolean array)
protected abstract void	transferCollectionId(Input input, Output output, int fieldNumber)
protected abstract <T> HasDelegate<T>	transferDelegateId(Input input, Output output, int fieldNumber)
protected abstract void	transferEnumId(Input input, Output output, int fieldNumber)
protected abstract void	transferMapId(Input input, Output output, int fieldNumber)
protected abstract <T> HasSchema<T>	transferPojoId(Input input, Output output, int fieldNumber)
protected abstract <T> HasDelegate<T>	tryWriteDelegateIdTo(Output output, int fieldNumber, Class<T> clazz) If this method returns null, the clazz was not registered as a delegate.
protected abstract <T> HasSchema<T>	tryWritePojoIdTo(Output output, int fieldNumber, Class<T> clazz, boolean registered)
protected abstract void	writeArrayIdTo(Output output, Class<?> componentType)
protected abstract void	writeClassIdTo(Output output, Class<?> componentType, boolean array)
protected abstract void	writeCollectionIdTo(Output output, int fieldNumber, Class<?> clazz)
protected abstract void	writeEnumIdTo(Output output, int fieldNumber, Class<?> clazz)
protected abstract void	writeMapIdTo(Output output, int fieldNumber, Class<?> clazz)
protected abstract <T> Schema<T>	writeMessageIdTo(Output output, int fieldNumber, Message<T> message)
protected abstract <T> HasSchema<T>	writePojoIdTo(Output output, int fieldNumber, Class<T> clazz)

Methods inherited from class java.lang.Object

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

Field Detail

ENUMS_BY_NAME

public static final int ENUMS_BY_NAME

See Also:

Constant Field Values

AUTO_LOAD_POLYMORPHIC_CLASSES

public static final int AUTO_LOAD_POLYMORPHIC_CLASSES

See Also:

Constant Field Values

ALLOW_NULL_ARRAY_ELEMENT

public static final int ALLOW_NULL_ARRAY_ELEMENT

See Also:

Constant Field Values

MORPH_NON_FINAL_POJOS

public static final int MORPH_NON_FINAL_POJOS

See Also:

Constant Field Values

MORPH_COLLECTION_INTERFACES

public static final int MORPH_COLLECTION_INTERFACES

See Also:

Constant Field Values

MORPH_MAP_INTERFACES

public static final int MORPH_MAP_INTERFACES

See Also:

Constant Field Values

COLLECTION_SCHEMA_ON_REPEATED_FIELDS

public static final int COLLECTION_SCHEMA_ON_REPEATED_FIELDS

See Also:

Constant Field Values

POJO_SCHEMA_ON_COLLECTION_FIELDS

public static final int POJO_SCHEMA_ON_COLLECTION_FIELDS

See Also:

Constant Field Values

POJO_SCHEMA_ON_MAP_FIELDS

public static final int POJO_SCHEMA_ON_MAP_FIELDS

See Also:

Constant Field Values

DEFAULT_FLAGS

public static final int DEFAULT_FLAGS

flags

public final int flags

primaryGroup

public final IdStrategy primaryGroup

groupId

public final int groupId

Constructor Detail

IdStrategy

protected IdStrategy(int flags,
          IdStrategy primaryGroup,
          int groupId)

Method Detail

newSchema

protected <T> Schema<T> newSchema(Class<T> typeClass)

Generates a schema from the given class. If this strategy is part of a group, the existing fields of that group's schema will be re-used.

isDelegateRegistered

public abstract boolean isDelegateRegistered(Class<?> typeClass)

Returns true if there is a Delegate explicitly registered for the typeClass.

getDelegateWrapper

public abstract <T> HasDelegate<T> getDelegateWrapper(Class<? super T> typeClass)

Returns the delegate.

getDelegate

public abstract <T> Delegate<T> getDelegate(Class<? super T> typeClass)

Returns the delegate.

isRegistered

public abstract boolean isRegistered(Class<?> typeClass)

Returns true if the typeClass is explicitly registered.

getSchemaWrapper

public abstract <T> HasSchema<T> getSchemaWrapper(Class<T> typeClass,
                                boolean create)

Returns the schema wrapper. The caller is responsible that the typeClass is a pojo (e.g not an enum/array/etc).

getEnumIO

protected abstract EnumIO<? extends Enum<?>> getEnumIO(Class<?> enumClass)

Returns the EnumIO. The callers (internal field factories) are responsible that the class provided is an enum class.

getCollectionFactory

protected abstract CollectionSchema.MessageFactory getCollectionFactory(Class<?> clazz)

Returns the CollectionSchema.MessageFactory. The callers (internal field factories) are responsible that the class provided implements Collection.

getMapFactory

protected abstract MapSchema.MessageFactory getMapFactory(Class<?> clazz)

Returns the MapSchema.MessageFactory. The callers (internal field factories}) are responsible that the class provided implements Map.

writeCollectionIdTo

protected abstract void writeCollectionIdTo(Output output,
                       int fieldNumber,
                       Class<?> clazz)
                                     throws IOException

Throws:

IOException

transferCollectionId

protected abstract void transferCollectionId(Input input,
                        Output output,
                        int fieldNumber)
                                      throws IOException

Throws:

IOException

resolveCollectionFrom

protected abstract CollectionSchema.MessageFactory resolveCollectionFrom(Input input)
                                                                  throws IOException

Throws:

IOException

writeMapIdTo

protected abstract void writeMapIdTo(Output output,
                int fieldNumber,
                Class<?> clazz)
                              throws IOException

Throws:

IOException

transferMapId

protected abstract void transferMapId(Input input,
                 Output output,
                 int fieldNumber)
                               throws IOException

Throws:

IOException

resolveMapFrom

protected abstract MapSchema.MessageFactory resolveMapFrom(Input input)
                                                    throws IOException

Throws:

IOException

writeEnumIdTo

protected abstract void writeEnumIdTo(Output output,
                 int fieldNumber,
                 Class<?> clazz)
                               throws IOException

Throws:

IOException

transferEnumId

protected abstract void transferEnumId(Input input,
                  Output output,
                  int fieldNumber)
                                throws IOException

Throws:

IOException

resolveEnumFrom

protected abstract EnumIO<?> resolveEnumFrom(Input input)
                                      throws IOException

Throws:

IOException

tryWritePojoIdTo

protected abstract <T> HasSchema<T> tryWritePojoIdTo(Output output,
                                int fieldNumber,
                                Class<T> clazz,
                                boolean registered)
                                          throws IOException

Throws:

IOException

writePojoIdTo

protected abstract <T> HasSchema<T> writePojoIdTo(Output output,
                             int fieldNumber,
                             Class<T> clazz)
                                       throws IOException

Throws:

IOException

transferPojoId

protected abstract <T> HasSchema<T> transferPojoId(Input input,
                              Output output,
                              int fieldNumber)
                                        throws IOException

Throws:

IOException

resolvePojoFrom

protected abstract <T> HasSchema<T> resolvePojoFrom(Input input,
                               int fieldNumber)
                                         throws IOException

Throws:

IOException

writeMessageIdTo

protected abstract <T> Schema<T> writeMessageIdTo(Output output,
                             int fieldNumber,
                             Message<T> message)
                                       throws IOException

Throws:

IOException

tryWriteDelegateIdTo

protected abstract <T> HasDelegate<T> tryWriteDelegateIdTo(Output output,
                                      int fieldNumber,
                                      Class<T> clazz)
                                                throws IOException

If this method returns null, the clazz was not registered as a delegate.

Throws:

IOException

transferDelegateId

protected abstract <T> HasDelegate<T> transferDelegateId(Input input,
                                    Output output,
                                    int fieldNumber)
                                              throws IOException

Throws:

IOException

resolveDelegateFrom

protected abstract <T> HasDelegate<T> resolveDelegateFrom(Input input)
                                               throws IOException

Throws:

IOException

writeArrayIdTo

protected abstract void writeArrayIdTo(Output output,
                  Class<?> componentType)
                                throws IOException

Throws:

IOException

transferArrayId

protected abstract void transferArrayId(Input input,
                   Output output,
                   int fieldNumber,
                   boolean mapped)
                                 throws IOException

Throws:

IOException

resolveArrayComponentTypeFrom

protected abstract Class<?> resolveArrayComponentTypeFrom(Input input,
                                     boolean mapped)
                                                   throws IOException

Throws:

IOException

writeClassIdTo

protected abstract void writeClassIdTo(Output output,
                  Class<?> componentType,
                  boolean array)
                                throws IOException

Throws:

IOException

transferClassId

protected abstract void transferClassId(Input input,
                   Output output,
                   int fieldNumber,
                   boolean mapped,
                   boolean array)
                                 throws IOException

Throws:

IOException

resolveClassFrom

protected abstract Class<?> resolveClassFrom(Input input,
                        boolean mapped,
                        boolean array)
                                      throws IOException

Throws:

IOException

createMessageInstance

protected static <T> T createMessageInstance(Class<T> clazz)