CastorMarshaller

<init>

Implementation of the Marshaller interface for Castor. By default, Castor does not require any further configuration, though setting target classes, target packages or providing a mapping file can be used to have more control over the behavior of Castor.

If a target class is specified using setTargetClass, the CastorMarshaller can only be used to unmarshal XML that represents that specific class. If you want to unmarshal multiple classes, you have to provide a mapping file using setMappingLocations.

Due to limitations of Castor's API, it is required to set the encoding used for writing to output streams. It defaults to UTF-8.

DEFAULT_ENCODING

The default encoding used for stream access: UTF-8.

afterPropertiesSet

setBeanClassLoader

setCastorProperties

Set Castor-specific properties for marshalling and unmarshalling. Each entry key is considered the property name and each value the property value.

setClassDescriptorResolver

Set the XMLClassDescriptorResolver to be used during unmarshalling. This resolver will used to resolve class descriptors.

setClearCollections

Sets whether this unmarshaller should clear collections upon the first use.

The default is false which means that marshaller won't clear collections.

setDoctypes

Set the map containing document type definition for the marshaller. Each entry has system id as key and public id as value.

setEncoding

Set the encoding to be used for stream access.

setEntityResolver

Set the EntityResolver to be used during unmarshalling. This resolver will used to resolve system and public ids.

setIdResolver

Set the Castor IDResolver to be used during unmarshalling.

setIgnoreExtraAttributes

Set whether the Castor Unmarshaller should ignore attributes that do not match a specific field.

Default is true: Extra attributes are ignored.

setIgnoreExtraElements

Set whether the Castor Unmarshaller should ignore elements that do not match a specific field.

Default is false: Extra elements are flagged as an error.

setMappingLocation

Set the locations of the Castor XML mapping files.

setMappingLocations

Set the locations of the Castor XML mapping files.

setMarshalAsDocument

Set whether this marshaller should output the xml declaration.

The default is true, the XML declaration will be written.

setMarshalExtendedType

Set whether this marshaller should output for given type the xsi:type attribute.

The default is true, the xsi:type attribute will be written.

setNamespaceMappings

Set the namespace mappings. Property names are interpreted as namespace prefixes; values are namespace URIs.

setNamespaceToPackageMapping

Set the namespace to package mappings. Property names are represents the namespaces URI, values are packages.

setNoNamespaceSchemaLocation

Set the value of xsi:noNamespaceSchemaLocation attribute. When set, the xsi:noNamespaceSchemaLocation attribute will be written for the root element.

setObjectFactory

Set the Castor ObjectFactory to be used during unmarshalling.

setProcessingInstructions

Sets the processing instructions that will be used by during marshalling. Keys are the processing targets and values contain the processing data.

setReuseObjects

Set whether this unmarshaller should re-use objects. This will be only used when unmarshalling to an existing object.

The default is false, which means that the objects won't be re-used.

setRootElement

Set the name of the root element.

setRootObject

Set the expected root object for the unmarshaller, into which the source will be unmarshalled.

setSchemaLocation

Set the value of xsi:schemaLocation attribute. When set, the xsi:schemaLocation attribute will be written for the root element.

setSuppressNamespaces

Sets whether this marshaller should output namespaces.

The default is false, i.e. namespaces are written.

setSuppressXsiType

Set whether this marshaller should output the xsi:type attribute.

The default is false, i.e. the xsi:type is written.

setTargetClass

Set the Castor target class.

setTargetClasses

Set the Castor target classes.

setTargetPackage

Set the name of a package with the Castor descriptor classes.

setTargetPackages

Set the names of packages with the Castor descriptor classes.

setUseXSITypeAtRoot

Sets whether this marshaller should output the xsi:type attribute for the root element. This can be useful when the type of the element can not be simply determined from the element name.

The default is false: The xsi:type attribute for the root element won't be written.

setValidating

Set whether this marshaller should validate in- and outgoing documents.

Default is false.

setWhitespacePreserve

Set whether the Castor Unmarshaller should preserve "ignorable" whitespace.

Default is false.

supports

Returns true for all classes, i.e. Castor supports arbitrary classes.

isProcessExternalEntities

Returns the configured value for whether XML external entities are allowed.

isSupportDtd

Whether DTD parsing is supported.

marshal

Marshals the object graph with the given root into the provided javax.xml.transform.Result.

This implementation inspects the given result, and calls marshalDomResult, marshalSaxResult, or marshalStreamResult.

setProcessExternalEntities

Indicates whether external XML entities are processed when unmarshalling.

Default is false, meaning that external entities are not resolved. Note that processing of external entities will only be enabled/disabled when the Source passed to #unmarshal(Source) is a SAXSource or StreamSource. It has no effect for DOMSource or StAXSource instances.

Note: setting this option to true also automatically sets #setSupportDtd to true.

setSupportDtd

Indicates whether DTD parsing should be supported.

Default is false meaning that DTD is disabled.

unmarshal

Unmarshals the given provided javax.xml.transform.Source into an object graph.

This implementation inspects the given result, and calls unmarshalDomSource, unmarshalSaxSource, or unmarshalStreamSource.