XStreamMarshaller

java.lang.Object
- org.springframework.oxm.support.AbstractMarshaller
- - org.springframework.oxm.xstream.XStreamMarshaller

All Implemented Interfaces:

Aware, BeanClassLoaderAware, InitializingBean, Marshaller, Unmarshaller
```
public class XStreamMarshaller
extends AbstractMarshaller
implements InitializingBean, BeanClassLoaderAware
```
Implementation of the Marshaller interface for XStream.
By default, XStream does not require any further configuration and can (un)marshal any class on the classpath. As such, it is not recommended to use the XStreamMarshaller to unmarshal XML from external sources (i.e. the Web), as this can result in security vulnerabilities. If you do use the XStreamMarshaller to unmarshal external XML, set the supportedClasses and converters properties (possibly using a CatchAllConverter) or override the customizeXStream(XStream) method to make sure it only accepts the classes you want it to support.
Due to XStream's API, it is required to set the encoding used for writing to OutputStreams. It defaults to UTF-8.
NOTE: XStream is an XML serialization library, not a data binding library. Therefore, it has limited namespace support. As such, it is rather unsuitable for usage within Web Services.
This marshaller requires XStream 1.4 or higher, as of Spring 4.0. Note that XStream construction has been reworked in 4.0, with the stream driver and the class loader getting passed into XStream itself now.

Since:

3.0

Author:

Peter Meijer, Arjen Poutsma, Juergen Hoeller

Field Summary

Fields
Modifier and Type	Field and Description
`private java.util.Map<java.lang.String,?>`	`aliases`
`private java.util.Map<java.lang.String,?>`	`aliasesByType`
`private java.lang.Class<?>[]`	`annotatedClasses`
`private boolean`	`autodetectAnnotations`
`private java.lang.ClassLoader`	`beanClassLoader`
`private ConverterLookup`	`converterLookup`
`private ConverterRegistry`	`converterRegistry`
`private ConverterMatcher[]`	`converters`
`static java.lang.String`	`DEFAULT_ENCODING` The default encoding used for stream access: UTF-8.
`private HierarchicalStreamDriver`	`defaultDriver`
`private java.lang.String`	`encoding`
`private java.util.Map<java.lang.String,java.lang.String>`	`fieldAliases`
`private java.util.Map<java.lang.Class<?>,java.lang.String>`	`implicitCollections`
`private Mapper`	`mapper`
`private java.lang.Class<?>[]`	`mapperWrappers`
`private MarshallingStrategy`	`marshallingStrategy`
`private java.lang.Integer`	`mode`
`private NameCoder`	`nameCoder`
`private java.util.Map<java.lang.Class<?>,java.lang.String>`	`omittedFields`
`private ReflectionProvider`	`reflectionProvider`
`private HierarchicalStreamDriver`	`streamDriver`
`private java.lang.Class<?>[]`	`supportedClasses`
`private java.util.Map<?,?>`	`useAttributeFor`
`private java.lang.Class<?>[]`	`useAttributeForTypes`
`private XStream`	`xstream`

Fields inherited from class org.springframework.oxm.support.AbstractMarshaller
logger

Constructor Summary

Constructors
Constructor and Description

XStreamMarshaller()

Constructors
Constructor and Description
`XStreamMarshaller()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`afterPropertiesSet()` Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).
`protected XStream`	`buildXStream()` Build the native XStream delegate to be used by this marshaller, delegating to `constructXStream()`, `configureXStream(XStream)` and `customizeXStream(XStream)`.
`protected void`	`configureXStream(XStream xstream)` Configure the XStream instance with this marshaller's bean properties.
`protected XStream`	`constructXStream()` Construct an XStream instance, either using one of the standard constructors or creating a custom subclass.
`protected XmlMappingException`	`convertXStreamException(java.lang.Exception ex, boolean marshalling)` Convert the given XStream exception to an appropriate exception from the `org.springframework.oxm` hierarchy.
`protected void`	`customizeXStream(XStream xstream)` Template to allow for customizing the given `XStream`.
`private void`	`doMarshal(java.lang.Object graph, HierarchicalStreamWriter streamWriter, DataHolder dataHolder)` Marshals the given graph to the given XStream HierarchicalStreamWriter.
`private java.lang.Object`	`doUnmarshal(HierarchicalStreamReader streamReader, DataHolder dataHolder)` Unmarshals the given graph to the given XStream HierarchicalStreamWriter.
`private HierarchicalStreamDriver`	`getDefaultDriver()`
`protected java.lang.String`	`getDefaultEncoding()` Determine the default encoding to use for marshalling or unmarshalling from a byte stream, or `null` if none.
`XStream`	`getXStream()` Return the native XStream delegate used by this marshaller.
`protected void`	`marshalDomNode(java.lang.Object graph, org.w3c.dom.Node node)` Abstract template method for marshalling the given object graph to a DOM `Node`.
`void`	`marshalOutputStream(java.lang.Object graph, java.io.OutputStream outputStream)` Abstract template method for marshalling the given object graph to a `OutputStream`.
`void`	`marshalOutputStream(java.lang.Object graph, java.io.OutputStream outputStream, DataHolder dataHolder)`
`protected void`	`marshalSaxHandlers(java.lang.Object graph, org.xml.sax.ContentHandler contentHandler, org.xml.sax.ext.LexicalHandler lexicalHandler)` Abstract template method for marshalling the given object graph to a SAX `ContentHandler`.
`void`	`marshalWriter(java.lang.Object graph, java.io.Writer writer)` Abstract template method for marshalling the given object graph to a `Writer`.
`void`	`marshalWriter(java.lang.Object graph, java.io.Writer writer, DataHolder dataHolder)`
`protected void`	`marshalXmlEventWriter(java.lang.Object graph, javax.xml.stream.XMLEventWriter eventWriter)` Abstract template method for marshalling the given object to a StAX `XMLEventWriter`.
`protected void`	`marshalXmlStreamWriter(java.lang.Object graph, javax.xml.stream.XMLStreamWriter streamWriter)` Abstract template method for marshalling the given object to a StAX `XMLStreamWriter`.
`void`	`setAliases(java.util.Map<java.lang.String,?> aliases)` Set the alias/type map, consisting of string aliases mapped to classes.
`void`	`setAliasesByType(java.util.Map<java.lang.String,?> aliasesByType)` Set the aliases by type map, consisting of string aliases mapped to classes.
`void`	`setAnnotatedClasses(java.lang.Class<?>... annotatedClasses)` Set annotated classes for which aliases will be read from class-level annotation metadata.
`void`	`setAutodetectAnnotations(boolean autodetectAnnotations)` Activate XStream's autodetection mode.
`void`	`setBeanClassLoader(java.lang.ClassLoader classLoader)` Callback that supplies the bean `class loader` to a bean instance.
`void`	`setConverterLookup(ConverterLookup converterLookup)` Set a custom XStream `ConverterLookup` to use.
`void`	`setConverterRegistry(ConverterRegistry converterRegistry)` Set a custom XStream `ConverterRegistry` to use.
`void`	`setConverters(ConverterMatcher... converters)` Set the `Converters` or `SingleValueConverters` to be registered with the `XStream` instance.
`void`	`setEncoding(java.lang.String encoding)` Set the encoding to be used for stream access.
`void`	`setFieldAliases(java.util.Map<java.lang.String,java.lang.String> fieldAliases)` Set the field alias/type map, consisting of field names.
`void`	`setImplicitCollections(java.util.Map<java.lang.Class<?>,java.lang.String> implicitCollections)` Specify implicit collection fields, as a Map consisting of `Class` instances mapped to comma separated collection field names.
`void`	`setMapper(Mapper mapper)` Set a custom XStream `Mapper` to use.
`void`	`setMapperWrappers(java.lang.Class<?>... mapperWrappers)` Set one or more custom XStream `MapperWrapper` classes.
`void`	`setMarshallingStrategy(MarshallingStrategy marshallingStrategy)` Set a custom XStream `MarshallingStrategy` to use.
`void`	`setMode(int mode)` Set the XStream mode to use.
`void`	`setNameCoder(NameCoder nameCoder)` Set a custom XStream `NameCoder` to use.
`void`	`setOmittedFields(java.util.Map<java.lang.Class<?>,java.lang.String> omittedFields)` Specify omitted fields, as a Map consisting of `Class` instances mapped to comma separated field names.
`void`	`setReflectionProvider(ReflectionProvider reflectionProvider)` Set a custom XStream `ReflectionProvider` to use.
`void`	`setStreamDriver(HierarchicalStreamDriver streamDriver)` Set a XStream `HierarchicalStreamDriver` to be used for readers and writers.
`void`	`setSupportedClasses(java.lang.Class<?>... supportedClasses)` Set the classes supported by this marshaller.
`void`	`setUseAttributeFor(java.util.Map<?,?> useAttributeFor)` Set the types to use XML attributes for.
`void`	`setUseAttributeForTypes(java.lang.Class<?>... useAttributeForTypes)` Set types to use XML attributes for.
`boolean`	`supports(java.lang.Class<?> clazz)` Indicates whether this marshaller can marshal instances of the supplied type.
`private java.util.Map<java.lang.String,java.lang.Class<?>>`	`toClassMap(java.util.Map<java.lang.String,?> map)`
`protected java.lang.Object`	`unmarshalDomNode(org.w3c.dom.Node node)` Abstract template method for unmarshalling from a given DOM `Node`.
`java.lang.Object`	`unmarshalInputStream(java.io.InputStream inputStream)` Abstract template method for unmarshalling from a given `InputStream`.
`java.lang.Object`	`unmarshalInputStream(java.io.InputStream inputStream, DataHolder dataHolder)`
`java.lang.Object`	`unmarshalReader(java.io.Reader reader)` Abstract template method for unmarshalling from a given `Reader`.
`java.lang.Object`	`unmarshalReader(java.io.Reader reader, DataHolder dataHolder)`
`protected java.lang.Object`	`unmarshalSaxReader(org.xml.sax.XMLReader xmlReader, org.xml.sax.InputSource inputSource)` Abstract template method for unmarshalling using a given SAX `XMLReader` and `InputSource`.
`protected java.lang.Object`	`unmarshalStreamSource(javax.xml.transform.stream.StreamSource streamSource)` Template method for handling `StreamSource`s.
`protected java.lang.Object`	`unmarshalXmlEventReader(javax.xml.stream.XMLEventReader eventReader)` Abstract template method for unmarshalling from a given Stax `XMLEventReader`.
`protected java.lang.Object`	`unmarshalXmlStreamReader(javax.xml.stream.XMLStreamReader streamReader)` Abstract template method for unmarshalling from a given Stax `XMLStreamReader`.

Methods inherited from class org.springframework.oxm.support.AbstractMarshaller
buildDocument, createDocumentBuilder, createDocumentBuilderFactory, createXmlReader, isProcessExternalEntities, isSupportDtd, marshal, marshalDomResult, marshalSaxResult, marshalStaxResult, marshalStreamResult, setProcessExternalEntities, setSupportDtd, unmarshal, unmarshalDomSource, unmarshalSaxSource, unmarshalStaxSource

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_ENCODING
```
public static final java.lang.String DEFAULT_ENCODING
```
    The default encoding used for stream access: UTF-8.
    
    See Also:
    
    Constant Field Values
  - reflectionProvider
```
private ReflectionProvider reflectionProvider
```
  - streamDriver
```
private HierarchicalStreamDriver streamDriver
```
  - defaultDriver
```
private HierarchicalStreamDriver defaultDriver
```
  - mapper
```
private Mapper mapper
```
  - mapperWrappers
```
private java.lang.Class<?>[] mapperWrappers
```
  - converterLookup
```
private ConverterLookup converterLookup
```
  - converterRegistry
```
private ConverterRegistry converterRegistry
```
  - converters
```
private ConverterMatcher[] converters
```
  - marshallingStrategy
```
private MarshallingStrategy marshallingStrategy
```
  - mode
```
private java.lang.Integer mode
```
  - aliases
```
private java.util.Map<java.lang.String,?> aliases
```
  - aliasesByType
```
private java.util.Map<java.lang.String,?> aliasesByType
```
  - fieldAliases
```
private java.util.Map<java.lang.String,java.lang.String> fieldAliases
```
  - useAttributeForTypes
```
private java.lang.Class<?>[] useAttributeForTypes
```
  - useAttributeFor
```
private java.util.Map<?,?> useAttributeFor
```
  - implicitCollections
```
private java.util.Map<java.lang.Class<?>,java.lang.String> implicitCollections
```
  - omittedFields
```
private java.util.Map<java.lang.Class<?>,java.lang.String> omittedFields
```
  - annotatedClasses
```
private java.lang.Class<?>[] annotatedClasses
```
  - autodetectAnnotations
```
private boolean autodetectAnnotations
```
  - encoding
```
private java.lang.String encoding
```
  - nameCoder
```
private NameCoder nameCoder
```
  - supportedClasses
```
private java.lang.Class<?>[] supportedClasses
```
  - beanClassLoader
```
private java.lang.ClassLoader beanClassLoader
```
  - xstream
```
private XStream xstream
```
- Constructor Detail
  - XStreamMarshaller
```
public XStreamMarshaller()
```
- Method Detail
  - setReflectionProvider
```
public void setReflectionProvider(ReflectionProvider reflectionProvider)
```
    Set a custom XStream ReflectionProvider to use.
    
    Since:
    
    4.0
  - setStreamDriver
```
public void setStreamDriver(HierarchicalStreamDriver streamDriver)
```
    Set a XStream HierarchicalStreamDriver to be used for readers and writers.
    As of Spring 4.0, this stream driver will also be passed to the XStream constructor and therefore used by streaming-related native API methods themselves.
  - getDefaultDriver
```
private HierarchicalStreamDriver getDefaultDriver()
```
  - setMapper
```
public void setMapper(Mapper mapper)
```
    Set a custom XStream Mapper to use.
    
    Since:
    
    4.0
  - setMapperWrappers
```
public void setMapperWrappers(java.lang.Class<?>... mapperWrappers)
```
    Set one or more custom XStream MapperWrapper classes. Each of those classes needs to have a constructor with a single argument of type Mapper or MapperWrapper.
    
    Since:
    
    4.0
  - setConverterLookup
```
public void setConverterLookup(ConverterLookup converterLookup)
```
    Set a custom XStream ConverterLookup to use. Also used as ConverterRegistry if the given reference implements it as well.
    
    Since:
    
    4.0
    
    See Also:
    
    DefaultConverterLookup
  - setConverterRegistry
```
public void setConverterRegistry(ConverterRegistry converterRegistry)
```
    Set a custom XStream ConverterRegistry to use.
    
    Since:
    
    4.0
    
    See Also:
    
    setConverterLookup(ConverterLookup), DefaultConverterLookup
  - setConverters
```
public void setConverters(ConverterMatcher... converters)
```
    Set the Converters or SingleValueConverters to be registered with the XStream instance.
    
    See Also:
    
    Converter, SingleValueConverter
  - setMarshallingStrategy
```
public void setMarshallingStrategy(MarshallingStrategy marshallingStrategy)
```
    Set a custom XStream MarshallingStrategy to use.
    
    Since:
    
    4.0
  - setMode
```
public void setMode(int mode)
```
    Set the XStream mode to use.
    
    See Also:
    
    XStream#ID_REFERENCES, XStream#NO_REFERENCES
  - setAliases
```
public void setAliases(java.util.Map<java.lang.String,?> aliases)
```
    Set the alias/type map, consisting of string aliases mapped to classes.
    Keys are aliases; values are either Class instances, or String class names.
    
    See Also:
    
    XStream#alias(String, Class)
  - setAliasesByType
```
public void setAliasesByType(java.util.Map<java.lang.String,?> aliasesByType)
```
    Set the aliases by type map, consisting of string aliases mapped to classes.
    Any class that is assignable to this type will be aliased to the same name. Keys are aliases; values are either Class instances, or String class names.
    
    See Also:
    
    XStream#aliasType(String, Class)
  - setFieldAliases
```
public void setFieldAliases(java.util.Map<java.lang.String,java.lang.String> fieldAliases)
```
    Set the field alias/type map, consisting of field names.
    
    See Also:
    
    XStream#aliasField(String, Class, String)
  - setUseAttributeForTypes
```
public void setUseAttributeForTypes(java.lang.Class<?>... useAttributeForTypes)
```
    Set types to use XML attributes for.
    
    See Also:
    
    XStream#useAttributeFor(Class)
  - setUseAttributeFor
```
public void setUseAttributeFor(java.util.Map<?,?> useAttributeFor)
```
    Set the types to use XML attributes for. The given map can contain either <String, Class> pairs, in which case XStream#useAttributeFor(String, Class) is called. Alternatively, the map can contain <Class, String> or <Class, List<String>> pairs, which results in XStream#useAttributeFor(Class, String) calls.
  - setImplicitCollections
```
public void setImplicitCollections(java.util.Map<java.lang.Class<?>,java.lang.String> implicitCollections)
```
    Specify implicit collection fields, as a Map consisting of Class instances mapped to comma separated collection field names.
    
    See Also:
    
    XStream#addImplicitCollection(Class, String)
  - setOmittedFields
```
public void setOmittedFields(java.util.Map<java.lang.Class<?>,java.lang.String> omittedFields)
```
    Specify omitted fields, as a Map consisting of Class instances mapped to comma separated field names.
    
    See Also:
    
    XStream#omitField(Class, String)
  - setAnnotatedClasses
```
public void setAnnotatedClasses(java.lang.Class<?>... annotatedClasses)
```
    Set annotated classes for which aliases will be read from class-level annotation metadata.
    
    See Also:
    
    XStream#processAnnotations(Class[])
  - setAutodetectAnnotations
```
public void setAutodetectAnnotations(boolean autodetectAnnotations)
```
    Activate XStream's autodetection mode.
    Note: Autodetection implies that the XStream instance is being configured while it is processing the XML streams, and thus introduces a potential concurrency problem.
    
    See Also:
    
    XStream#autodetectAnnotations(boolean)
  - setEncoding
```
public void setEncoding(java.lang.String encoding)
```
    Set the encoding to be used for stream access.
    
    See Also:
    
    DEFAULT_ENCODING
  - getDefaultEncoding
```
protected java.lang.String getDefaultEncoding()
```
    Description copied from class: AbstractMarshaller
    
    Determine the default encoding to use for marshalling or unmarshalling from a byte stream, or null if none.
    The default implementation returns null.
    
    Overrides:
    
    getDefaultEncoding in class AbstractMarshaller
  - setNameCoder
```
public void setNameCoder(NameCoder nameCoder)
```
    Set a custom XStream NameCoder to use. The default is an XmlFriendlyNameCoder.
    
    Since:
    
    4.0.4
  - setSupportedClasses
```
public void setSupportedClasses(java.lang.Class<?>... supportedClasses)
```
    Set the classes supported by this marshaller.
    If this property is empty (the default), all classes are supported.
    
    See Also:
    
    supports(Class)
  - setBeanClassLoader
```
public void setBeanClassLoader(java.lang.ClassLoader classLoader)
```
    Description copied from interface: BeanClassLoaderAware
    
    Callback that supplies the bean class loader to a bean instance.
    Invoked after the population of normal bean properties but before an initialization callback such as InitializingBean's InitializingBean.afterPropertiesSet() method or a custom init-method.
    
    Specified by:
    
    setBeanClassLoader in interface BeanClassLoaderAware
    
    Parameters:
    
    classLoader - the owning class loader; may be null in which case a default ClassLoader must be used, for example the ClassLoader obtained via ClassUtils.getDefaultClassLoader()
  - afterPropertiesSet
```
public void afterPropertiesSet()
```
    Description copied from interface: InitializingBean
    
    Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).
    This method allows the bean instance to perform initialization only possible when all bean properties have been set and to throw an exception in the event of misconfiguration.
    
    Specified by:
    
    afterPropertiesSet in interface InitializingBean
  - buildXStream
```
protected XStream buildXStream()
```
    Build the native XStream delegate to be used by this marshaller, delegating to constructXStream(), configureXStream(XStream) and customizeXStream(XStream).
  - constructXStream
```
protected XStream constructXStream()
```
    Construct an XStream instance, either using one of the standard constructors or creating a custom subclass.
    
    Returns:
    
    the XStream instance
  - configureXStream
```
protected void configureXStream(XStream xstream)
```
    Configure the XStream instance with this marshaller's bean properties.
    
    Parameters:
    
    xstream - the XStream instance
  - toClassMap
```
private java.util.Map<java.lang.String,java.lang.Class<?>> toClassMap(java.util.Map<java.lang.String,?> map)
                                                               throws java.lang.ClassNotFoundException
```
    Throws:
    
    java.lang.ClassNotFoundException
  - customizeXStream
```
protected void customizeXStream(XStream xstream)
```
    Template to allow for customizing the given XStream.
    The default implementation is empty.
    
    Parameters:
    
    xstream - the XStream instance
  - getXStream
```
public final XStream getXStream()
```
    Return the native XStream delegate used by this marshaller.
    NOTE: This method has been marked as final as of Spring 4.0. It can be used to access the fully configured XStream for marshalling but not configuration purposes anymore.
  - supports
```
public boolean supports(java.lang.Class<?> clazz)
```
    Description copied from interface: Marshaller
    
    Indicates whether this marshaller can marshal instances of the supplied type.
    
    Specified by:
    
    supports in interface Marshaller
    
    Specified by:
    
    supports in interface Unmarshaller
    
    Parameters:
    
    clazz - the class that this marshaller is being asked if it can marshal
    
    Returns:
    
    true if this marshaller can indeed marshal instances of the supplied class; false otherwise
  - marshalDomNode
```
protected void marshalDomNode(java.lang.Object graph,
                              org.w3c.dom.Node node)
                       throws XmlMappingException
```
    Description copied from class: AbstractMarshaller
    
    Abstract template method for marshalling the given object graph to a DOM Node.
    In practice, node is be a Document node, a DocumentFragment node, or a Element node. In other words, a node that accepts children.
    
    Specified by:
    
    marshalDomNode in class AbstractMarshaller
    
    Parameters:
    
    graph - the root of the object graph to marshal
    
    node - the DOM node that will contain the result tree
    
    Throws:
    
    XmlMappingException - if the given object cannot be marshalled to the DOM node
    
    See Also:
    
    Document, DocumentFragment, Element
  - marshalXmlEventWriter
```
protected void marshalXmlEventWriter(java.lang.Object graph,
                                     javax.xml.stream.XMLEventWriter eventWriter)
                              throws XmlMappingException
```
    Description copied from class: AbstractMarshaller
    
    Abstract template method for marshalling the given object to a StAX XMLEventWriter.
    
    Specified by:
    
    marshalXmlEventWriter in class AbstractMarshaller
    
    Parameters:
    
    graph - the root of the object graph to marshal
    
    eventWriter - the XMLEventWriter to write to
    
    Throws:
    
    XmlMappingException - if the given object cannot be marshalled to the DOM node
  - marshalXmlStreamWriter
```
protected void marshalXmlStreamWriter(java.lang.Object graph,
                                      javax.xml.stream.XMLStreamWriter streamWriter)
                               throws XmlMappingException
```
    Description copied from class: AbstractMarshaller
    
    Abstract template method for marshalling the given object to a StAX XMLStreamWriter.
    
    Specified by:
    
    marshalXmlStreamWriter in class AbstractMarshaller
    
    Parameters:
    
    graph - the root of the object graph to marshal
    
    streamWriter - the XMLStreamWriter to write to
    
    Throws:
    
    XmlMappingException - if the given object cannot be marshalled to the DOM node
  - marshalSaxHandlers
```
protected void marshalSaxHandlers(java.lang.Object graph,
                                  org.xml.sax.ContentHandler contentHandler,
                                  org.xml.sax.ext.LexicalHandler lexicalHandler)
                           throws XmlMappingException
```
    Description copied from class: AbstractMarshaller
    
    Abstract template method for marshalling the given object graph to a SAX ContentHandler.
    
    Specified by:
    
    marshalSaxHandlers in class AbstractMarshaller
    
    Parameters:
    
    graph - the root of the object graph to marshal
    
    contentHandler - the SAX ContentHandler
    
    lexicalHandler - the SAX2 LexicalHandler. Can be null.
    
    Throws:
    
    XmlMappingException - if the given object cannot be marshalled to the handlers
  - marshalOutputStream
```
public void marshalOutputStream(java.lang.Object graph,
                                java.io.OutputStream outputStream)
                         throws XmlMappingException,
                                java.io.IOException
```
    Description copied from class: AbstractMarshaller
    
    Abstract template method for marshalling the given object graph to a OutputStream.
    
    Specified by:
    
    marshalOutputStream in class AbstractMarshaller
    
    Parameters:
    
    graph - the root of the object graph to marshal
    
    outputStream - the OutputStream to write to
    
    Throws:
    
    XmlMappingException - if the given object cannot be marshalled to the writer
    
    java.io.IOException - if an I/O exception occurs
  - marshalOutputStream
```
public void marshalOutputStream(java.lang.Object graph,
                                java.io.OutputStream outputStream,
                                DataHolder dataHolder)
                         throws XmlMappingException,
                                java.io.IOException
```
    Throws:
    
    XmlMappingException
    
    java.io.IOException
  - marshalWriter
```
public void marshalWriter(java.lang.Object graph,
                          java.io.Writer writer)
                   throws XmlMappingException,
                          java.io.IOException
```
    Description copied from class: AbstractMarshaller
    
    Abstract template method for marshalling the given object graph to a Writer.
    
    Specified by:
    
    marshalWriter in class AbstractMarshaller
    
    Parameters:
    
    graph - the root of the object graph to marshal
    
    writer - the Writer to write to
    
    Throws:
    
    XmlMappingException - if the given object cannot be marshalled to the writer
    
    java.io.IOException - if an I/O exception occurs
  - marshalWriter
```
public void marshalWriter(java.lang.Object graph,
                          java.io.Writer writer,
                          DataHolder dataHolder)
                   throws XmlMappingException,
                          java.io.IOException
```
    Throws:
    
    XmlMappingException
    
    java.io.IOException
  - doMarshal
```
private void doMarshal(java.lang.Object graph,
                       HierarchicalStreamWriter streamWriter,
                       DataHolder dataHolder)
```
    Marshals the given graph to the given XStream HierarchicalStreamWriter. Converts exceptions using convertXStreamException(java.lang.Exception, boolean).
  - unmarshalStreamSource
```
protected java.lang.Object unmarshalStreamSource(javax.xml.transform.stream.StreamSource streamSource)
                                          throws XmlMappingException,
                                                 java.io.IOException
```
    Description copied from class: AbstractMarshaller
    
    Template method for handling StreamSources.
    This implementation delegates to unmarshalInputStream or unmarshalReader.
    
    Overrides:
    
    unmarshalStreamSource in class AbstractMarshaller
    
    Parameters:
    
    streamSource - the StreamSource
    
    Returns:
    
    the object graph
    
    Throws:
    
    XmlMappingException - if the given source cannot be mapped to an object
    
    java.io.IOException - if an I/O exception occurs
  - unmarshalDomNode
```
protected java.lang.Object unmarshalDomNode(org.w3c.dom.Node node)
                                     throws XmlMappingException
```
    Description copied from class: AbstractMarshaller
    
    Abstract template method for unmarshalling from a given DOM Node.
    
    Specified by:
    
    unmarshalDomNode in class AbstractMarshaller
    
    Parameters:
    
    node - the DOM node that contains the objects to be unmarshalled
    
    Returns:
    
    the object graph
    
    Throws:
    
    XmlMappingException - if the given DOM node cannot be mapped to an object
  - unmarshalXmlEventReader
```
protected java.lang.Object unmarshalXmlEventReader(javax.xml.stream.XMLEventReader eventReader)
                                            throws XmlMappingException
```
    Description copied from class: AbstractMarshaller
    
    Abstract template method for unmarshalling from a given Stax XMLEventReader.
    
    Specified by:
    
    unmarshalXmlEventReader in class AbstractMarshaller
    
    Parameters:
    
    eventReader - the XMLEventReader to read from
    
    Returns:
    
    the object graph
    
    Throws:
    
    XmlMappingException - if the given event reader cannot be converted to an object
  - unmarshalXmlStreamReader
```
protected java.lang.Object unmarshalXmlStreamReader(javax.xml.stream.XMLStreamReader streamReader)
                                             throws XmlMappingException
```
    Description copied from class: AbstractMarshaller
    
    Abstract template method for unmarshalling from a given Stax XMLStreamReader.
    
    Specified by:
    
    unmarshalXmlStreamReader in class AbstractMarshaller
    
    Parameters:
    
    streamReader - the XMLStreamReader to read from
    
    Returns:
    
    the object graph
    
    Throws:
    
    XmlMappingException - if the given stream reader cannot be converted to an object
  - unmarshalSaxReader
```
protected java.lang.Object unmarshalSaxReader(org.xml.sax.XMLReader xmlReader,
                                              org.xml.sax.InputSource inputSource)
                                       throws XmlMappingException,
                                              java.io.IOException
```
    Description copied from class: AbstractMarshaller
    
    Abstract template method for unmarshalling using a given SAX XMLReader and InputSource.
    
    Specified by:
    
    unmarshalSaxReader in class AbstractMarshaller
    
    Parameters:
    
    xmlReader - the SAX XMLReader to parse with
    
    inputSource - the input source to parse from
    
    Returns:
    
    the object graph
    
    Throws:
    
    XmlMappingException - if the given reader and input source cannot be converted to an object
    
    java.io.IOException - if an I/O exception occurs
  - unmarshalInputStream
```
public java.lang.Object unmarshalInputStream(java.io.InputStream inputStream)
                                      throws XmlMappingException,
                                             java.io.IOException
```
    Description copied from class: AbstractMarshaller
    
    Abstract template method for unmarshalling from a given InputStream.
    
    Specified by:
    
    unmarshalInputStream in class AbstractMarshaller
    
    Parameters:
    
    inputStream - the InputStreamStream to read from
    
    Returns:
    
    the object graph
    
    Throws:
    
    XmlMappingException - if the given stream cannot be converted to an object
    
    java.io.IOException - if an I/O exception occurs
  - unmarshalInputStream
```
public java.lang.Object unmarshalInputStream(java.io.InputStream inputStream,
                                             DataHolder dataHolder)
                                      throws XmlMappingException,
                                             java.io.IOException
```
    Throws:
    
    XmlMappingException
    
    java.io.IOException
  - unmarshalReader
```
public java.lang.Object unmarshalReader(java.io.Reader reader)
                                 throws XmlMappingException,
                                        java.io.IOException
```
    Description copied from class: AbstractMarshaller
    
    Abstract template method for unmarshalling from a given Reader.
    
    Specified by:
    
    unmarshalReader in class AbstractMarshaller
    
    Parameters:
    
    reader - the Reader to read from
    
    Returns:
    
    the object graph
    
    Throws:
    
    XmlMappingException - if the given reader cannot be converted to an object
    
    java.io.IOException - if an I/O exception occurs
  - unmarshalReader
```
public java.lang.Object unmarshalReader(java.io.Reader reader,
                                        DataHolder dataHolder)
                                 throws XmlMappingException,
                                        java.io.IOException
```
    Throws:
    
    XmlMappingException
    
    java.io.IOException
  - doUnmarshal
```
private java.lang.Object doUnmarshal(HierarchicalStreamReader streamReader,
                                     DataHolder dataHolder)
```
    Unmarshals the given graph to the given XStream HierarchicalStreamWriter. Converts exceptions using convertXStreamException(java.lang.Exception, boolean).
  - convertXStreamException
```
protected XmlMappingException convertXStreamException(java.lang.Exception ex,
                                                      boolean marshalling)
```
    Convert the given XStream exception to an appropriate exception from the org.springframework.oxm hierarchy.
    A boolean flag is used to indicate whether this exception occurs during marshalling or unmarshalling, since XStream itself does not make this distinction in its exception hierarchy.
    
    Parameters:
    
    ex - XStream exception that occurred
    
    marshalling - indicates whether the exception occurs during marshalling (true), or unmarshalling (false)
    
    Returns:
    
    the corresponding XmlMappingException

Class XStreamMarshaller

Field Summary

Fields inherited from class org.springframework.oxm.support.AbstractMarshaller

Constructor Summary

Method Summary

Methods inherited from class org.springframework.oxm.support.AbstractMarshaller

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_ENCODING

reflectionProvider

streamDriver

defaultDriver

mapper

mapperWrappers

converterLookup

converterRegistry

converters

marshallingStrategy

mode

aliases

aliasesByType

fieldAliases

useAttributeForTypes

useAttributeFor

implicitCollections

omittedFields

annotatedClasses

autodetectAnnotations

encoding

nameCoder

supportedClasses

beanClassLoader

xstream

Constructor Detail

XStreamMarshaller

Method Detail

setReflectionProvider

setStreamDriver

getDefaultDriver

setMapper

setMapperWrappers

setConverterLookup

setConverterRegistry

setConverters

setMarshallingStrategy

setMode

setAliases

setAliasesByType

setFieldAliases

setUseAttributeForTypes

setUseAttributeFor

setImplicitCollections

setOmittedFields

setAnnotatedClasses

setAutodetectAnnotations

setEncoding

getDefaultEncoding

setNameCoder

setSupportedClasses

setBeanClassLoader

afterPropertiesSet

buildXStream

constructXStream

configureXStream

toClassMap

customizeXStream

getXStream

supports

marshalDomNode

marshalXmlEventWriter

marshalXmlStreamWriter

marshalSaxHandlers

marshalOutputStream

marshalOutputStream

marshalWriter

marshalWriter

doMarshal

unmarshalStreamSource

unmarshalDomNode

unmarshalXmlEventReader