A Marshaller to allowing serializing Java Object's to XML
Note: This class is not thread safe, and not intended to be,
so please create a new Marshaller for each thread if it
is to be used in a multithreaded environment.
addProcessingInstruction
public void addProcessingInstruction(String target,
String data)
Adds the given processing instruction data to the set of
processing instructions to output during marshalling.
target
- the processing instruction targetdata
- the processing instruction data
getMarshalExtendedType
public boolean getMarshalExtendedType()
If True the marshaller will use the 'xsi:type' attribute
to marshall a field value that extended the defined field type.
Default is True.
- If True the marshaller will use the 'xsi:type' attribute
to marshall a field value that extended the defined field type.
Default is True.
getNSPrefixAtRoot
public boolean getNSPrefixAtRoot()
Returns True if the given namespace mappings will be declared at the root node.
- Returns True if the given namespace mappings will be declared at the root node.
getRootElement
public String getRootElement()
Returns the name of the root element to use
- Returns the name of the root element to use
marshal
public static void marshal(Object object,
ContentHandler handler)
throws MarshalException,
ValidationException,
IOException
Marshals the given Object as XML using the given ContentHandler
to send events to.
handler
- the ContentHandler to marshal to
marshal
public static void marshal(Object object,
DocumentHandler handler)
throws MarshalException,
ValidationException
Marshals the given Object as XML using the given DocumentHandler
to send events to.
handler
- the DocumentHandler to marshal to
marshal
public static void marshal(Object object,
Node node)
throws MarshalException,
ValidationException
Marshals the given Object as XML using the given DOM Node
to send events to.
node
- the DOM Node to marshal to
marshal
public static void marshal(Object object,
Writer out)
throws MarshalException,
ValidationException
Marshals the given Object as XML using the given writer
out
- the writer to marshal to
setDebug
public void setDebug(boolean debug)
Sets the flag to turn on and off debugging
debug
- the flag indicating whether or not debug information
should be generated
setDoctype
public void setDoctype(String publicId,
String systemId)
Sets the document type definition for the serializer. Note that this method
cannot be called if you've passed in your own DocumentHandler.
publicId
- the public identifiersystemId
- the system identifier
setEncoding
public void setEncoding(String encoding)
Sets the encoding for the serializer. Note that this method
cannot be called if you've passed in your own DocumentHandler.
encoding
- the encoding to set
setLogWriter
public void setLogWriter(PrintWriter printWriter)
Sets the PrintWriter used for logging
printWriter
- the PrintWriter to use for logging
setMapping
public void setMapping(Mapping mapping)
throws MappingException
Sets the given mapping to be used by the marshalling
Framework. If a ClassDescriptorResolver exists
This mapping will be added to the existing Resolver. Otherwise
a new ClassDescriptorResolver will be created.
mapping
- the mapping to using during marshalling
setMarshalAsDocument
public void setMarshalAsDocument(boolean asDocument)
Sets whether or not to marshal as a document which includes
the XML declaration, and if necessary the DOCTYPE declaration.
By default the Marshaller will marshal as a well formed
XML fragment (no XML declaration or DOCTYPE).
asDocument
- a boolean, when true, indicating to marshal
as a complete XML document.
setMarshalExtendedType
public void setMarshalExtendedType(boolean marshalExtendedType)
If True the marshaller will use the 'xsi:type' attribute
to marshall a field value that extended the defined field type.
Default is True.
setMarshalListener
public void setMarshalListener(MarshalListener listener)
Sets an optional MarshalListener to recieve pre and post
marshal notification for each Object in the tree.
MarshalListener is only for complex objects that map
into elements, simpleTypes and types that map into
attributes do not cause any pre and post event notifications.
Current only one (1) listener is allowed. If you need
register multiple listeners, you will have to create
your own master listener that will forward the
event notifications and manage the multiple
listeners.
listener
- the MarshalListener to set.
setNSPrefixAtRoot
public void setNSPrefixAtRoot(boolean nsPrefixAtRoot)
Set to True to declare the given namespace mappings at the root node. Default is False.
setNamespaceMapping
public void setNamespaceMapping(String nsPrefix,
String nsURI)
Sets the mapping for the given Namespace prefix
nsPrefix
- the namespace prefixnsURI
- the namespace that the prefix resolves to
setNoNamespaceSchemaLocation
public void setNoNamespaceSchemaLocation(String schemaLocation)
Sets the value for the xsi:noNamespaceSchemaLocation attribute.
When set, this attribute will appear on the root element
of the marshalled document.
schemaLocation
- the URI location of the schema
to which the marshalled document is an instance of.
setResolver
public void setResolver(ClassDescriptorResolver cdr)
Sets the ClassDescriptorResolver to use during unmarshalling
cdr
- the ClassDescriptorResolver to use
setRootElement
public void setRootElement(String rootElement)
Sets the name of the root element to use
setSchemaLocation
public void setSchemaLocation(String schemaLocation)
Sets the value for the xsi:schemaLocation attribute.
When set, this attribute will appear on the root element
of the marshalled document.
schemaLocation
- the URI location of the schema
to which the marshalled document is an instance of.
setSuppressXSIType
public void setSuppressXSIType(boolean suppressXSIType)
Sets whether or not the xsi:type attribute should appear
on the marshalled document.
suppressXSIType
- a boolean that when true will prevent
xsi:type attribute from being used in the marshalling process.
setValidation
public void setValidation(boolean validate)
Sets whether or not to validate the object model
before marshalling. By default validation is enabled.
This method is really for debugging.
I do not recommend turning off validation, since
you could marshal a document, which you can then
not unmarshal. If you know the object model
is guaranteed to be valid, disabling validation will
improve performace.
validate
- the boolean indicating whether or not to
validate the object model before marshalling.