net.lecousin.framework.xml.serialization

Class XMLSpecWriter

java.lang.Object

net.lecousin.framework.io.serialization.AbstractSerializationSpecWriter

net.lecousin.framework.xml.serialization.XMLSpecWriter

All Implemented Interfaces:

SerializationSpecWriter

public class XMLSpecWriter
extends AbstractSerializationSpecWriter

Write an XSD corresponding to what would be serialized in XML.

Nested Class Summary

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

AbstractSerializationSpecWriter.SpecTask

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.AbstractSerializationSpecWriter

priority

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected IAsync<SerializationException>	finalizeSpecWriter()
static String	getTypeName(Class<?> type) Return the name for a type, replacing dollars by minus character.
protected IAsync<SerializationException>	initializeSpecWriter(IO.Writable output)
protected static boolean	isAttribute(Class<?> c)
void	setPretty(boolean pretty)
protected List<SerializationClass.Attribute>	sortAttributes(List<SerializationClass.Attribute> attributes)
protected IAsync<SerializationException>	specifyAnyValue(SerializationContext context)
protected IAsync<SerializationException>	specifyBooleanValue(SerializationContext context, boolean nullable)
protected IAsync<SerializationException>	specifyCharacterValue(SerializationContext context, boolean nullable)
protected IAsync<SerializationException>	specifyCollectionValue(SerializationContext.CollectionContext context, List<SerializationRule> rules)
protected IAsync<SerializationException>	specifyEnumValue(SerializationContext context, TypeDefinition type)
protected IAsync<SerializationException>	specifyIOReadableValue(SerializationContext context, List<SerializationRule> rules)
protected IAsync<SerializationException>	specifyNumericValue(SerializationContext context, Class<?> type, boolean nullable, Number min, Number max)
protected IAsync<SerializationException>	specifyStringValue(SerializationContext context, TypeDefinition type)
protected IAsync<SerializationException>	specifyTypeAttribute(SerializationContext.AttributeContext context, List<SerializationRule> rules)
protected IAsync<SerializationException>	specifyTypedValue(SerializationContext.ObjectContext context, List<SerializationRule> rules)

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

addRulesForAttribute, addRulesForType, specifyByteArrayValue, specifyInputStreamValue, specifyMapValue, specifyObjectValue, specifyTypeAttribute, specifyTypeContent, specifyValue, writeSpecification

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

XMLSpecWriter

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

Constructor.

XMLSpecWriter

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

Constructor.

XMLSpecWriter

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

Constructor.

XMLSpecWriter

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

Constructor.

XMLSpecWriter

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

Constructor.

XMLSpecWriter

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

Constructor.

Method Detail

setPretty

public void setPretty(boolean pretty)

initializeSpecWriter

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

Specified by:

initializeSpecWriter in class AbstractSerializationSpecWriter

finalizeSpecWriter

protected IAsync<SerializationException> finalizeSpecWriter()

Specified by:

finalizeSpecWriter in class AbstractSerializationSpecWriter

specifyBooleanValue

protected IAsync<SerializationException> specifyBooleanValue(SerializationContext context,
                                                             boolean nullable)

Specified by:

specifyBooleanValue in class AbstractSerializationSpecWriter

specifyNumericValue

protected IAsync<SerializationException> specifyNumericValue(SerializationContext context,
                                                             Class<?> type,
                                                             boolean nullable,
                                                             Number min,
                                                             Number max)

Specified by:

specifyNumericValue in class AbstractSerializationSpecWriter

specifyStringValue

protected IAsync<SerializationException> specifyStringValue(SerializationContext context,
                                                            TypeDefinition type)

Specified by:

specifyStringValue in class AbstractSerializationSpecWriter

specifyCharacterValue

protected IAsync<SerializationException> specifyCharacterValue(SerializationContext context,
                                                               boolean nullable)

Specified by:

specifyCharacterValue in class AbstractSerializationSpecWriter

specifyEnumValue

protected IAsync<SerializationException> specifyEnumValue(SerializationContext context,
                                                          TypeDefinition type)

Specified by:

specifyEnumValue in class AbstractSerializationSpecWriter

specifyCollectionValue

protected IAsync<SerializationException> specifyCollectionValue(SerializationContext.CollectionContext context,
                                                                List<SerializationRule> rules)

Specified by:

specifyCollectionValue in class AbstractSerializationSpecWriter

specifyIOReadableValue

protected IAsync<SerializationException> specifyIOReadableValue(SerializationContext context,
                                                                List<SerializationRule> rules)

Specified by:

specifyIOReadableValue in class AbstractSerializationSpecWriter

getTypeName

public static String getTypeName(Class<?> type)

Return the name for a type, replacing dollars by minus character.

specifyAnyValue

protected IAsync<SerializationException> specifyAnyValue(SerializationContext context)

Specified by:

specifyAnyValue in class AbstractSerializationSpecWriter

specifyTypedValue

protected IAsync<SerializationException> specifyTypedValue(SerializationContext.ObjectContext context,
                                                           List<SerializationRule> rules)

Specified by:

specifyTypedValue in class AbstractSerializationSpecWriter

isAttribute

protected static final boolean isAttribute(Class<?> c)

sortAttributes

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

Overrides:

sortAttributes in class AbstractSerializationSpecWriter

specifyTypeAttribute

protected IAsync<SerializationException> specifyTypeAttribute(SerializationContext.AttributeContext context,
                                                              List<SerializationRule> rules)

Specified by:

specifyTypeAttribute in class AbstractSerializationSpecWriter