net.lecousin.framework.xml.serialization

Class XMLDeserializer

java.lang.Object

net.lecousin.framework.io.serialization.AbstractDeserializer

net.lecousin.framework.xml.serialization.XMLDeserializer

All Implemented Interfaces:

Deserializer

public class XMLDeserializer
extends AbstractDeserializer

XML Deserialization.

Nested Class Summary

Nested classes/interfaces inherited from class net.lecousin.framework.io.serialization.AbstractDeserializer

AbstractDeserializer.DeserializationTask

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

Deserializer.StreamReferenceHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected String	expectedRootLocalName
protected String	expectedRootNamespaceURI
protected Charset	forceEncoding
protected XMLStreamEventsAsync	input
protected static Function<Exception,SerializationException>	xmlErrorConverter

Fields inherited from class net.lecousin.framework.io.serialization.AbstractDeserializer

maxTextSize, priority, streamReferenceHandlers, taskDescription

Constructor Summary

Constructors

Constructor and Description
XMLDeserializer(String expectedRootNamespaceURI, String expectedRootLocalName) Constructor.
XMLDeserializer(String expectedRootNamespaceURI, String expectedRootLocalName, Charset encoding) Constructor.
XMLDeserializer(XMLStreamEventsAsync input, String expectedRootNamespaceURI, String expectedRootLocalName) Create a deserializer using a given XMLStreamEventsAsync, which must be positionned on the root element for the deserialization.

Method Summary

Modifier and Type	Method and Description
protected IAsync<Exception>	createAndStartReader(IO.Readable input)
static <T> AsyncSupplier<T,SerializationException>	deserialize(IO.Readable input, Class<T> type, List<SerializationRule> rules) Deserialize from a IO.Readable.
protected AsyncSupplier<Boolean,SerializationException>	deserializeBooleanAttributeValue(SerializationContext.AttributeContext context, boolean nullable)
protected AsyncSupplier<Boolean,SerializationException>	deserializeBooleanValue(boolean nullable)
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<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.
static <T> AsyncSupplier<T,SerializationException>	deserializeFile(File file, Class<T> type, List<SerializationRule> rules, byte priority) Deserialize from a file.
protected AsyncSupplier<IO.Readable,SerializationException>	deserializeIOReadableAttributeValue(SerializationContext.AttributeContext context, List<SerializationRule> rules)
protected AsyncSupplier<IO.Readable,SerializationException>	deserializeIOReadableValue(SerializationContext context, List<SerializationRule> rules)
protected AsyncSupplier<? extends Number,SerializationException>	deserializeNumericAttributeValue(SerializationContext.AttributeContext context, boolean nullable)
protected AsyncSupplier<? extends Number,SerializationException>	deserializeNumericValue(Class<?> type, boolean nullable, Class<? extends IntegerUnit> targetUnit)
protected AsyncSupplier<String,SerializationException>	deserializeObjectAttributeName(SerializationContext.ObjectContext context) Return the name of the attribute read, or null if the object is closed.
protected AsyncSupplier<?,SerializationException>	deserializeObjectAttributeValue(SerializationContext.AttributeContext context, String path, List<SerializationRule> rules)
static <T> AsyncSupplier<T,SerializationException>	deserializeResource(String resourcePath, Class<T> type, List<SerializationRule> rules, byte priority) Deserialize from a file accessible from the classpath.
protected AsyncSupplier<? extends CharSequence,SerializationException>	deserializeStringAttributeValue(SerializationContext.AttributeContext context)
protected AsyncSupplier<? extends CharSequence,SerializationException>	deserializeStringValue()
protected IAsync<SerializationException>	finalizeDeserialization()
static boolean	hasAttribute(Class<?> type, String name) Return true if the given class contains the requested attribute, either as a field or with a getter or setter.
protected 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>	startCollectionValue() Return true if the start has been found, false if null has been found, or an error.
protected 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.

Methods inherited from class net.lecousin.framework.io.serialization.AbstractDeserializer

addRulesForAttribute, addRulesForType, addStreamReferenceHandler, convertBigDecimalValue, convertFromStringToCharSequence, convertStringToInteger, deserialize, deserializeByteArrayAttributeValue, deserializeByteArrayValue, deserializeCharacterAttributeValue, deserializeCharacterValue, deserializeCollectionAttributeValue, deserializeCollectionValue, deserializeInputStreamAttributeValue, deserializeInputStreamValue, deserializeMapAttributeValue, deserializeMapValue, deserializeNextCollectionAttributeValueElement, deserializeNextCollectionValueElement, deserializeNextObjectAttribute, deserializeObjectAttributeObjectValue, deserializeObjectAttributes, deserializeObjectAttributeValue, deserializeObjectValue, deserializeValue, getMap, getMaximumTextSize, startCollectionAttributeValue, toArray

Methods inherited from class java.lang.Object

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

Field Detail

expectedRootNamespaceURI

protected String expectedRootNamespaceURI

expectedRootLocalName

protected String expectedRootLocalName

forceEncoding

protected Charset forceEncoding

input

protected XMLStreamEventsAsync input

xmlErrorConverter

protected static final Function<Exception,SerializationException> xmlErrorConverter

Constructor Detail

XMLDeserializer

public XMLDeserializer(String expectedRootNamespaceURI,
                       String expectedRootLocalName)

Constructor.

XMLDeserializer

public XMLDeserializer(String expectedRootNamespaceURI,
                       String expectedRootLocalName,
                       Charset encoding)

Constructor.

XMLDeserializer

public XMLDeserializer(XMLStreamEventsAsync input,
                       String expectedRootNamespaceURI,
                       String expectedRootLocalName)

Create a deserializer using a given XMLStreamEventsAsync, which must be positionned on the root element for the deserialization. Because we give directly a XMLStreamEventsAsync, the method to call must be deserializeValue instead of the usual deserialize.

Method Detail

deserializeResource

public static <T> AsyncSupplier<T,SerializationException> deserializeResource(String resourcePath,
                                                                              Class<T> type,
                                                                              List<SerializationRule> rules,
                                                                              byte priority)

Deserialize from a file accessible from the classpath.

deserializeFile

public static <T> AsyncSupplier<T,SerializationException> deserializeFile(File file,
                                                                          Class<T> type,
                                                                          List<SerializationRule> rules,
                                                                          byte priority)

Deserialize from a file.

deserialize

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

Deserialize from a IO.Readable.

createAndStartReader

protected IAsync<Exception> createAndStartReader(IO.Readable input)

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

Overrides:

setMaximumTextSize in class AbstractDeserializer

initializeDeserialization

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

Specified by:

initializeDeserialization in class AbstractDeserializer

finalizeDeserialization

protected IAsync<SerializationException> finalizeDeserialization()

Specified by:

finalizeDeserialization in class AbstractDeserializer

deserializeBooleanValue

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

Specified by:

deserializeBooleanValue in class AbstractDeserializer

deserializeNumericValue

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

Specified by:

deserializeNumericValue in class AbstractDeserializer

deserializeStringValue

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

Specified by:

deserializeStringValue in class AbstractDeserializer

startCollectionValue

protected AsyncSupplier<Boolean,SerializationException> startCollectionValue()

Description copied from class: AbstractDeserializer

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

Specified by:

startCollectionValue in class AbstractDeserializer

deserializeCollectionValueElement

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

Description copied from class: AbstractDeserializer

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.

Specified by:

deserializeCollectionValueElement in class AbstractDeserializer

startObjectValue

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

Description copied from class: AbstractDeserializer

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.

Specified by:

startObjectValue in class AbstractDeserializer

hasAttribute

public static boolean hasAttribute(Class<?> type,
                                   String name)

Return true if the given class contains the requested attribute, either as a field or with a getter or setter.

deserializeObjectAttributeName

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

Description copied from class: AbstractDeserializer

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

Specified by:

deserializeObjectAttributeName in class AbstractDeserializer

deserializeBooleanAttributeValue

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

Overrides:

deserializeBooleanAttributeValue in class AbstractDeserializer

deserializeNumericAttributeValue

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

Overrides:

deserializeNumericAttributeValue in class AbstractDeserializer

deserializeStringAttributeValue

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

Overrides:

deserializeStringAttributeValue in class AbstractDeserializer

deserializeCollectionAttributeValueElement

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

Description copied from class: AbstractDeserializer

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

Overrides:

deserializeCollectionAttributeValueElement in class AbstractDeserializer

deserializeIOReadableValue

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

Specified by:

deserializeIOReadableValue in class AbstractDeserializer

deserializeIOReadableAttributeValue

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

Specified by:

deserializeIOReadableAttributeValue in class AbstractDeserializer

deserializeObjectAttributeValue

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

Overrides:

deserializeObjectAttributeValue in class AbstractDeserializer