net.lecousin.framework.xml.serialization

Class XMLSerializer

java.lang.Object

net.lecousin.framework.io.serialization.AbstractSerializer

net.lecousin.framework.xml.serialization.XMLSerializer

All Implemented Interfaces:

Serializer

public class XMLSerializer
extends AbstractSerializer

Serialization into XML.

Nested Class Summary

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

AbstractSerializer.SerializationTask

Field Summary

Fields

Modifier and Type	Field and Description
protected static Comparator<SerializationClass.Attribute>	attributesComparator
protected IO.Writable.Buffered	bout
protected int	bufferSize
protected Charset	encoding
protected boolean	includeXMLDeclaration
protected Map<String,String>	namespaces
protected XMLWriter	output
protected boolean	pretty
protected String	rootLocalName
protected String	rootNamespaceURI

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

priority

Constructor Summary

Constructors

Constructor and Description
XMLSerializer(String rootNamespaceURI, String rootLocalName, Map<String,String> namespaces) Constructor.
XMLSerializer(String rootNamespaceURI, String rootLocalName, Map<String,String> namespaces, boolean includeXMLDeclaration) Constructor.
XMLSerializer(String rootNamespaceURI, String rootLocalName, Map<String,String> namespaces, Charset encoding) Constructor.
XMLSerializer(String rootNamespaceURI, String rootLocalName, Map<String,String> namespaces, Charset encoding, boolean includeXMLDeclaration) Constructor.
XMLSerializer(String rootNamespaceURI, String rootLocalName, Map<String,String> namespaces, Charset encoding, int bufferSize) Constructor.
XMLSerializer(String rootNamespaceURI, String rootLocalName, Map<String,String> namespaces, Charset encoding, int bufferSize, boolean includeXMLDeclaration) Constructor.
XMLSerializer(XMLWriter writer) Constructor.

Method Summary

Modifier and Type	Method and Description
protected IAsync<SerializationException>	endCollectionValue(SerializationContext.CollectionContext context, String path, List<SerializationRule> rules)
protected IAsync<SerializationException>	endCollectionValueElement(SerializationContext.CollectionContext context, Object element, int elementIndex, String elementPath, List<SerializationRule> rules)
protected IAsync<SerializationException>	endObjectValue(SerializationContext.ObjectContext context, String path, List<SerializationRule> rules)
protected IAsync<SerializationException>	finalizeSerialization()
protected IAsync<SerializationException>	initializeSerialization(IO.Writable output)
protected IAsync<SerializationException>	serializeAttribute(SerializationContext.AttributeContext context, String path, List<SerializationRule> rules)
protected IAsync<SerializationException>	serializeBooleanAttribute(SerializationContext.AttributeContext context, boolean value, String path)
protected IAsync<SerializationException>	serializeBooleanValue(boolean value)
protected IAsync<SerializationException>	serializeCharacterAttribute(SerializationContext.AttributeContext context, char value, String path)
protected IAsync<SerializationException>	serializeCharacterValue(char value)
protected IAsync<SerializationException>	serializeCollectionAttribute(SerializationContext.CollectionContext context, String path, List<SerializationRule> rules)
protected void	serializeCollectionAttributeElement(SerializationContext.CollectionContext context, Iterator<?> it, int elementIndex, String colPath, List<SerializationRule> rules, Async<SerializationException> result)
protected IAsync<SerializationException>	serializeIOReadableAttribute(SerializationContext.AttributeContext context, IO.Readable io, String path, List<SerializationRule> rules)
protected IAsync<SerializationException>	serializeIOReadableValue(SerializationContext context, IO.Readable io, String path, List<SerializationRule> rules)
protected IAsync<SerializationException>	serializeNullAttribute(SerializationContext.AttributeContext context, String path)
protected IAsync<SerializationException>	serializeNullValue()
protected IAsync<SerializationException>	serializeNumericAttribute(SerializationContext.AttributeContext context, Number value, String path)
protected IAsync<SerializationException>	serializeNumericValue(Number value)
protected IAsync<SerializationException>	serializeObjectAttribute(SerializationContext.AttributeContext context, Object value, String path, List<SerializationRule> rules)
protected IAsync<SerializationException>	serializeStringAttribute(SerializationContext.AttributeContext context, CharSequence value, String path)
protected IAsync<SerializationException>	serializeStringValue(CharSequence value)
void	setPretty(boolean pretty)
protected List<SerializationClass.Attribute>	sortAttributes(List<SerializationClass.Attribute> attributes)
protected IAsync<SerializationException>	startCollectionValue(SerializationContext.CollectionContext context, String path, List<SerializationRule> rules)
protected IAsync<SerializationException>	startCollectionValueElement(SerializationContext.CollectionContext context, Object element, int elementIndex, String elementPath, List<SerializationRule> rules)
protected IAsync<SerializationException>	startObjectValue(SerializationContext.ObjectContext context, String path, List<SerializationRule> rules)

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

addRulesForAttribute, addRulesForType, serialize, serializeAttribute, serializeByteArrayAttribute, serializeByteArrayValue, serializeCollectionElement, serializeCollectionValue, serializeInputStreamAttribute, serializeInputStreamValue, serializeMapAttribute, serializeMapValue, serializeObjectValue, serializeObjectValue, serializeValue

Methods inherited from class java.lang.Object

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

Field Detail

rootNamespaceURI

protected String rootNamespaceURI

rootLocalName

protected String rootLocalName

namespaces

protected Map<String,String> namespaces

encoding

protected Charset encoding

bufferSize

protected int bufferSize

includeXMLDeclaration

protected boolean includeXMLDeclaration

bout

protected IO.Writable.Buffered bout

output

protected XMLWriter output

pretty

protected boolean pretty

attributesComparator

protected static final Comparator<SerializationClass.Attribute> attributesComparator

Constructor Detail

XMLSerializer

public XMLSerializer(String rootNamespaceURI,
                     String rootLocalName,
                     Map<String,String> namespaces)

Constructor.

XMLSerializer

public XMLSerializer(String rootNamespaceURI,
                     String rootLocalName,
                     Map<String,String> namespaces,
                     boolean includeXMLDeclaration)

Constructor.

XMLSerializer

public XMLSerializer(String rootNamespaceURI,
                     String rootLocalName,
                     Map<String,String> namespaces,
                     Charset encoding)

Constructor.

XMLSerializer

public XMLSerializer(String rootNamespaceURI,
                     String rootLocalName,
                     Map<String,String> namespaces,
                     Charset encoding,
                     boolean includeXMLDeclaration)

Constructor.

XMLSerializer

public XMLSerializer(String rootNamespaceURI,
                     String rootLocalName,
                     Map<String,String> namespaces,
                     Charset encoding,
                     int bufferSize)

Constructor.

XMLSerializer

public XMLSerializer(String rootNamespaceURI,
                     String rootLocalName,
                     Map<String,String> namespaces,
                     Charset encoding,
                     int bufferSize,
                     boolean includeXMLDeclaration)

Constructor.

XMLSerializer

public XMLSerializer(XMLWriter writer)

Constructor.

Method Detail

setPretty

public void setPretty(boolean pretty)

initializeSerialization

protected IAsync<SerializationException> initializeSerialization(IO.Writable output)

Specified by:

initializeSerialization in class AbstractSerializer

finalizeSerialization

protected IAsync<SerializationException> finalizeSerialization()

Specified by:

finalizeSerialization in class AbstractSerializer

serializeBooleanValue

protected IAsync<SerializationException> serializeBooleanValue(boolean value)

Specified by:

serializeBooleanValue in class AbstractSerializer

serializeNullValue

protected IAsync<SerializationException> serializeNullValue()

Specified by:

serializeNullValue in class AbstractSerializer

serializeCharacterValue

protected IAsync<SerializationException> serializeCharacterValue(char value)

Specified by:

serializeCharacterValue in class AbstractSerializer

serializeNumericValue

protected IAsync<SerializationException> serializeNumericValue(Number value)

Specified by:

serializeNumericValue in class AbstractSerializer

serializeStringValue

protected IAsync<SerializationException> serializeStringValue(CharSequence value)

Specified by:

serializeStringValue in class AbstractSerializer

startCollectionValue

protected IAsync<SerializationException> startCollectionValue(SerializationContext.CollectionContext context,
                                                              String path,
                                                              List<SerializationRule> rules)

Specified by:

startCollectionValue in class AbstractSerializer

startCollectionValueElement

protected IAsync<SerializationException> startCollectionValueElement(SerializationContext.CollectionContext context,
                                                                     Object element,
                                                                     int elementIndex,
                                                                     String elementPath,
                                                                     List<SerializationRule> rules)

Specified by:

startCollectionValueElement in class AbstractSerializer

endCollectionValueElement

protected IAsync<SerializationException> endCollectionValueElement(SerializationContext.CollectionContext context,
                                                                   Object element,
                                                                   int elementIndex,
                                                                   String elementPath,
                                                                   List<SerializationRule> rules)

Specified by:

endCollectionValueElement in class AbstractSerializer

endCollectionValue

protected IAsync<SerializationException> endCollectionValue(SerializationContext.CollectionContext context,
                                                            String path,
                                                            List<SerializationRule> rules)

Specified by:

endCollectionValue in class AbstractSerializer

sortAttributes

protected List<SerializationClass.Attribute> sortAttributes(List<SerializationClass.Attribute> attributes)

Overrides:

sortAttributes in class AbstractSerializer

startObjectValue

protected IAsync<SerializationException> startObjectValue(SerializationContext.ObjectContext context,
                                                          String path,
                                                          List<SerializationRule> rules)

Specified by:

startObjectValue in class AbstractSerializer

endObjectValue

protected IAsync<SerializationException> endObjectValue(SerializationContext.ObjectContext context,
                                                        String path,
                                                        List<SerializationRule> rules)

Specified by:

endObjectValue in class AbstractSerializer

serializeNullAttribute

protected IAsync<SerializationException> serializeNullAttribute(SerializationContext.AttributeContext context,
                                                                String path)

Specified by:

serializeNullAttribute in class AbstractSerializer

serializeBooleanAttribute

protected IAsync<SerializationException> serializeBooleanAttribute(SerializationContext.AttributeContext context,
                                                                   boolean value,
                                                                   String path)

Specified by:

serializeBooleanAttribute in class AbstractSerializer

serializeNumericAttribute

protected IAsync<SerializationException> serializeNumericAttribute(SerializationContext.AttributeContext context,
                                                                   Number value,
                                                                   String path)

Specified by:

serializeNumericAttribute in class AbstractSerializer

serializeCharacterAttribute

protected IAsync<SerializationException> serializeCharacterAttribute(SerializationContext.AttributeContext context,
                                                                     char value,
                                                                     String path)

Specified by:

serializeCharacterAttribute in class AbstractSerializer

serializeStringAttribute

protected IAsync<SerializationException> serializeStringAttribute(SerializationContext.AttributeContext context,
                                                                  CharSequence value,
                                                                  String path)

Specified by:

serializeStringAttribute in class AbstractSerializer

serializeObjectAttribute

protected IAsync<SerializationException> serializeObjectAttribute(SerializationContext.AttributeContext context,
                                                                  Object value,
                                                                  String path,
                                                                  List<SerializationRule> rules)

Specified by:

serializeObjectAttribute in class AbstractSerializer

serializeCollectionAttribute

protected IAsync<SerializationException> serializeCollectionAttribute(SerializationContext.CollectionContext context,
                                                                      String path,
                                                                      List<SerializationRule> rules)

Specified by:

serializeCollectionAttribute in class AbstractSerializer

serializeCollectionAttributeElement

protected void serializeCollectionAttributeElement(SerializationContext.CollectionContext context,
                                                   Iterator<?> it,
                                                   int elementIndex,
                                                   String colPath,
                                                   List<SerializationRule> rules,
                                                   Async<SerializationException> result)

serializeIOReadableValue

protected IAsync<SerializationException> serializeIOReadableValue(SerializationContext context,
                                                                  IO.Readable io,
                                                                  String path,
                                                                  List<SerializationRule> rules)

Specified by:

serializeIOReadableValue in class AbstractSerializer

serializeIOReadableAttribute

protected IAsync<SerializationException> serializeIOReadableAttribute(SerializationContext.AttributeContext context,
                                                                      IO.Readable io,
                                                                      String path,
                                                                      List<SerializationRule> rules)

Specified by:

serializeIOReadableAttribute in class AbstractSerializer

serializeAttribute

protected IAsync<SerializationException> serializeAttribute(SerializationContext.AttributeContext context,
                                                            String path,
                                                            List<SerializationRule> rules)

Overrides:

serializeAttribute in class AbstractSerializer