Class Marshaller

Method Details

• setDocumentHandler

  public void setDocumentHandler(DocumentHandler handler)

  Sets the given SAX DocumentHandler to 'marshal' into.

  Parameters:

  handler - the SAX DocumentHandler to "marshal" to.

• setWriter

  public void setWriter(Writer out) throws IOException

  Sets the java.io.Writer to be used during marshalling.

  Parameters:

  out - The writer to use for marshalling

  Throws:

  IOException - If there's a problem accessing the java.io.Writer provided

• setNode

  public void setNode(Node node)

  Sets the W3C Node instance to marshal to.

  Parameters:

  node - the DOM Node to marshal into.

• setInternalContext

  public void setInternalContext(InternalContext internalContext)

  To set the InternalContext to use, and to initialize Marshaller properties linked to it.

  Overrides:

  setInternalContext in class MarshalFramework

  Parameters:

  internalContext - the InternalContext to use

• addProcessingInstruction

  public void addProcessingInstruction(String target, String data)

  Adds the given processing instruction data to the set of processing instructions to output during marshalling.

  Parameters:

  target - the processing instruction target

  data - the processing instruction data

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

  Parameters:

  publicId - the public identifier

  systemId - the system identifier

• setSupressXMLDeclaration

  public void setSupressXMLDeclaration(boolean supressXMLDeclaration)

  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 document including the XML Declaration. If the given boolean is true, the Marshaller will marshal as a well formed XML fragment (no XML declaration or DOCTYPE). This method is basically the same as calling #setMarshalAsDocument(false);

  Parameters:

  supressXMLDeclaration - a boolean that when true includes that generated XML should not contain the XML declaration.

  See Also:

  • setMarshalAsDocument(boolean)

• 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 document including the XML Declaration. If the given boolean is false, the Marshaller will marshal as a well formed XML fragment (no XML declaration or DOCTYPE). This method is basically the same as calling #setSupressXMLDeclaration(true);

  Parameters:

  asDocument - a boolean, when true, indicating to marshal as a complete XML document.

  See Also:

  • setSupressXMLDeclaration(boolean)

• setMapping

  public void setMapping(Mapping mapping) throws MappingException

  Sets the given mapping to be used by the marshalling Framework. If a resolver exists this mapping will be added to the existing ClassDescriptorResolver. Otherwise a new ClassDescriptorResolver will be created.

  Parameters:

  mapping - Mapping to using during marshalling.

  Throws:

  MappingException

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

  Parameters:

  listener - the MarshalListener to set.

• setNamespaceMapping

  public void setNamespaceMapping(String nsPrefix, String nsURI)

  Sets the mapping for the given Namespace prefix.

  Parameters:

  nsPrefix - the namespace prefix

  nsURI - the namespace that the prefix resolves to

• setRootElement

  public void setRootElement(String rootElement)

  Sets the name of the root element to use.

  Parameters:

  rootElement - The name of the root element to use.

• getRootElement

  public String getRootElement()

  Returns the name of the root element to use

  Returns:

  Returns the name of the root element to use

• setNSPrefixAtRoot

  public void setNSPrefixAtRoot(boolean nsPrefixAtRoot)

  Deprecated.

  Set to True to declare the given namespace mappings at the root node. Default is False.

  Parameters:

  nsPrefixAtRoot -

• getNSPrefixAtRoot

  public boolean getNSPrefixAtRoot()

  Deprecated.

  Returns True if the given namespace mappings will be declared at the root node.

  Returns:

  Returns True if the given namespace mappings will be declared at the root node.

• getResolver

  public XMLClassDescriptorResolver getResolver()

  Returns the ClassDescriptorResolver for use during marshalling

  Returns:

  the ClassDescriptorResolver

  See Also:

  • setResolver(org.exolab.castor.xml.XMLClassDescriptorResolver)

• setResolver

  public void setResolver(XMLClassDescriptorResolver cdr)

  Sets the ClassDescriptorResolver to use during marshalling.
  Note: This method will nullify any Mapping currently being used by this Marshaller

  Parameters:

  cdr - the ClassDescriptorResolver to use

  See Also:

  • setMapping(org.exolab.castor.mapping.Mapping)
  • getResolver()

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

  Parameters:

  validate - the boolean indicating whether or not to validate the object model before marshalling.

• getValidation

  public boolean getValidation()

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

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

  Returns:

  If True the marshaller will use the 'xsi:type' attribute to marshall a field value that extended the defined field type. Default is True.

• marshal

  public static void marshal(Object object, Writer out) throws MarshalException, ValidationException

  Marshals the given Object as XML using the given writer.

  Parameters:

  object - The Object to marshal.

  out - The writer to marshal to.

  Throws:

  MarshalException

  ValidationException

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

  Parameters:

  object - The Object to marshal.

  handler - The DocumentHandler to marshal to.

  Throws:

  MarshalException

  ValidationException

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

  Parameters:

  object - The Object to marshal.

  handler - The ContentHandler to marshal to.

  Throws:

  MarshalException

  ValidationException

  IOException

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

  Parameters:

  object - The Object to marshal.

  node - The DOM Node to marshal to.

  Throws:

  MarshalException

  ValidationException

• marshal

  public void marshal(Object object) throws MarshalException, ValidationException

  Marshals the given Object as XML using the DocumentHandler for this Marshaller.

  Parameters:

  object - The Object to marshal.

  Throws:

  MarshalException

  ValidationException

• setLogWriter

  public void setLogWriter(PrintWriter printWriter)

  Sets the PrintWriter used for logging

  Parameters:

  printWriter - the PrintWriter to use for logging

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

  Parameters:

  encoding - the encoding to set

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

  Parameters:

  schemaLocation - the URI location of the schema to which the marshalled document is an instance of.

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

  Parameters:

  schemaLocation - the URI location of the schema to which the marshalled document is an instance of.

• setSuppressNamespaces

  public void setSuppressNamespaces(boolean suppressNamespaces)

  Sets whether or not namespaces are output. By default the Marshaller will output namespace declarations and prefix elements and attributes with their respective namespace prefix. This method can be used to prevent the usage of namespaces.

  Parameters:

  suppressNamespaces - a boolean that when true will prevent namespaces from being output.

• setSuppressXSIType

  public void setSuppressXSIType(boolean suppressXSIType)

  Sets whether or not the xsi:type attribute should appear on the marshalled document.

  Parameters:

  suppressXSIType - a boolean that when true will prevent xsi:type attribute from being used in the marshalling process.

• setUseXSITypeAtRoot

  public void setUseXSITypeAtRoot(boolean useXSITypeAtRoot)

  Sets whether or not to output the xsi:type at the root element. This is usually needed when the root element type cannot be determined by the element name alone. By default xsi:type will not be output on the root element.

  Parameters:

  useXSITypeAtRoot - a boolean that when true indicates that the xsi:type should be output on the root element.

• getProperty

  public String getProperty(String name)

  Returns the value of the given Castor XML-specific property.

  Parameters:

  name - Qualified name of the CASTOR XML-specific property.

  Returns:

  The current value of the given property.

  Since:

  1.1.2

• setProperty

  public void setProperty(String name, String value)

  Sets a custom value of a given Castor XML-specific property.

  Parameters:

  name - Name of the Castor XML property

  value - Custom value to set.

  Since:

  1.1.2

• setContentHandler

  public void setContentHandler(ContentHandler contentHandler)

  To set the SAX ContentHandler which is used as destination at marshalling.

  Parameters:

  contentHandler - the SAX ContentHandler to use as destination at marshalling