Class ExplicitIdStrategy

java.lang.Object

io.protostuff.runtime.IdStrategy

io.protostuff.runtime.NumericIdStrategy

io.protostuff.runtime.ExplicitIdStrategy

public final class ExplicitIdStrategy
extends NumericIdStrategy

Requires every messsage/pojo/enum/collection/map to be registered with unique ids.

Author:

David Yu

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ExplicitIdStrategy.Registry	This Registry is only way to register your pojos/enums/collections/maps/delegates.

Nested classes/interfaces inherited from class NumericIdStrategy

NumericIdStrategy.RegisteredDelegate<T>

Nested classes/interfaces inherited from class IdStrategy

IdStrategy.Factory, IdStrategy.UnknownTypeException

Field Summary

Fields inherited from class NumericIdStrategy

CID_BIGDECIMAL, CID_BIGINTEGER, CID_BOOL, CID_BYTE, CID_BYTE_ARRAY, CID_BYTES, CID_CHAR, CID_CLASS, CID_COLLECTION, CID_DATE, CID_DELEGATE, CID_DOUBLE, CID_ENUM, CID_ENUM_MAP, CID_ENUM_SET, CID_FLOAT, CID_INT32, CID_INT64, CID_MAP, CID_OBJECT, CID_POJO, CID_SHORT, CID_STRING

Fields inherited from class IdStrategy

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, PRESERVE_NULL_ELEMENTS, primaryGroup

Constructor Summary

Constructors

Constructor	Description
ExplicitIdStrategy(int flags, IdStrategy primaryGroup, int groupId, IdentityHashMap<Class<?>, io.protostuff.runtime.ExplicitIdStrategy.RegisteredCollectionFactory> collectionMapping, ArrayList<io.protostuff.runtime.ExplicitIdStrategy.RegisteredCollectionFactory> collections, IdentityHashMap<Class<?>, io.protostuff.runtime.ExplicitIdStrategy.RegisteredMapFactory> mapMapping, ArrayList<io.protostuff.runtime.ExplicitIdStrategy.RegisteredMapFactory> maps, IdentityHashMap<Class<?>, io.protostuff.runtime.ExplicitIdStrategy.RegisteredEnumIO> enumMapping, ArrayList<io.protostuff.runtime.ExplicitIdStrategy.RegisteredEnumIO> enums, IdentityHashMap<Class<?>, io.protostuff.runtime.ExplicitIdStrategy.BaseHS<?>> pojoMapping, ArrayList<io.protostuff.runtime.ExplicitIdStrategy.BaseHS<?>> pojos, IdentityHashMap<Class<?>, NumericIdStrategy.RegisteredDelegate<?>> delegateMapping, ArrayList<NumericIdStrategy.RegisteredDelegate<?>> delegates)
ExplicitIdStrategy(IdentityHashMap<Class<?>, io.protostuff.runtime.ExplicitIdStrategy.RegisteredCollectionFactory> collectionMapping, ArrayList<io.protostuff.runtime.ExplicitIdStrategy.RegisteredCollectionFactory> collections, IdentityHashMap<Class<?>, io.protostuff.runtime.ExplicitIdStrategy.RegisteredMapFactory> mapMapping, ArrayList<io.protostuff.runtime.ExplicitIdStrategy.RegisteredMapFactory> maps, IdentityHashMap<Class<?>, io.protostuff.runtime.ExplicitIdStrategy.RegisteredEnumIO> enumMapping, ArrayList<io.protostuff.runtime.ExplicitIdStrategy.RegisteredEnumIO> enums, IdentityHashMap<Class<?>, io.protostuff.runtime.ExplicitIdStrategy.BaseHS<?>> pojoMapping, ArrayList<io.protostuff.runtime.ExplicitIdStrategy.BaseHS<?>> pojos, IdentityHashMap<Class<?>, NumericIdStrategy.RegisteredDelegate<?>> delegateMapping, ArrayList<NumericIdStrategy.RegisteredDelegate<?>> delegates)

Method Summary

Modifier and Type	Method	Description
protected Class<?>	collectionClass(int id)
protected Class<?>	delegateClass(int id)
protected Class<?>	enumClass(int id)
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 int	getEnumId(Class<?> clazz)
protected EnumIO<? extends Enum<?>>	getEnumIO(Class<?> enumClass)	Returns the EnumIO.
protected int	getId(Class<?> clazz)
protected MapSchema.MessageFactory	getMapFactory(Class<?> clazz)	Returns the MapSchema.MessageFactory.
protected NumericIdStrategy.RegisteredDelegate<?>	getRegisteredDelegate(Class<?> clazz)
<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.
protected Class<?>	mapClass(int id)
protected Class<?>	pojoClass(int id)
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	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	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 NumericIdStrategy

grow, newList, resolveArrayComponentTypeFrom, resolveClassFrom, transferArrayId, transferClassId, writeArrayIdTo, writeClassIdTo

Methods inherited from class IdStrategy

createMessageInstance, newSchema

Methods inherited from class Object

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

Constructor Details

ExplicitIdStrategy

public ExplicitIdStrategy(IdentityHashMap<Class<?>, io.protostuff.runtime.ExplicitIdStrategy.RegisteredCollectionFactory> collectionMapping,
 ArrayList<io.protostuff.runtime.ExplicitIdStrategy.RegisteredCollectionFactory> collections,
 IdentityHashMap<Class<?>, io.protostuff.runtime.ExplicitIdStrategy.RegisteredMapFactory> mapMapping,
 ArrayList<io.protostuff.runtime.ExplicitIdStrategy.RegisteredMapFactory> maps,
 IdentityHashMap<Class<?>, io.protostuff.runtime.ExplicitIdStrategy.RegisteredEnumIO> enumMapping,
 ArrayList<io.protostuff.runtime.ExplicitIdStrategy.RegisteredEnumIO> enums,
 IdentityHashMap<Class<?>, io.protostuff.runtime.ExplicitIdStrategy.BaseHS<?>> pojoMapping,
 ArrayList<io.protostuff.runtime.ExplicitIdStrategy.BaseHS<?>> pojos,
 IdentityHashMap<Class<?>, NumericIdStrategy.RegisteredDelegate<?>> delegateMapping,
 ArrayList<NumericIdStrategy.RegisteredDelegate<?>> delegates)

ExplicitIdStrategy

public ExplicitIdStrategy(int flags,
 IdStrategy primaryGroup,
 int groupId,
 IdentityHashMap<Class<?>, io.protostuff.runtime.ExplicitIdStrategy.RegisteredCollectionFactory> collectionMapping,
 ArrayList<io.protostuff.runtime.ExplicitIdStrategy.RegisteredCollectionFactory> collections,
 IdentityHashMap<Class<?>, io.protostuff.runtime.ExplicitIdStrategy.RegisteredMapFactory> mapMapping,
 ArrayList<io.protostuff.runtime.ExplicitIdStrategy.RegisteredMapFactory> maps,
 IdentityHashMap<Class<?>, io.protostuff.runtime.ExplicitIdStrategy.RegisteredEnumIO> enumMapping,
 ArrayList<io.protostuff.runtime.ExplicitIdStrategy.RegisteredEnumIO> enums,
 IdentityHashMap<Class<?>, io.protostuff.runtime.ExplicitIdStrategy.BaseHS<?>> pojoMapping,
 ArrayList<io.protostuff.runtime.ExplicitIdStrategy.BaseHS<?>> pojos,
 IdentityHashMap<Class<?>, NumericIdStrategy.RegisteredDelegate<?>> delegateMapping,
 ArrayList<NumericIdStrategy.RegisteredDelegate<?>> delegates)

Method Details

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

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

getDelegate

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

Description copied from class: IdStrategy

Returns the delegate.

Specified by:

getDelegate 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

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

collectionClass

protected Class<?> collectionClass(int id)

Specified by:

collectionClass in class NumericIdStrategy

mapClass

protected Class<?> mapClass(int id)

Specified by:

mapClass in class NumericIdStrategy

enumClass

protected Class<?> enumClass(int id)

Specified by:

enumClass in class NumericIdStrategy

delegateClass

protected Class<?> delegateClass(int id)

Specified by:

delegateClass in class NumericIdStrategy

pojoClass

protected Class<?> pojoClass(int id)

Specified by:

pojoClass in class NumericIdStrategy

getRegisteredDelegate

protected NumericIdStrategy.RegisteredDelegate<?> getRegisteredDelegate(Class<?> clazz)

Specified by:

getRegisteredDelegate in class NumericIdStrategy

getEnumId

protected int getEnumId(Class<?> clazz)

Specified by:

getEnumId in class NumericIdStrategy

getId

protected int getId(Class<?> clazz)

Specified by:

getId in class NumericIdStrategy