io.protostuff.runtime

Class DefaultIdStrategy

java.lang.Object

io.protostuff.runtime.IdStrategy

io.protostuff.runtime.DefaultIdStrategy

public final class DefaultIdStrategy
extends IdStrategy

The FQCN(fully qualified class name) will serve as the id (string). Does not need any registration in the user-code (works out-of-the-box). The size of serialized representation may be not very efficient.

Author:

Leo Romanoff, David Yu

Nested Class Summary

Nested classes/interfaces inherited from class io.protostuff.runtime.IdStrategy

IdStrategy.Factory, IdStrategy.UnknownTypeException

Field Summary

Fields inherited from class io.protostuff.runtime.IdStrategy

ALLOW_NULL_ARRAY_ELEMENT, AUTO_LOAD_POLYMORPHIC_CLASSES, COLLECTION_SCHEMA_ON_REPEATED_FIELDS, DEFAULT_FLAGS, ENUMS_BY_NAME, flags, groupId, MORPH_COLLECTION_INTERFACES, MORPH_MAP_INTERFACES, MORPH_NON_FINAL_POJOS, POJO_SCHEMA_ON_COLLECTION_FIELDS, POJO_SCHEMA_ON_MAP_FIELDS, primaryGroup

Constructor Summary

Constructors

Constructor and Description
DefaultIdStrategy()
DefaultIdStrategy(IdStrategy primaryGroup, int groupId)
DefaultIdStrategy(int flags)
DefaultIdStrategy(int flags, IdStrategy primaryGroup, int groupId)

Method Summary

Methods

Modifier and Type	Method and Description
protected CollectionSchema.MessageFactory	getCollectionFactory(Class<?> clazz) Returns the CollectionSchema.MessageFactory.
<T> Delegate<T>	getDelegate(Class<? super T> typeClass) Returns the delegate.
<T> HasDelegate<T>	getDelegateWrapper(Class<? super T> typeClass) Returns the delegate.
protected EnumIO<? extends Enum<?>>	getEnumIO(Class<?> enumClass) Returns the EnumIO.
protected MapSchema.MessageFactory	getMapFactory(Class<?> clazz) Returns the MapSchema.MessageFactory.
<T> HasSchema<T>	getSchemaWrapper(Class<T> typeClass, boolean create) Returns the schema wrapper.
boolean	isDelegateRegistered(Class<?> typeClass) Returns true if there is a Delegate explicitly registered for the typeClass.
boolean	isRegistered(Class<?> typeClass) Returns true if the typeClass is explicitly registered.
<T> boolean	map(Class<? super T> baseClass, Class<T> typeClass) Used by RuntimeSchema.map(Class, Class).
boolean	registerCollection(CollectionSchema.MessageFactory factory) Registers a collection.
<T> boolean	registerDelegate(Delegate<T> delegate) Registers a delegate.
<T> boolean	registerDelegate(String className, Delegate<T> delegate) Registers a delegate by specifying the class name.
<T extends Enum<T>> boolean	registerEnum(Class<T> enumClass) Registers an enum.
boolean	registerMap(MapSchema.MessageFactory factory) Registers a map.
<T> boolean	registerPojo(Class<T> typeClass) Registers a pojo.
<T> boolean	registerPojo(Class<T> typeClass, Schema<T> schema) Registers a pojo.
protected Class<?>	resolveArrayComponentTypeFrom(Input input, boolean mapped)
protected Class<?>	resolveClassFrom(Input input, boolean mapped, boolean array)
protected CollectionSchema.MessageFactory	resolveCollectionFrom(Input input)
protected <T> HasDelegate<T>	resolveDelegateFrom(Input input)
protected EnumIO<?>	resolveEnumFrom(Input input)
protected MapSchema.MessageFactory	resolveMapFrom(Input input)
protected <T> HasSchema<T>	resolvePojoFrom(Input input, int fieldNumber)
protected void	transferArrayId(Input input, Output output, int fieldNumber, boolean mapped)
protected void	transferClassId(Input input, Output output, int fieldNumber, boolean mapped, boolean array)
protected void	transferCollectionId(Input input, Output output, int fieldNumber)
protected <T> HasDelegate<T>	transferDelegateId(Input input, Output output, int fieldNumber)
protected void	transferEnumId(Input input, Output output, int fieldNumber)
protected void	transferMapId(Input input, Output output, int fieldNumber)
protected <T> HasSchema<T>	transferPojoId(Input input, Output output, int fieldNumber)
protected <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 <T> HasSchema<T>	tryWritePojoIdTo(Output output, int fieldNumber, Class<T> clazz, boolean registered)
protected void	writeArrayIdTo(Output output, Class<?> componentType)
protected void	writeClassIdTo(Output output, Class<?> componentType, boolean array)
protected void	writeCollectionIdTo(Output output, int fieldNumber, Class<?> clazz)
protected void	writeEnumIdTo(Output output, int fieldNumber, Class<?> clazz)
protected void	writeMapIdTo(Output output, int fieldNumber, Class<?> clazz)
protected <T> Schema<T>	writeMessageIdTo(Output output, int fieldNumber, Message<T> message)
protected <T> HasSchema<T>	writePojoIdTo(Output output, int fieldNumber, Class<T> clazz)

Methods inherited from class io.protostuff.runtime.IdStrategy

createMessageInstance, newSchema

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultIdStrategy

public DefaultIdStrategy()

DefaultIdStrategy

public DefaultIdStrategy(IdStrategy primaryGroup,
                 int groupId)

DefaultIdStrategy

public DefaultIdStrategy(int flags)

DefaultIdStrategy

public DefaultIdStrategy(int flags,
                 IdStrategy primaryGroup,
                 int groupId)

Method Detail

registerPojo

public <T> boolean registerPojo(Class<T> typeClass,
                       Schema<T> schema)

Registers a pojo. Returns true if registration is successful or if the same exact schema was previously registered. Used by RuntimeSchema.register(Class, Schema).

registerPojo

public <T> boolean registerPojo(Class<T> typeClass)

Registers a pojo. Returns true if registration is successful or if the same exact schema was previously registered.

registerEnum

public <T extends Enum<T>> boolean registerEnum(Class<T> enumClass)

Registers an enum. Returns true if registration is successful.

registerDelegate

public <T> boolean registerDelegate(Delegate<T> delegate)

Registers a delegate. Returns true if registration is successful.

registerDelegate

public <T> boolean registerDelegate(String className,
                           Delegate<T> delegate)

Registers a delegate by specifying the class name. Returns true if registration is successful.

registerCollection

public boolean registerCollection(CollectionSchema.MessageFactory factory)

Registers a collection. Returns true if registration is successful.

registerMap

public boolean registerMap(MapSchema.MessageFactory factory)

Registers a map. Returns true if registration is successful.

map

public <T> boolean map(Class<? super T> baseClass,
              Class<T> typeClass)

Used by RuntimeSchema.map(Class, Class).

isDelegateRegistered

public boolean isDelegateRegistered(Class<?> typeClass)

Description copied from class: IdStrategy

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

Specified by:

isDelegateRegistered in class IdStrategy

getDelegateWrapper

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

Description copied from class: IdStrategy

Returns the delegate.

Specified by:

getDelegateWrapper in class IdStrategy

getDelegate

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

Description copied from class: IdStrategy

Returns the delegate.

Specified by:

getDelegate in class IdStrategy

isRegistered

public boolean isRegistered(Class<?> typeClass)

Description copied from class: IdStrategy

Returns true if the typeClass is explicitly registered.

Specified by:

isRegistered in class IdStrategy

getSchemaWrapper

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

Description copied from class: IdStrategy

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

Specified by:

getSchemaWrapper in class IdStrategy

getEnumIO

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

Description copied from class: IdStrategy

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

Specified by:

getEnumIO in class IdStrategy

getCollectionFactory

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

Description copied from class: IdStrategy

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

Specified by:

getCollectionFactory in class IdStrategy

getMapFactory

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

Description copied from class: IdStrategy

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

Specified by:

getMapFactory in class IdStrategy

writeCollectionIdTo

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

Specified by:

writeCollectionIdTo in class IdStrategy

Throws:

IOException

transferCollectionId

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

Specified by:

transferCollectionId in class IdStrategy

Throws:

IOException

resolveCollectionFrom

protected CollectionSchema.MessageFactory resolveCollectionFrom(Input input)
                                                         throws IOException

Specified by:

resolveCollectionFrom in class IdStrategy

Throws:

IOException

writeMapIdTo

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

Specified by:

writeMapIdTo in class IdStrategy

Throws:

IOException

transferMapId

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

Specified by:

transferMapId in class IdStrategy

Throws:

IOException

resolveMapFrom

protected MapSchema.MessageFactory resolveMapFrom(Input input)
                                           throws IOException

Specified by:

resolveMapFrom in class IdStrategy

Throws:

IOException

writeEnumIdTo

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

Specified by:

writeEnumIdTo in class IdStrategy

Throws:

IOException

transferEnumId

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

Specified by:

transferEnumId in class IdStrategy

Throws:

IOException

resolveEnumFrom

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

Specified by:

resolveEnumFrom in class IdStrategy

Throws:

IOException

tryWriteDelegateIdTo

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

Description copied from class: IdStrategy

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

Specified by:

tryWriteDelegateIdTo in class IdStrategy

Throws:

IOException

transferDelegateId

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

Specified by:

transferDelegateId in class IdStrategy

Throws:

IOException

resolveDelegateFrom

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

Specified by:

resolveDelegateFrom in class IdStrategy

Throws:

IOException

tryWritePojoIdTo

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

Specified by:

tryWritePojoIdTo in class IdStrategy

Throws:

IOException

writePojoIdTo

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

Specified by:

writePojoIdTo in class IdStrategy

Throws:

IOException

transferPojoId

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

Specified by:

transferPojoId in class IdStrategy

Throws:

IOException

resolvePojoFrom

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

Specified by:

resolvePojoFrom in class IdStrategy

Throws:

IOException

writeMessageIdTo

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

Specified by:

writeMessageIdTo in class IdStrategy

Throws:

IOException

writeArrayIdTo

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

Specified by:

writeArrayIdTo in class IdStrategy

Throws:

IOException

transferArrayId

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

Specified by:

transferArrayId in class IdStrategy

Throws:

IOException

resolveArrayComponentTypeFrom

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

Specified by:

resolveArrayComponentTypeFrom in class IdStrategy

Throws:

IOException

writeClassIdTo

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

Specified by:

writeClassIdTo in class IdStrategy

Throws:

IOException

transferClassId

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

Specified by:

transferClassId in class IdStrategy

Throws:

IOException

resolveClassFrom

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

Specified by:

resolveClassFrom in class IdStrategy

Throws:

IOException