Added "entityResolver", "classDescriptorResolver", "doctypes" and further properties to CastorMarshaller

Also deprecated CastorMarshaller's "object" property in favor of "rootObject".

Issue: SPR-8470

spring-oxm/src/main/java/org/springframework/oxm/castor/CastorMarshaller.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2012 the original author or authors.
+ * Copyright 2002-2013 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -30,16 +30,20 @@ import javax.xml.stream.XMLStreamWriter;
 
 import org.exolab.castor.mapping.Mapping;
 import org.exolab.castor.mapping.MappingException;
+import org.exolab.castor.util.ObjectFactory;
+import org.exolab.castor.xml.IDResolver;
 import org.exolab.castor.xml.MarshalException;
 import org.exolab.castor.xml.Marshaller;
 import org.exolab.castor.xml.ResolverException;
 import org.exolab.castor.xml.UnmarshalHandler;
 import org.exolab.castor.xml.Unmarshaller;
 import org.exolab.castor.xml.ValidationException;
+import org.exolab.castor.xml.XMLClassDescriptorResolver;
 import org.exolab.castor.xml.XMLContext;
 import org.exolab.castor.xml.XMLException;
 import org.w3c.dom.Node;
 import org.xml.sax.ContentHandler;
+import org.xml.sax.EntityResolver;
 import org.xml.sax.InputSource;
 import org.xml.sax.SAXException;
 import org.xml.sax.XMLReader;
@@ -56,30 +60,30 @@ import org.springframework.oxm.XmlMappingException;
 import org.springframework.oxm.support.AbstractMarshaller;
 import org.springframework.oxm.support.SaxResourceUtils;
 import org.springframework.util.ObjectUtils;
-import org.springframework.util.StringUtils;
 import org.springframework.util.xml.DomUtils;
 import org.springframework.util.xml.StaxUtils;
 
 /**
- * Implementation of the {@code Marshaller} interface for Castor. By default, Castor does not require any further
+ * Implementation of the {@code Marshaller} interface for Castor. By default, Castor does
- * configuration, though setting target classes, target packages or providing a mapping file can be used to have more
+ * not require any further configuration, though setting target classes, target packages or
- * control over the behavior of Castor.
+ * providing a mapping file can be used to have more control over the behavior of Castor.
  *
- * <p>If a target class is specified using {@code setTargetClass}, the {@code CastorMarshaller} can only be
+ * <p>If a target class is specified using {@code setTargetClass}, the {@code CastorMarshaller}
- * used to unmarshal XML that represents that specific class. If you want to unmarshal multiple classes, you have to
+ * can only be used to unmarshal XML that represents that specific class. If you want to unmarshal
- * provide a mapping file using {@code setMappingLocations}.
+ * multiple classes, you have to provide a mapping file using {@code setMappingLocations}.
  *
- * <p>Due to limitations of Castor's API, it is required to set the encoding used for writing to output streams. It
+ * <p>Due to limitations of Castor's API, it is required to set the encoding used for
- * defaults to {@code UTF-8}.
+ * writing to output streams. It defaults to {@code UTF-8}.
  *
  * @author Arjen Poutsma
  * @author Jakub Narloch
+ * @author Juergen Hoeller
+ * @since 3.0
  * @see #setEncoding(String)
  * @see #setTargetClass(Class)
  * @see #setTargetPackages(String[])
  * @see #setMappingLocation(Resource)
  * @see #setMappingLocations(Resource[])
- * @since 3.0
  */
 public class CastorMarshaller extends AbstractMarshaller implements InitializingBean, BeanClassLoaderAware {
 
@@ -88,6 +92,7 @@ public class CastorMarshaller extends AbstractMarshaller implements Initializing
 	 */
 	public static final String DEFAULT_ENCODING = "UTF-8";
 
+
 	private Resource[] mappingLocations;
 
 	private String encoding = DEFAULT_ENCODING;
@@ -98,47 +103,59 @@ public class CastorMarshaller extends AbstractMarshaller implements Initializing
 
 	private boolean validating = false;
 
-	private boolean whitespacePreserve = false;
-
-	private boolean ignoreExtraAttributes = true;
-
-	private boolean ignoreExtraElements = false;
-
-	private Map<String, String> namespaceMappings;
-
-	private XMLContext xmlContext;
-
 	private boolean suppressNamespaces = false;
 
 	private boolean suppressXsiType = false;
 
 	private boolean marshalAsDocument = true;
 
-	private String rootElement;
-
 	private boolean marshalExtendedType = true;
 
+	private String rootElement;
+
 	private String noNamespaceSchemaLocation;
 
 	private String schemaLocation;
 
 	private boolean useXSITypeAtRoot = false;
 
-	private Map<String, String> processingInstructions;
+	private boolean whitespacePreserve = false;
 
-	private Map<String, String> namespaceToPackageMapping;
+	private boolean ignoreExtraAttributes = true;
 
-	private ClassLoader classLoader;
+	private boolean ignoreExtraElements = false;
 
-	private Object root;
+	private Object rootObject;
 
 	private boolean reuseObjects = false;
 
 	private boolean clearCollections = false;
 
+	private Map<String, String> castorProperties;
+
+	private Map<String, String> doctypes;
+
+	private Map<String, String> processingInstructions;
+
+	private Map<String, String> namespaceMappings;
+
+	private Map<String, String> namespaceToPackageMapping;
+
+	private EntityResolver entityResolver;
+
+	private XMLClassDescriptorResolver classDescriptorResolver;
+
+	private IDResolver idResolver;
+
+	private ObjectFactory objectFactory;
+
+	private ClassLoader beanClassLoader;
+
+	private XMLContext xmlContext;
+
+
 	/**
 	 * Set the encoding to be used for stream access.
-	 *
 	 * @see #DEFAULT_ENCODING
 	 */
 	public void setEncoding(String encoding) {
@@ -146,7 +163,7 @@ public class CastorMarshaller extends AbstractMarshaller implements Initializing
 	}
 
 	/**
-	 * Set the locations of the Castor XML Mapping files.
+	 * Set the locations of the Castor XML mapping files.
 	 */
 	public void setMappingLocation(Resource mappingLocation) {
 		this.mappingLocations = new Resource[]{mappingLocation};
@@ -190,8 +207,8 @@ public class CastorMarshaller extends AbstractMarshaller implements Initializing
 	}
 
 	/**
-	 * Set whether this marshaller should validate in- and outgoing documents. <p>Default is {@code false}.
+	 * Set whether this marshaller should validate in- and outgoing documents.
-	 *
+	 * <p>Default is {@code false}.
 	 * @see Marshaller#setValidation(boolean)
 	 */
 	public void setValidating(boolean validating) {
@@ -199,55 +216,8 @@ public class CastorMarshaller extends AbstractMarshaller implements Initializing
 	}
 
 	/**
-	 * Set whether the Castor {@link Unmarshaller} should preserve "ignorable" whitespace. <p>Default is
+	 * Sets whether this marshaller should output namespaces.
-	 * {@code false}.
+	 * <p>The default is {@code false}, i.e. namespaces are written.
-	 *
-	 * @see org.exolab.castor.xml.Unmarshaller#setWhitespacePreserve(boolean)
-	 */
-	public void setWhitespacePreserve(boolean whitespacePreserve) {
-		this.whitespacePreserve = whitespacePreserve;
-	}
-
-	/**
-	 * Set whether the Castor {@link Unmarshaller} should ignore attributes that do not match a specific field. <p>Default
-	 * is {@code true}: extra attributes are ignored.
-	 *
-	 * @see org.exolab.castor.xml.Unmarshaller#setIgnoreExtraAttributes(boolean)
-	 */
-	public void setIgnoreExtraAttributes(boolean ignoreExtraAttributes) {
-		this.ignoreExtraAttributes = ignoreExtraAttributes;
-	}
-
-	/**
-	 * Set whether the Castor {@link Unmarshaller} should ignore elements that do not match a specific field. <p>Default
-	 * is
-	 * {@code false}, extra attributes are flagged as an error.
-	 *
-	 * @see org.exolab.castor.xml.Unmarshaller#setIgnoreExtraElements(boolean)
-	 */
-	public void setIgnoreExtraElements(boolean ignoreExtraElements) {
-		this.ignoreExtraElements = ignoreExtraElements;
-	}
-
-	/**
-	 * Set the namespace mappings. Property names are interpreted as namespace prefixes; values are namespace URIs.
-	 *
-	 * @see org.exolab.castor.xml.Marshaller#setNamespaceMapping(String, String)
-	 */
-	public void setNamespaceMappings(Map<String, String> namespaceMappings) {
-		this.namespaceMappings = namespaceMappings;
-	}
-
-	/**
-	 * Returns whether this marshaller should output namespaces.
-	 */
-	public boolean isSuppressNamespaces() {
-		return suppressNamespaces;
-	}
-
-	/**
-	 * Sets whether this marshaller should output namespaces. The default is {@code false}, i.e. namespaces are written.
-	 *
 	 * @see org.exolab.castor.xml.Marshaller#setSuppressNamespaces(boolean)
 	 */
 	public void setSuppressNamespaces(boolean suppressNamespaces) {
@@ -255,16 +225,8 @@ public class CastorMarshaller extends AbstractMarshaller implements Initializing
 	}
 
 	/**
-	 * Sets whether this marshaller should output the xsi:type attribute.
+	 * Set whether this marshaller should output the {@code xsi:type} attribute.
-	 */
+	 * <p>The default is {@code false}, i.e. the {@code xsi:type} is written.
-	public boolean isSuppressXsiType() {
-		return suppressXsiType;
-	}
-
-	/**
-	 * Sets whether this marshaller should output the {@code xsi:type} attribute. The default is {@code false}, i.e. the
-	 * {@code xsi:type} is written.
-	 *
 	 * @see org.exolab.castor.xml.Marshaller#setSuppressXSIType(boolean)
 	 */
 	public void setSuppressXsiType(boolean suppressXsiType) {
@@ -272,9 +234,8 @@ public class CastorMarshaller extends AbstractMarshaller implements Initializing
 	}
 
 	/**
-	 * Sets whether this marshaller should output the xml declaration. </p> The default is {@code true}, the xml
+	 * Set whether this marshaller should output the xml declaration.
-	 * declaration will be written.
+	 * <p>The default is {@code true}, the XML declaration will be written.
-	 *
 	 * @see org.exolab.castor.xml.Marshaller#setMarshalAsDocument(boolean)
 	 */
 	public void setMarshalAsDocument(boolean marshalAsDocument) {
@@ -282,18 +243,8 @@ public class CastorMarshaller extends AbstractMarshaller implements Initializing
 	}
 
 	/**
-	 * Sets the name of the root element.
+	 * Set whether this marshaller should output for given type the {@code xsi:type} attribute.
-	 *
+	 * <p>The default is {@code true}, the {@code xsi:type} attribute will be written.
-	 * @see org.exolab.castor.xml.Marshaller#setRootElement(String)
-	 */
-	public void setRootElement(String rootElement) {
-		this.rootElement = rootElement;
-	}
-
-	/**
-	 * Sets whether this marshaller should output for given type the {@code xsi:type} attribute.</p> The default is {@code
-	 * true}, the {@code xsi:type} attribute will be written.
-	 *
 	 * @see org.exolab.castor.xml.Marshaller#setMarshalExtendedType(boolean)
 	 */
 	public void setMarshalExtendedType(boolean marshalExtendedType) {
@@ -301,9 +252,16 @@ public class CastorMarshaller extends AbstractMarshaller implements Initializing
 	}
 
 	/**
-	 * Sets the value of {@code xsi:noNamespaceSchemaLocation} attribute. When set, the {@code
+	 * Set the name of the root element.
-	 * xsi:noNamespaceSchemaLocation} attribute will be written for the root element.
+	 * @see org.exolab.castor.xml.Marshaller#setRootElement(String)
-	 *
+	 */
+	public void setRootElement(String rootElement) {
+		this.rootElement = rootElement;
+	}
+
+	/**
+	 * Set the value of {@code xsi:noNamespaceSchemaLocation} attribute. When set, the
+	 * {@code xsi:noNamespaceSchemaLocation} attribute will be written for the root element.
 	 * @see org.exolab.castor.xml.Marshaller#setNoNamespaceSchemaLocation(String)
 	 */
 	public void setNoNamespaceSchemaLocation(String noNamespaceSchemaLocation) {
@@ -311,9 +269,8 @@ public class CastorMarshaller extends AbstractMarshaller implements Initializing
 	}
 
 	/**
-	 * Sets the value of {@code xsi:schemaLocation} attribute.When set, the {@code xsi:schemaLocation} attribute will be
+	 * Set the value of {@code xsi:schemaLocation} attribute. When set, the
-	 * written for the root element.
+	 * {@code xsi:schemaLocation} attribute will be written for the root element.
-	 *
 	 * @see org.exolab.castor.xml.Marshaller#setSchemaLocation(String)
 	 */
 	public void setSchemaLocation(String schemaLocation) {
@@ -321,10 +278,9 @@ public class CastorMarshaller extends AbstractMarshaller implements Initializing
 	}
 
 	/**
-	 * Sets whether this marshaller should output the {@code xsi:type} attribute for the root element. This can be useful
+	 * Sets whether this marshaller should output the {@code xsi:type} attribute for the root element.
-	 * when the type of the element can not be simply determined from the element name. </p> The default is {@code false},
+	 * This can be useful when the type of the element can not be simply determined from the element name.
-	 * the {@code xsi:type} attribute for the root element won't be written.
+	 * <p>The default is {@code false}: The {@code xsi:type} attribute for the root element won't be written.
-	 *
 	 * @see org.exolab.castor.xml.Marshaller#setUseXSITypeAtRoot(boolean)
 	 */
 	public void setUseXSITypeAtRoot(boolean useXSITypeAtRoot) {
@@ -332,38 +288,54 @@ public class CastorMarshaller extends AbstractMarshaller implements Initializing
 	}
 
 	/**
-	 * Sets the processing instructions that will be used by during marshalling. Keys are the processing targets and
+	 * Set whether the Castor {@link Unmarshaller} should preserve "ignorable" whitespace.
-	 * values
+	 * <p>Default is {@code false}.
-	 * contain the processing data.
+	 * @see org.exolab.castor.xml.Unmarshaller#setWhitespacePreserve(boolean)
-	 *
-	 * @see org.exolab.castor.xml.Marshaller#addProcessingInstruction(String, String)
 	 */
-	public void setProcessingInstructions(Map<String, String> processingInstructions) {
+	public void setWhitespacePreserve(boolean whitespacePreserve) {
-		this.processingInstructions = processingInstructions;
+		this.whitespacePreserve = whitespacePreserve;
 	}
 
 	/**
-	 * Set the namespace to package mappings. Property names are represents the namespaces URI, values are packages.
+	 * Set whether the Castor {@link Unmarshaller} should ignore attributes that do not match a specific field.
-	 *
+	 * <p>Default is {@code true}: Extra attributes are ignored.
-	 * @see org.exolab.castor.xml.Marshaller#setNamespaceMapping(String, String)
+	 * @see org.exolab.castor.xml.Unmarshaller#setIgnoreExtraAttributes(boolean)
 	 */
-	public void setNamespaceToPackageMapping(Map<String, String> namespaceToPackageMapping) {
+	public void setIgnoreExtraAttributes(boolean ignoreExtraAttributes) {
-		this.namespaceToPackageMapping = namespaceToPackageMapping;
+		this.ignoreExtraAttributes = ignoreExtraAttributes;
 	}
 
 	/**
-	 * Sets the expected object for the unmarshaller, into which the source will be unmarshalled.
+	 * Set whether the Castor {@link Unmarshaller} should ignore elements that do not match a specific field.
-	 *
+	 * <p>Default is {@code false}: Extra elements are flagged as an error.
+	 * @see org.exolab.castor.xml.Unmarshaller#setIgnoreExtraElements(boolean)
+	 */
+	public void setIgnoreExtraElements(boolean ignoreExtraElements) {
+		this.ignoreExtraElements = ignoreExtraElements;
+	}
+
+	/**
+	 * Set the expected root object for the unmarshaller, into which the source will be unmarshalled.
+	 * @see org.exolab.castor.xml.Unmarshaller#setObject(Object)
+	 * @deprecated in favor of {@link #setRootObject}
+	 */
+	@Deprecated
+	public void setObject(Object root) {
+		this.rootObject = root;
+	}
+
+	/**
+	 * Set the expected root object for the unmarshaller, into which the source will be unmarshalled.
 	 * @see org.exolab.castor.xml.Unmarshaller#setObject(Object)
 	 */
-	public void setObject(Object root) {
+	public void setRootObject(Object root) {
-		this.root = root;
+		this.rootObject = root;
 	}
 
 	/**
-	 * Sets whether this unmarshaller should re-use objects. This will be only used when unmarshalling to existing
+	 * Set whether this unmarshaller should re-use objects.
-	 * object. </p> The default is {@code false}, which means that the objects won't be re-used.
+	 * This will be only used when unmarshalling to an existing object.
-	 *
+	 * <p>The default is {@code false}, which means that the objects won't be re-used.
 	 * @see org.exolab.castor.xml.Unmarshaller#setReuseObjects(boolean)
 	 */
 	public void setReuseObjects(boolean reuseObjects) {
@@ -371,39 +343,99 @@ public class CastorMarshaller extends AbstractMarshaller implements Initializing
 	}
 
 	/**
-	 * Sets whether this unmarshaller should clear collections upon the first use. </p> The default is {@code false},
+	 * Sets whether this unmarshaller should clear collections upon the first use.
-	 * which means that marshaller won't clear collections.
+	 * <p>The default is {@code false} which means that marshaller won't clear collections.
-	 *
 	 * @see org.exolab.castor.xml.Unmarshaller#setClearCollections(boolean)
 	 */
 	public void setClearCollections(boolean clearCollections) {
 		this.clearCollections = clearCollections;
 	}
 
-	public void setBeanClassLoader(ClassLoader classLoader) {
+	/**
-		this.classLoader = classLoader;
+	 * Set Castor-specific properties for marshalling and unmarshalling.
+	 * Each entry key is considered the property name and each value the property value.
+	 * @see org.exolab.castor.xml.Marshaller#setProperty(String, String)
+	 * @see org.exolab.castor.xml.Unmarshaller#setProperty(String, String)
+	 */
+	public void setCastorProperties(Map<String, String> castorProperties) {
+		this.castorProperties = castorProperties;
 	}
 
-	public final void afterPropertiesSet() throws CastorMappingException, IOException {
+	/**
-		if (logger.isInfoEnabled()) {
+	 * Set the map containing document type definition for the marshaller.
-			if (!ObjectUtils.isEmpty(this.mappingLocations)) {
+	 * Each entry has system id as key and public id as value.
-				logger.info(
+	 * @see org.exolab.castor.xml.Marshaller#setDoctype(String, String)
-						"Configured using [" + StringUtils.arrayToCommaDelimitedString(this.mappingLocations) + "]");
+	 */
-			}
+	public void setDoctypes(Map<String, String> doctypes) {
-			if (!ObjectUtils.isEmpty(this.targetClasses)) {
+		this.doctypes = doctypes;
-				logger.info("Configured for target classes " + StringUtils.arrayToCommaDelimitedString(targetClasses) +
+	}
-						"]");
+
-			}
+	/**
-			if (!ObjectUtils.isEmpty(this.targetPackages)) {
+	 * Sets the processing instructions that will be used by during marshalling.
-				logger.info(
+	 * Keys are the processing targets and values contain the processing data.
-						"Configured for target packages [" + StringUtils.arrayToCommaDelimitedString(targetPackages) +
+	 * @see org.exolab.castor.xml.Marshaller#addProcessingInstruction(String, String)
-								"]");
+	 */
-			}
+	public void setProcessingInstructions(Map<String, String> processingInstructions) {
-			if (ObjectUtils.isEmpty(this.mappingLocations) && ObjectUtils.isEmpty(this.targetClasses) &&
+		this.processingInstructions = processingInstructions;
-					ObjectUtils.isEmpty(this.targetPackages)) {
+	}
-				logger.info("Using default configuration");
+
-			}
+	/**
-		}
+	 * Set the namespace mappings.
+	 * Property names are interpreted as namespace prefixes; values are namespace URIs.
+	 * @see org.exolab.castor.xml.Marshaller#setNamespaceMapping(String, String)
+	 */
+	public void setNamespaceMappings(Map<String, String> namespaceMappings) {
+		this.namespaceMappings = namespaceMappings;
+	}
+
+	/**
+	 * Set the namespace to package mappings. Property names are represents the namespaces URI, values are packages.
+	 * @see org.exolab.castor.xml.Marshaller#setNamespaceMapping(String, String)
+	 */
+	public void setNamespaceToPackageMapping(Map<String, String> namespaceToPackageMapping) {
+		this.namespaceToPackageMapping = namespaceToPackageMapping;
+	}
+
+	/**
+	 * Set the {@link EntityResolver} to be used during unmarshalling.
+	 * This resolver will used to resolve system and public ids.
+	 * @see org.exolab.castor.xml.Unmarshaller#setEntityResolver(EntityResolver)
+	 */
+	public void setEntityResolver(EntityResolver entityResolver) {
+		this.entityResolver = entityResolver;
+	}
+
+	/**
+	 * Set the {@link XMLClassDescriptorResolver} to be used during unmarshalling.
+	 * This resolver will used to resolve class descriptors.
+	 * @see org.exolab.castor.xml.Unmarshaller#setResolver(XMLClassDescriptorResolver)
+	 */
+	public void setClassDescriptorResolver(XMLClassDescriptorResolver classDescriptorResolver) {
+		this.classDescriptorResolver = classDescriptorResolver;
+	}
+
+	/**
+	 * Set the Castor {@link IDResolver} to be used during unmarshalling.
+	 * @see org.exolab.castor.xml.Unmarshaller#setIDResolver(IDResolver)
+	 */
+	public void setIdResolver(IDResolver idResolver) {
+		this.idResolver = idResolver;
+	}
+
+	/**
+	 * Set the Castor {@link ObjectFactory} to be used during unmarshalling.
+	 * @see org.exolab.castor.xml.Unmarshaller#setObjectFactory(ObjectFactory)
+	 */
+	public void setObjectFactory(ObjectFactory objectFactory) {
+		this.objectFactory = objectFactory;
+	}
+
+	public void setBeanClassLoader(ClassLoader classLoader) {
+		this.beanClassLoader = classLoader;
+	}
+
+
+	public void afterPropertiesSet() throws CastorMappingException, IOException {
 		try {
 			this.xmlContext = createXMLContext(this.mappingLocations, this.targetClasses, this.targetPackages);
 		}
@@ -416,9 +448,8 @@ public class CastorMarshaller extends AbstractMarshaller implements Initializing
 	}
 
 	/**
-	 * Create the Castor {@code XMLContext}. Subclasses can override this to create a custom context. <p> The default
+	 * Create the Castor {@code XMLContext}. Subclasses can override this to create a custom context.
-	 * implementation loads mapping files if defined, or the target class or packages if defined.
+	 * <p>The default implementation loads mapping files if defined, or the target class or packages if defined.
-	 *
 	 * @return the created resolver
 	 * @throws MappingException when the mapping file cannot be loaded
 	 * @throws IOException in case of I/O errors
@@ -442,9 +473,15 @@ public class CastorMarshaller extends AbstractMarshaller implements Initializing
 		if (!ObjectUtils.isEmpty(targetPackages)) {
 			context.addPackages(targetPackages);
 		}
+		if (this.castorProperties != null) {
+			for (Map.Entry<String, String> property : this.castorProperties.entrySet()) {
+				context.setProperty(property.getKey(), property.getValue());
+			}
+		}
 		return context;
 	}
 
+
 	/**
 	 * Returns {@code true} for all classes, i.e. Castor supports arbitrary classes.
 	 */
@@ -462,6 +499,7 @@ public class CastorMarshaller extends AbstractMarshaller implements Initializing
 	@Override
 	protected final void marshalSaxHandlers(Object graph, ContentHandler contentHandler, LexicalHandler lexicalHandler)
 			throws XmlMappingException {
+
 		Marshaller marshaller = xmlContext.createMarshaller();
 		marshaller.setContentHandler(contentHandler);
 		marshal(graph, marshaller);
@@ -470,6 +508,7 @@ public class CastorMarshaller extends AbstractMarshaller implements Initializing
 	@Override
 	protected final void marshalOutputStream(Object graph, OutputStream outputStream)
 			throws XmlMappingException, IOException {
+
 		marshalWriter(graph, new OutputStreamWriter(outputStream, encoding));
 	}
 
@@ -502,42 +541,29 @@ public class CastorMarshaller extends AbstractMarshaller implements Initializing
 
 	/**
 	 * Template method that allows for customizing of the given Castor {@link Marshaller}.
-	 *
-	 * </p>The default implementation invokes
-	 * <ol>
-	 * <li>{@link Marshaller#setValidation(boolean)},</li>
-	 * <li>{@link Marshaller#setSuppressNamespaces(boolean)},</li>
-	 * <li>{@link Marshaller#setSuppressXSIType(boolean)}, </li>
-	 * <li>{@link Marshaller#setMarshalAsDocument(boolean)}, </li>
-	 * <li>{@link Marshaller#setRootElement(String)},</li>
-	 * <li>{@link Marshaller#setMarshalExtendedType(boolean)},</li>
-	 * <li>{@link Marshaller#setNoNamespaceSchemaLocation(String)},</li>
-	 * <li>{@link Marshaller#setSchemaLocation(String)} and</li>
-	 * <li>{@link Marshaller#setUseXSITypeAtRoot(boolean)}.</li>
-	 * </ol>
-	 * with the property set on this marshaller.
-	 * It also calls {@link Marshaller#setNamespaceMapping(String, String)}
-	 * with the {@linkplain #setNamespaceMappings(java.util.Map) namespace mappings} and
-	 * {@link Marshaller#addProcessingInstruction(String, String)} with the
-	 * {@linkplain #setProcessingInstructions(java.util.Map) processing instructions}.
 	 */
 	protected void customizeMarshaller(Marshaller marshaller) {
 		marshaller.setValidation(this.validating);
-		marshaller.setSuppressNamespaces(isSuppressNamespaces());
+		marshaller.setSuppressNamespaces(this.suppressNamespaces);
-		marshaller.setSuppressXSIType(isSuppressXsiType());
+		marshaller.setSuppressXSIType(this.suppressXsiType);
-		marshaller.setMarshalAsDocument(marshalAsDocument);
+		marshaller.setMarshalAsDocument(this.marshalAsDocument);
-		marshaller.setRootElement(rootElement);
+		marshaller.setMarshalExtendedType(this.marshalExtendedType);
-		marshaller.setMarshalExtendedType(marshalExtendedType);
+		marshaller.setRootElement(this.rootElement);
-		marshaller.setNoNamespaceSchemaLocation(noNamespaceSchemaLocation);
+		marshaller.setNoNamespaceSchemaLocation(this.noNamespaceSchemaLocation);
-		marshaller.setSchemaLocation(schemaLocation);
+		marshaller.setSchemaLocation(this.schemaLocation);
-		marshaller.setUseXSITypeAtRoot(useXSITypeAtRoot);
+		marshaller.setUseXSITypeAtRoot(this.useXSITypeAtRoot);
-		if (processingInstructions != null) {
+		if (this.doctypes != null) {
-			for (Map.Entry<String, String> processingInstruction : processingInstructions.entrySet()) {
+			for (Map.Entry<String, String> doctype : this.doctypes.entrySet()) {
+				marshaller.setDoctype(doctype.getKey(), doctype.getValue());
+			}
+		}
+		if (this.processingInstructions != null) {
+			for (Map.Entry<String, String> processingInstruction : this.processingInstructions.entrySet()) {
 				marshaller.addProcessingInstruction(processingInstruction.getKey(), processingInstruction.getValue());
 			}
 		}
 		if (this.namespaceMappings != null) {
-			for (Map.Entry<String, String> entry : namespaceMappings.entrySet()) {
+			for (Map.Entry<String, String> entry : this.namespaceMappings.entrySet()) {
 				marshaller.setNamespaceMapping(entry.getKey(), entry.getValue());
 			}
 		}
@@ -619,48 +645,45 @@ public class CastorMarshaller extends AbstractMarshaller implements Initializing
 
 	/**
 	 * Template method that allows for customizing of the given Castor {@link Unmarshaller}.
-	 *
-	 * </p> The default implementation invokes
-	 * <ol>
-	 * <li>{@link Unmarshaller#setValidation(boolean)},
-	 * <li>{@link Unmarshaller#setWhitespacePreserve(boolean)},
-	 * <li>{@link Unmarshaller#setIgnoreExtraAttributes(boolean)},
-	 * <li>{@link Unmarshaller#setIgnoreExtraElements(boolean)},
-	 * <li>{@link Unmarshaller#setClassLoader(ClassLoader)},
-	 * <li>{@link Unmarshaller#setObject(Object)},
-	 * <li>{@link Unmarshaller#setReuseObjects(boolean)} and
-	 * <li>{@link Unmarshaller#setClearCollections(boolean)}
-	 * </ol>
-	 * with the properties set on this marshaller.
-	 * It also calls {@link Unmarshaller#addNamespaceToPackageMapping(String, String)} with the
-	 * {@linkplain #setNamespaceMappings(java.util.Map) namespace to package mapping}.
 	 */
 	protected void customizeUnmarshaller(Unmarshaller unmarshaller) {
 		unmarshaller.setValidation(this.validating);
 		unmarshaller.setWhitespacePreserve(this.whitespacePreserve);
 		unmarshaller.setIgnoreExtraAttributes(this.ignoreExtraAttributes);
 		unmarshaller.setIgnoreExtraElements(this.ignoreExtraElements);
-		unmarshaller.setClassLoader(classLoader);
+		unmarshaller.setObject(this.rootObject);
-		unmarshaller.setObject(root);
+		unmarshaller.setReuseObjects(this.reuseObjects);
-		unmarshaller.setReuseObjects(reuseObjects);
+		unmarshaller.setClearCollections(this.clearCollections);
-		unmarshaller.setClearCollections(clearCollections);
+		if (this.namespaceToPackageMapping != null) {
-		if (namespaceToPackageMapping != null) {
+			for (Map.Entry<String, String> mapping : this.namespaceToPackageMapping.entrySet()) {
-			for (Map.Entry<String, String> mapping : namespaceToPackageMapping.entrySet()) {
 				unmarshaller.addNamespaceToPackageMapping(mapping.getKey(), mapping.getValue());
 			}
 		}
-
+		if (this.entityResolver != null) {
+			unmarshaller.setEntityResolver(this.entityResolver);
+		}
+		if (this.classDescriptorResolver != null) {
+			unmarshaller.setResolver(this.classDescriptorResolver);
+		}
+		if (this.idResolver != null) {
+			unmarshaller.setIDResolver(this.idResolver);
+		}
+		if (this.objectFactory != null) {
+			unmarshaller.setObjectFactory(this.objectFactory);
+		}
+		if (this.beanClassLoader != null) {
+			unmarshaller.setClassLoader(this.beanClassLoader);
+		}
 	}
 
 	/**
 	 * Convert the given {@code XMLException} to an appropriate exception from the
-	 * {@code org.springframework.oxm} hierarchy. <p> A boolean flag is used to indicate whether this exception
+	 * {@code org.springframework.oxm} hierarchy.
-	 * occurs
+	 * <p>A boolean flag is used to indicate whether this exception occurs during marshalling or
-	 * during marshalling or unmarshalling, since Castor itself does not make this distinction in its exception hierarchy.
+	 * unmarshalling, since Castor itself does not make this distinction in its exception hierarchy.
-	 *
 	 * @param ex Castor {@code XMLException} that occurred
-	 * @param marshalling indicates whether the exception occurs during marshalling ({@code true}), or unmarshalling
+	 * @param marshalling indicates whether the exception occurs during marshalling ({@code true}),
-	 * ({@code false})
+	 * or unmarshalling ({@code false})
 	 * @return the corresponding {@code XmlMappingException}
 	 */
 	protected XmlMappingException convertCastorException(XMLException ex, boolean marshalling) {

spring-oxm/src/test/java/org/springframework/oxm/castor/CastorUnmarshallerTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2012 the original author or authors.
+ * Copyright 2002-2013 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -30,12 +30,9 @@ import org.springframework.oxm.MarshallingException;
 import org.springframework.oxm.Unmarshaller;
 
 import static org.hamcrest.CoreMatchers.*;
-
 import static org.junit.Assert.*;
 
 /**
- * Tests the {@link CastorMarshaller} class.
- *
  * @author Arjen Poutsma
  * @author Jakub Narloch
  */
@@ -114,7 +111,6 @@ public class CastorUnmarshallerTests extends AbstractUnmarshallerTests {
 
 	@Test
 	public void testWhitespacePreserveTrue() throws Exception {
-
 		getCastorUnmarshaller().setWhitespacePreserve(true);
 		Object result = unmarshalFlights();
 		testFlights(result);
@@ -122,7 +118,6 @@ public class CastorUnmarshallerTests extends AbstractUnmarshallerTests {
 
 	@Test
 	public void testWhitespacePreserveFalse() throws Exception {
-
 		getCastorUnmarshaller().setWhitespacePreserve(false);
 		Object result = unmarshalFlights();
 		testFlights(result);
@@ -130,7 +125,6 @@ public class CastorUnmarshallerTests extends AbstractUnmarshallerTests {
 
 	@Test
 	public void testIgnoreExtraAttributesTrue() throws Exception {
-
 		getCastorUnmarshaller().setIgnoreExtraAttributes(true);
 		Object result = unmarshal(EXTRA_ATTRIBUTES_STRING);
 		testFlights(result);
@@ -146,7 +140,6 @@ public class CastorUnmarshallerTests extends AbstractUnmarshallerTests {
 	@Test
 	@Ignore("Not working yet")
 	public void testIgnoreExtraElementsTrue() throws Exception {
-
 		getCastorUnmarshaller().setIgnoreExtraElements(true);
 		getCastorUnmarshaller().setValidating(false);
 		Object result = unmarshal(EXTRA_ELEMENTS_STRING);
@@ -161,22 +154,19 @@ public class CastorUnmarshallerTests extends AbstractUnmarshallerTests {
 	}
 
 	@Test
-	public void testObject() throws Exception {
+	public void testRootObject() throws Exception {
-
 		Flights flights = new Flights();
-		getCastorUnmarshaller().setObject(flights);
+		getCastorUnmarshaller().setRootObject(flights);
 		Object result = unmarshalFlights();
-
 		testFlights(result);
 		assertSame("Result Flights is different object.", flights, result);
 	}
 
 	@Test
 	public void testClearCollectionsTrue() throws Exception {
-
 		Flights flights = new Flights();
 		flights.setFlight(new Flight[]{new Flight()});
-		getCastorUnmarshaller().setObject(flights);
+		getCastorUnmarshaller().setRootObject(flights);
 		getCastorUnmarshaller().setClearCollections(true);
 		Object result = unmarshalFlights();
 
@@ -188,10 +178,9 @@ public class CastorUnmarshallerTests extends AbstractUnmarshallerTests {
 	@Test
 	@Ignore("Fails on the builder server for some reason")
 	public void testClearCollectionsFalse() throws Exception {
-
 		Flights flights = new Flights();
 		flights.setFlight(new Flight[]{new Flight(), null});
-		getCastorUnmarshaller().setObject(flights);
+		getCastorUnmarshaller().setRootObject(flights);
 		getCastorUnmarshaller().setClearCollections(false);
 		Object result = unmarshalFlights();