|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.exolab.castor.xml.MarshalFramework
org.exolab.castor.xml.Marshaller
public class Marshaller
A Marshaller that serializes 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.
Nested Class Summary | |
---|---|
(package private) static class |
Marshaller.MarshalState
|
static class |
Marshaller.NilObject
A wrapper for a "Nil" object |
(package private) static class |
Marshaller.WrapperInfo
Inner-class used for handling wrapper elements and locations |
Nested classes/interfaces inherited from class org.exolab.castor.xml.MarshalFramework |
---|
MarshalFramework.InheritanceMatch, MarshalFramework.InternalXMLClassDescriptor |
Field Summary | |
---|---|
(package private) int |
depth
The depth of the sub tree, 0 denotes document level |
static boolean |
enableDebug
A static flag used to enable debugging when using the static marshal methods. |
Fields inherited from class org.exolab.castor.xml.MarshalFramework |
---|
INTERNAL_XML_NAME, JAVA_PREFIX, LANG_ATTR, NIL_ATTR, NO_FIELD_DESCRIPTORS, QNAME_NAME, SPACE_ATTR, TRUE_VALUE, TYPE_ATTR, XML_LANG_ATTR, XML_SPACE_ATTR, XSI_NAMESPACE, XSI_NIL_ATTR, XSI_NO_NAMESPACE_SCHEMA_LOCATION, XSI_SCHEMA_LOCATION |
Constructor Summary | |
---|---|
Marshaller(org.xml.sax.ContentHandler handler)
Creates a new Marshaller with the given SAX ContentHandler. |
|
Marshaller(org.xml.sax.DocumentHandler handler)
Creates a new Marshaller with the given DocumentHandler. |
|
Marshaller(org.w3c.dom.Node node)
Creates a new Marshaller for the given DOM Node. |
|
Marshaller(java.io.Writer out)
Creates a new Marshaller with the given writer. |
Method Summary | |
---|---|
void |
addProcessingInstruction(java.lang.String target,
java.lang.String data)
Adds the given processing instruction data to the set of processing instructions to output during marshalling. |
boolean |
getMarshalExtendedType()
If True the marshaller will use the 'xsi:type' attribute to marshall a field value that extended the defined field type. |
boolean |
getNSPrefixAtRoot()
Deprecated. |
ClassDescriptorResolver |
getResolver()
Returns the ClassDescriptorResolver for use during marshalling |
java.lang.String |
getRootElement()
Returns the name of the root element to use |
void |
marshal(java.lang.Object object)
Marshals the given Object as XML using the DocumentHandler for this Marshaller. |
static void |
marshal(java.lang.Object object,
org.xml.sax.ContentHandler handler)
Marshals the given Object as XML using the given ContentHandler to send events to. |
static void |
marshal(java.lang.Object object,
org.xml.sax.DocumentHandler handler)
Marshals the given Object as XML using the given DocumentHandler to send events to. |
static void |
marshal(java.lang.Object object,
org.w3c.dom.Node node)
Marshals the given Object as XML using the given DOM Node to send events to. |
static void |
marshal(java.lang.Object object,
java.io.Writer out)
Marshals the given Object as XML using the given writer |
void |
setDebug(boolean debug)
Sets the flag to turn on and off debugging |
void |
setDoctype(java.lang.String publicId,
java.lang.String systemId)
Sets the document type definition for the serializer. |
void |
setEncoding(java.lang.String encoding)
Sets the encoding for the serializer. |
void |
setLogWriter(java.io.PrintWriter printWriter)
Sets the PrintWriter used for logging |
void |
setMapping(Mapping mapping)
Sets the given mapping to be used by the marshalling Framework. |
void |
setMarshalAsDocument(boolean asDocument)
Sets whether or not to marshal as a document which includes the XML declaration, and if necessary the DOCTYPE declaration. |
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. |
void |
setMarshalListener(MarshalListener listener)
Sets an optional MarshalListener to recieve pre and post marshal notification for each Object in the tree. |
void |
setNamespaceMapping(java.lang.String nsPrefix,
java.lang.String nsURI)
Sets the mapping for the given Namespace prefix |
void |
setNoNamespaceSchemaLocation(java.lang.String schemaLocation)
Sets the value for the xsi:noNamespaceSchemaLocation attribute. |
void |
setNSPrefixAtRoot(boolean nsPrefixAtRoot)
Deprecated. |
void |
setResolver(ClassDescriptorResolver cdr)
Sets the ClassDescriptorResolver to use during marshalling Note: This method will nullify any Mapping currently being used by this Marshaller |
void |
setRootElement(java.lang.String rootElement)
Sets the name of the root element to use |
void |
setSchemaLocation(java.lang.String schemaLocation)
Sets the value for the xsi:schemaLocation attribute. |
void |
setSuppressNamespaces(boolean suppressNamespaces)
Sets whether or not namespaces are output. |
void |
setSuppressXSIType(boolean suppressXSIType)
Sets whether or not the xsi:type attribute should appear on the marshalled document. |
void |
setSupressXMLDeclaration(boolean supressXMLDeclaration)
Sets whether or not to marshal as a document which includes the XML declaration, and if necessary the DOCTYPE declaration. |
void |
setUseXSITypeAtRoot(boolean useXSITypeAtRoot)
Sets whether or not to output the xsi:type at the root element. |
void |
setValidation(boolean validate)
Sets whether or not to validate the object model before marshalling. |
Methods inherited from class org.exolab.castor.xml.MarshalFramework |
---|
getCollectionHandler, hasFieldsAtLocation, isCollection, isPrimitive, namespaceEquals, primitiveOrWrapperEquals, searchInheritance |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static boolean enableDebug
int depth
Constructor Detail |
---|
public Marshaller(org.xml.sax.DocumentHandler handler)
handler
- the DocumentHandler to "marshal" to.public Marshaller(org.xml.sax.ContentHandler handler) throws java.io.IOException
handler
- the ContentHandler to "marshal" to.
java.io.IOException
public Marshaller(java.io.Writer out) throws java.io.IOException
out
- the Writer to serialize to
java.io.IOException
public Marshaller(org.w3c.dom.Node node)
node
- the DOM node to marshal into.Method Detail |
---|
public void addProcessingInstruction(java.lang.String target, java.lang.String data)
target
- the processing instruction targetdata
- the processing instruction datapublic void setDoctype(java.lang.String publicId, java.lang.String systemId)
publicId
- the public identifiersystemId
- the system identifierpublic void setSupressXMLDeclaration(boolean supressXMLDeclaration)
supressXMLDeclaration
- a boolean that when true
includes that generated XML should not contain
the XML declaration.setMarshalAsDocument(boolean)
public void setMarshalAsDocument(boolean asDocument)
asDocument
- a boolean, when true, indicating to marshal
as a complete XML document.setSupressXMLDeclaration(boolean)
public void setMapping(Mapping mapping) throws MappingException
mapping
- the mapping to using during marshalling
MappingException
public void setMarshalListener(MarshalListener listener)
listener
- the MarshalListener to set.public void setNamespaceMapping(java.lang.String nsPrefix, java.lang.String nsURI)
nsPrefix
- the namespace prefixnsURI
- the namespace that the prefix resolves topublic void setRootElement(java.lang.String rootElement)
The
- name of the root element to usepublic java.lang.String getRootElement()
public void setNSPrefixAtRoot(boolean nsPrefixAtRoot)
nsPrefixAtRoot
- public boolean getNSPrefixAtRoot()
public ClassDescriptorResolver getResolver()
setResolver(org.exolab.castor.xml.ClassDescriptorResolver)
public void setResolver(ClassDescriptorResolver cdr)
cdr
- the ClassDescriptorResolver to usesetMapping(org.exolab.castor.mapping.Mapping)
,
getResolver()
public void setValidation(boolean validate)
validate
- the boolean indicating whether or not to
validate the object model before marshalling.public void setMarshalExtendedType(boolean marshalExtendedType)
public boolean getMarshalExtendedType()
public static void marshal(java.lang.Object object, java.io.Writer out) throws MarshalException, ValidationException
obj
- the Object to marshalout
- the writer to marshal to
MarshalException
ValidationException
public static void marshal(java.lang.Object object, org.xml.sax.DocumentHandler handler) throws MarshalException, ValidationException
obj
- the Object to marshalhandler
- the DocumentHandler to marshal to
MarshalException
ValidationException
public static void marshal(java.lang.Object object, org.xml.sax.ContentHandler handler) throws MarshalException, ValidationException, java.io.IOException
obj
- the Object to marshalhandler
- the ContentHandler to marshal to
MarshalException
ValidationException
java.io.IOException
public static void marshal(java.lang.Object object, org.w3c.dom.Node node) throws MarshalException, ValidationException
obj
- the Object to marshalnode
- the DOM Node to marshal to
MarshalException
ValidationException
public void marshal(java.lang.Object object) throws MarshalException, ValidationException
obj
- the Object to marshal
MarshalException
ValidationException
public void setDebug(boolean debug)
debug
- the flag indicating whether or not debug information
should be generatedpublic void setLogWriter(java.io.PrintWriter printWriter)
printWriter
- the PrintWriter to use for loggingpublic void setEncoding(java.lang.String encoding)
encoding
- the encoding to setpublic void setNoNamespaceSchemaLocation(java.lang.String schemaLocation)
schemaLocation
- the URI location of the schema
to which the marshalled document is an instance of.public void setSchemaLocation(java.lang.String schemaLocation)
schemaLocation
- the URI location of the schema
to which the marshalled document is an instance of.public void setSuppressNamespaces(boolean suppressNamespaces)
suppressNamespaces
- a boolean that when true
will prevent namespaces from being output.public void setSuppressXSIType(boolean suppressXSIType)
suppressXSIType
- a boolean that when true will prevent
xsi:type attribute from being used in the marshalling process.public void setUseXSITypeAtRoot(boolean useXSITypeAtRoot)
useXSITypeAtRoot
- a boolean that when true indicates
that the xsi:type should be output on the root element.
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |