net.lecousin.framework.io.serialization

Class AbstractDeserializer

java.lang.Object

net.lecousin.framework.io.serialization.AbstractDeserializer

All Implemented Interfaces:

Deserializer

Direct Known Subclasses:

XMLDeserializer

public abstract class AbstractDeserializer
extends Object
implements Deserializer

Implements most of the logic of a deserializer.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AbstractDeserializer.DeserializationTask Shortcut to easily create a Task.

Nested classes/interfaces inherited from interface net.lecousin.framework.io.serialization.Deserializer

Deserializer.StreamReferenceHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected int	maxTextSize
protected byte	priority
protected List<Deserializer.StreamReferenceHandler>	streamReferenceHandlers
protected String	taskDescription

Constructor Summary

Constructors

Constructor and Description
AbstractDeserializer()

Method Summary

Modifier and Type	Method and Description
protected List<SerializationRule>	addRulesForAttribute(SerializationClass.Attribute a, List<SerializationRule> currentList)
protected List<SerializationRule>	addRulesForType(SerializationClass type, List<SerializationRule> currentList)
void	addStreamReferenceHandler(Deserializer.StreamReferenceHandler handler) Register a stream reference handler.
static void	convertBigDecimalValue(BigDecimal n, Class<?> type, AsyncSupplier<Number,SerializationException> result) Convert a BigDecimal into the specified type.
protected AsyncSupplier<Object,SerializationException>	convertFromStringToCharSequence(AsyncSupplier<? extends CharSequence,SerializationException> str, Class<?> target)
static Number	convertStringToInteger(Class<?> type, String str, Class<? extends IntegerUnit> targetUnit) Convert a string into an integer, optionally doing convertion into the targetUnit if any.
<T> AsyncSupplier<T,SerializationException>	deserialize(TypeDefinition type, IO.Readable input, List<SerializationRule> rules) Deserialize an object/value of the given type from the given input.
protected AsyncSupplier<Boolean,SerializationException>	deserializeBooleanAttributeValue(SerializationContext.AttributeContext context, boolean nullable)
protected abstract AsyncSupplier<Boolean,SerializationException>	deserializeBooleanValue(boolean nullable)
protected AsyncSupplier<byte[],SerializationException>	deserializeByteArrayAttributeValue(SerializationContext.AttributeContext context, List<SerializationRule> rules)
protected AsyncSupplier<byte[],SerializationException>	deserializeByteArrayValue(SerializationContext context, List<SerializationRule> rules)
protected AsyncSupplier<Character,SerializationException>	deserializeCharacterAttributeValue(SerializationContext.AttributeContext context, boolean nullable) By default, deserialize a string and get the first character.
protected AsyncSupplier<Character,SerializationException>	deserializeCharacterValue(boolean nullable) By default, deserialize a string and get the first character.
protected AsyncSupplier<Object,SerializationException>	deserializeCollectionAttributeValue(SerializationContext.AttributeContext context, String path, List<SerializationRule> rules)
protected AsyncSupplier<Pair<Object,Boolean>,SerializationException>	deserializeCollectionAttributeValueElement(SerializationContext.CollectionContext context, int elementIndex, String colPath, List<SerializationRule> rules) Return the element with true if an element is found, or null with false if the end of the collection has been reached.
protected AsyncSupplier<Object,SerializationException>	deserializeCollectionValue(SerializationContext context, TypeDefinition type, String path, List<SerializationRule> rules)
protected abstract AsyncSupplier<Pair<Object,Boolean>,SerializationException>	deserializeCollectionValueElement(SerializationContext.CollectionContext context, int elementIndex, String colPath, List<SerializationRule> rules) Return the element (possibly null) with true if an element is found, or null with false if the end of the collection has been reached.
protected AsyncSupplier<InputStream,SerializationException>	deserializeInputStreamAttributeValue(SerializationContext.AttributeContext context, List<SerializationRule> rules)
protected AsyncSupplier<InputStream,SerializationException>	deserializeInputStreamValue(SerializationContext context, List<SerializationRule> rules)
protected abstract AsyncSupplier<IO.Readable,SerializationException>	deserializeIOReadableAttributeValue(SerializationContext.AttributeContext context, List<SerializationRule> rules)
protected abstract AsyncSupplier<IO.Readable,SerializationException>	deserializeIOReadableValue(SerializationContext context, List<SerializationRule> rules)
protected AsyncSupplier<Map<?,?>,SerializationException>	deserializeMapAttributeValue(SerializationContext.AttributeContext context, String path, List<SerializationRule> rules)
protected AsyncSupplier<Map<?,?>,SerializationException>	deserializeMapValue(SerializationContext context, TypeDefinition typeDef, String path, List<SerializationRule> rules)
protected void	deserializeNextCollectionAttributeValueElement(SerializationContext.CollectionContext context, int elementIndex, String colPath, List<SerializationRule> rules, AsyncSupplier<Object,SerializationException> result)
protected void	deserializeNextCollectionValueElement(SerializationContext.CollectionContext context, int elementIndex, String colPath, List<SerializationRule> rules, AsyncSupplier<Object,SerializationException> result)
protected void	deserializeNextObjectAttribute(SerializationContext.ObjectContext context, String path, List<SerializationRule> rules, AsyncSupplier<Object,SerializationException> result)
protected AsyncSupplier<? extends Number,SerializationException>	deserializeNumericAttributeValue(SerializationContext.AttributeContext context, boolean nullable)
protected abstract AsyncSupplier<? extends Number,SerializationException>	deserializeNumericValue(Class<?> type, boolean nullable, Class<? extends IntegerUnit> targetUnit)
protected abstract AsyncSupplier<String,SerializationException>	deserializeObjectAttributeName(SerializationContext.ObjectContext context) Return the name of the attribute read, or null if the object is closed.
protected AsyncSupplier<Object,SerializationException>	deserializeObjectAttributeObjectValue(SerializationContext.AttributeContext context, String path, List<SerializationRule> rules)
protected void	deserializeObjectAttributes(SerializationContext parentContext, Object instance, TypeDefinition typeDef, String path, List<SerializationRule> rules, AsyncSupplier<Object,SerializationException> result)
protected AsyncSupplier<?,SerializationException>	deserializeObjectAttributeValue(SerializationContext.AttributeContext context, String path, List<SerializationRule> rules)
protected IAsync<SerializationException>	deserializeObjectAttributeValue(SerializationContext.ObjectContext context, SerializationClass.Attribute a, String path, List<SerializationRule> rules)
protected <T> AsyncSupplier<T,SerializationException>	deserializeObjectValue(SerializationContext context, TypeDefinition type, String path, List<SerializationRule> rules)
protected AsyncSupplier<? extends CharSequence,SerializationException>	deserializeStringAttributeValue(SerializationContext.AttributeContext context)
protected abstract AsyncSupplier<? extends CharSequence,SerializationException>	deserializeStringValue()
<T> AsyncSupplier<T,SerializationException>	deserializeValue(SerializationContext context, TypeDefinition type, String path, List<SerializationRule> rules) Deserialize a value.
protected abstract IAsync<SerializationException>	finalizeDeserialization()
protected static Map<?,?>	getMap(ArrayList<SerializationUtil.MapEntry> entries, TypeDefinition type, SerializationContext context, List<SerializationRule> rules)
int	getMaximumTextSize() Return the maximum text size, 0 or negative value means no limitation.
protected abstract IAsync<SerializationException>	initializeDeserialization(IO.Readable input)
void	setMaximumTextSize(int max) Set the maximum text size, 0 or negative value means no limitation.
protected AsyncSupplier<Boolean,SerializationException>	startCollectionAttributeValue(SerializationContext.AttributeContext context) Return true if the start has been found, false if null has been found, or an error.
protected abstract AsyncSupplier<Boolean,SerializationException>	startCollectionValue() Return true if the start has been found, false if null has been found, or an error.
protected abstract AsyncSupplier<Object,SerializationException>	startObjectValue(SerializationContext context, TypeDefinition type, List<SerializationRule> rules) Instantiate the type if the start of an object has been found, null if null has been found, or an error.
protected static Object	toArray(SerializationContext.CollectionContext context)

Methods inherited from class java.lang.Object

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

Field Detail

priority

protected byte priority

maxTextSize

protected int maxTextSize

taskDescription

protected final String taskDescription

streamReferenceHandlers

protected List<Deserializer.StreamReferenceHandler> streamReferenceHandlers

Constructor Detail

AbstractDeserializer

public AbstractDeserializer()

Method Detail

initializeDeserialization

protected abstract IAsync<SerializationException> initializeDeserialization(IO.Readable input)

finalizeDeserialization

protected abstract IAsync<SerializationException> finalizeDeserialization()

getMaximumTextSize

public int getMaximumTextSize()

Description copied from interface: Deserializer

Return the maximum text size, 0 or negative value means no limitation.

Specified by:

getMaximumTextSize in interface Deserializer

setMaximumTextSize

public void setMaximumTextSize(int max)

Description copied from interface: Deserializer

Set the maximum text size, 0 or negative value means no limitation.

Specified by:

setMaximumTextSize in interface Deserializer

deserialize

public <T> AsyncSupplier<T,SerializationException> deserialize(TypeDefinition type,
                                                               IO.Readable input,
                                                               List<SerializationRule> rules)

Description copied from interface: Deserializer

Deserialize an object/value of the given type from the given input.

Specified by:

deserialize in interface Deserializer

addRulesForType

protected List<SerializationRule> addRulesForType(SerializationClass type,
                                                  List<SerializationRule> currentList)

addRulesForAttribute

protected List<SerializationRule> addRulesForAttribute(SerializationClass.Attribute a,
                                                       List<SerializationRule> currentList)

deserializeValue

public <T> AsyncSupplier<T,SerializationException> deserializeValue(SerializationContext context,
                                                                    TypeDefinition type,
                                                                    String path,
                                                                    List<SerializationRule> rules)

Deserialize a value.

deserializeBooleanValue

protected abstract AsyncSupplier<Boolean,SerializationException> deserializeBooleanValue(boolean nullable)

deserializeBooleanAttributeValue

protected AsyncSupplier<Boolean,SerializationException> deserializeBooleanAttributeValue(SerializationContext.AttributeContext context,
                                                                                         boolean nullable)

deserializeNumericValue

protected abstract AsyncSupplier<? extends Number,SerializationException> deserializeNumericValue(Class<?> type,
                                                                                                  boolean nullable,
                                                                                                  Class<? extends IntegerUnit> targetUnit)

deserializeNumericAttributeValue

protected AsyncSupplier<? extends Number,SerializationException> deserializeNumericAttributeValue(SerializationContext.AttributeContext context,
                                                                                                  boolean nullable)

convertBigDecimalValue

public static void convertBigDecimalValue(BigDecimal n,
                                          Class<?> type,
                                          AsyncSupplier<Number,SerializationException> result)

Convert a BigDecimal into the specified type.

convertStringToInteger

public static Number convertStringToInteger(Class<?> type,
                                            String str,
                                            Class<? extends IntegerUnit> targetUnit)
                                     throws IntegerUnit.UnitConversionException,
                                            ParseException

Convert a string into an integer, optionally doing convertion into the targetUnit if any.

Throws:

IntegerUnit.UnitConversionException

ParseException

deserializeCharacterValue

protected AsyncSupplier<Character,SerializationException> deserializeCharacterValue(boolean nullable)

By default, deserialize a string and get the first character.

deserializeCharacterAttributeValue

protected AsyncSupplier<Character,SerializationException> deserializeCharacterAttributeValue(SerializationContext.AttributeContext context,
                                                                                             boolean nullable)

By default, deserialize a string and get the first character.

deserializeStringValue

protected abstract AsyncSupplier<? extends CharSequence,SerializationException> deserializeStringValue()

deserializeStringAttributeValue

protected AsyncSupplier<? extends CharSequence,SerializationException> deserializeStringAttributeValue(SerializationContext.AttributeContext context)

deserializeCollectionValue

protected AsyncSupplier<Object,SerializationException> deserializeCollectionValue(SerializationContext context,
                                                                                  TypeDefinition type,
                                                                                  String path,
                                                                                  List<SerializationRule> rules)

startCollectionValue

protected abstract AsyncSupplier<Boolean,SerializationException> startCollectionValue()

Return true if the start has been found, false if null has been found, or an error.

deserializeNextCollectionValueElement

protected void deserializeNextCollectionValueElement(SerializationContext.CollectionContext context,
                                                     int elementIndex,
                                                     String colPath,
                                                     List<SerializationRule> rules,
                                                     AsyncSupplier<Object,SerializationException> result)

deserializeCollectionValueElement

protected abstract AsyncSupplier<Pair<Object,Boolean>,SerializationException> deserializeCollectionValueElement(SerializationContext.CollectionContext context,
                                                                                                                int elementIndex,
                                                                                                                String colPath,
                                                                                                                List<SerializationRule> rules)

Return the element (possibly null) with true if an element is found, or null with false if the end of the collection has been reached.

deserializeCollectionAttributeValue

protected AsyncSupplier<Object,SerializationException> deserializeCollectionAttributeValue(SerializationContext.AttributeContext context,
                                                                                           String path,
                                                                                           List<SerializationRule> rules)

startCollectionAttributeValue

protected AsyncSupplier<Boolean,SerializationException> startCollectionAttributeValue(SerializationContext.AttributeContext context)

Return true if the start has been found, false if null has been found, or an error.

deserializeNextCollectionAttributeValueElement

protected void deserializeNextCollectionAttributeValueElement(SerializationContext.CollectionContext context,
                                                              int elementIndex,
                                                              String colPath,
                                                              List<SerializationRule> rules,
                                                              AsyncSupplier<Object,SerializationException> result)

toArray

protected static Object toArray(SerializationContext.CollectionContext context)

deserializeCollectionAttributeValueElement

protected AsyncSupplier<Pair<Object,Boolean>,SerializationException> deserializeCollectionAttributeValueElement(SerializationContext.CollectionContext context,
                                                                                                                int elementIndex,
                                                                                                                String colPath,
                                                                                                                List<SerializationRule> rules)

Return the element with true if an element is found, or null with false if the end of the collection has been reached.

deserializeMapValue

protected AsyncSupplier<Map<?,?>,SerializationException> deserializeMapValue(SerializationContext context,
                                                                             TypeDefinition typeDef,
                                                                             String path,
                                                                             List<SerializationRule> rules)

deserializeMapAttributeValue

protected AsyncSupplier<Map<?,?>,SerializationException> deserializeMapAttributeValue(SerializationContext.AttributeContext context,
                                                                                      String path,
                                                                                      List<SerializationRule> rules)

getMap

protected static Map<?,?> getMap(ArrayList<SerializationUtil.MapEntry> entries,
                                 TypeDefinition type,
                                 SerializationContext context,
                                 List<SerializationRule> rules)
                          throws SerializationException

Throws:

SerializationException

deserializeInputStreamValue

protected AsyncSupplier<InputStream,SerializationException> deserializeInputStreamValue(SerializationContext context,
                                                                                        List<SerializationRule> rules)

deserializeInputStreamAttributeValue

protected AsyncSupplier<InputStream,SerializationException> deserializeInputStreamAttributeValue(SerializationContext.AttributeContext context,
                                                                                                 List<SerializationRule> rules)

addStreamReferenceHandler

public void addStreamReferenceHandler(Deserializer.StreamReferenceHandler handler)

Description copied from interface: Deserializer

Register a stream reference handler.

Specified by:

addStreamReferenceHandler in interface Deserializer

deserializeIOReadableValue

protected abstract AsyncSupplier<IO.Readable,SerializationException> deserializeIOReadableValue(SerializationContext context,
                                                                                                List<SerializationRule> rules)

deserializeIOReadableAttributeValue

protected abstract AsyncSupplier<IO.Readable,SerializationException> deserializeIOReadableAttributeValue(SerializationContext.AttributeContext context,
                                                                                                         List<SerializationRule> rules)

deserializeByteArrayValue

protected AsyncSupplier<byte[],SerializationException> deserializeByteArrayValue(SerializationContext context,
                                                                                 List<SerializationRule> rules)

deserializeByteArrayAttributeValue

protected AsyncSupplier<byte[],SerializationException> deserializeByteArrayAttributeValue(SerializationContext.AttributeContext context,
                                                                                          List<SerializationRule> rules)

deserializeObjectValue

protected <T> AsyncSupplier<T,SerializationException> deserializeObjectValue(SerializationContext context,
                                                                             TypeDefinition type,
                                                                             String path,
                                                                             List<SerializationRule> rules)

startObjectValue

protected abstract AsyncSupplier<Object,SerializationException> startObjectValue(SerializationContext context,
                                                                                 TypeDefinition type,
                                                                                 List<SerializationRule> rules)

Instantiate the type if the start of an object has been found, null if null has been found, or an error. The context should be used to instantiate the object. The deserializer should handle the case a specific type to instantiate is specified, and may need to read a first attribute to get this type.

deserializeObjectAttributes

protected void deserializeObjectAttributes(SerializationContext parentContext,
                                           Object instance,
                                           TypeDefinition typeDef,
                                           String path,
                                           List<SerializationRule> rules,
                                           AsyncSupplier<Object,SerializationException> result)

deserializeNextObjectAttribute

protected void deserializeNextObjectAttribute(SerializationContext.ObjectContext context,
                                              String path,
                                              List<SerializationRule> rules,
                                              AsyncSupplier<Object,SerializationException> result)

deserializeObjectAttributeName

protected abstract AsyncSupplier<String,SerializationException> deserializeObjectAttributeName(SerializationContext.ObjectContext context)

Return the name of the attribute read, or null if the object is closed.

deserializeObjectAttributeValue

protected IAsync<SerializationException> deserializeObjectAttributeValue(SerializationContext.ObjectContext context,
                                                                         SerializationClass.Attribute a,
                                                                         String path,
                                                                         List<SerializationRule> rules)

deserializeObjectAttributeValue

protected AsyncSupplier<?,SerializationException> deserializeObjectAttributeValue(SerializationContext.AttributeContext context,
                                                                                  String path,
                                                                                  List<SerializationRule> rules)

convertFromStringToCharSequence

protected AsyncSupplier<Object,SerializationException> convertFromStringToCharSequence(AsyncSupplier<? extends CharSequence,SerializationException> str,
                                                                                       Class<?> target)

deserializeObjectAttributeObjectValue

protected AsyncSupplier<Object,SerializationException> deserializeObjectAttributeObjectValue(SerializationContext.AttributeContext context,
                                                                                             String path,
                                                                                             List<SerializationRule> rules)