java.lang.Object
- org.springframework.oxm.support.AbstractMarshaller
- - org.springframework.oxm.xmlbeans.XmlBeansMarshaller

All Implemented Interfaces:
Marshaller, Unmarshaller
```
@Deprecated
public class XmlBeansMarshaller
extends AbstractMarshaller
```
Deprecated.
as of Spring 4.2, following the XMLBeans retirement at Apache
Implementation of the Marshaller interface for Apache XMLBeans.
Options can be set by setting the xmlOptions property. The XmlOptionsFactoryBean is provided to easily set up an XmlOptions instance.
Unmarshalled objects can be validated by setting the validating property, or by calling the validate(XmlObject) method directly. Invalid objects will result in an ValidationFailureException.
NOTE: Due to the nature of XMLBeans, this marshaller requires all passed objects to be of type XmlObject.
Since:
3.0
Author:
Arjen Poutsma
See Also:
setValidating(boolean), setXmlOptions(org.apache.xmlbeans.XmlOptions), XmlOptionsFactoryBean

Field Summary
- Fields inherited from class org.springframework.oxm.support.AbstractMarshaller
  logger

Constructor Summary
Constructors
Constructor Description
XmlBeansMarshaller()
Deprecated.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`protected XmlMappingException`	`convertXmlBeansException(Exception ex, boolean marshalling)`	Deprecated. Convert the given XMLBeans exception to an appropriate exception from the `org.springframework.oxm` hierarchy.
`org.apache.xmlbeans.XmlOptions`	`getXmlOptions()`	Deprecated. Return the `XmlOptions`.
`boolean`	`isValidating()`	Deprecated. Return whether this marshaller should validate in- and outgoing documents.
`protected void`	`marshalDomNode(Object graph, Node node)`	Deprecated. Abstract template method for marshalling the given object graph to a DOM `Node`.
`protected void`	`marshalOutputStream(Object graph, OutputStream outputStream)`	Deprecated. Abstract template method for marshalling the given object graph to a `OutputStream`.
`protected void`	`marshalSaxHandlers(Object graph, ContentHandler contentHandler, LexicalHandler lexicalHandler)`	Deprecated. Abstract template method for marshalling the given object graph to a SAX `ContentHandler`.
`protected void`	`marshalWriter(Object graph, Writer writer)`	Deprecated. Abstract template method for marshalling the given object graph to a `Writer`.
`protected void`	`marshalXmlEventWriter(Object graph, XMLEventWriter eventWriter)`	Deprecated. Abstract template method for marshalling the given object to a StAX `XMLEventWriter`.
`protected void`	`marshalXmlStreamWriter(Object graph, XMLStreamWriter streamWriter)`	Deprecated. Abstract template method for marshalling the given object to a StAX `XMLStreamWriter`.
`void`	`setValidating(boolean validating)`	Deprecated. Set whether this marshaller should validate in- and outgoing documents.
`void`	`setXmlOptions(org.apache.xmlbeans.XmlOptions xmlOptions)`	Deprecated. Set the `XmlOptions`.
`boolean`	`supports(Class<?> clazz)`	Deprecated. This implementation returns true if the given class is an implementation of `XmlObject`.
`protected Object`	`unmarshalDomNode(Node node)`	Deprecated. Abstract template method for unmarshalling from a given DOM `Node`.
`protected Object`	`unmarshalInputStream(InputStream inputStream)`	Deprecated. Abstract template method for unmarshalling from a given `InputStream`.
`protected Object`	`unmarshalReader(Reader reader)`	Deprecated. Abstract template method for unmarshalling from a given `Reader`.
`protected Object`	`unmarshalSaxReader(XMLReader xmlReader, InputSource inputSource)`	Deprecated. Abstract template method for unmarshalling using a given SAX `XMLReader` and `InputSource`.
`protected Object`	`unmarshalXmlEventReader(XMLEventReader eventReader)`	Deprecated. Abstract template method for unmarshalling from a given Stax `XMLEventReader`.
`protected Object`	`unmarshalXmlStreamReader(XMLStreamReader streamReader)`	Deprecated. Abstract template method for unmarshalling from a given Stax `XMLStreamReader`.
`protected void`	`validate(org.apache.xmlbeans.XmlObject object)`	Deprecated. Validate the given `XmlObject`.

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

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

- Constructor Detail
  - XmlBeansMarshaller
```
public XmlBeansMarshaller()
```
    Deprecated.
- Method Detail
  - setXmlOptions
```
public void setXmlOptions(org.apache.xmlbeans.XmlOptions xmlOptions)
```
    Deprecated.
    Set the XmlOptions.
    See Also:
    XmlOptionsFactoryBean
  - getXmlOptions
```
public org.apache.xmlbeans.XmlOptions getXmlOptions()
```
    Deprecated.
    Return the XmlOptions.
  - setValidating
```
public void setValidating(boolean validating)
```
    Deprecated.
    Set whether this marshaller should validate in- and outgoing documents. Default is false.
  - isValidating
```
public boolean isValidating()
```
    Deprecated.
    Return whether this marshaller should validate in- and outgoing documents.
  - supports
```
public boolean supports(Class<?> clazz)
```
    Deprecated.
    This implementation returns true if the given class is an implementation of XmlObject.
    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(Object graph,
                              Node node)
                       throws XmlMappingException
```
    Deprecated.
    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(Object graph,
                                     XMLEventWriter eventWriter)
```
    Deprecated.
    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
  - marshalXmlStreamWriter
```
protected void marshalXmlStreamWriter(Object graph,
                                      XMLStreamWriter streamWriter)
                               throws XmlMappingException
```
    Deprecated.
    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(Object graph,
                                  ContentHandler contentHandler,
                                  LexicalHandler lexicalHandler)
                           throws XmlMappingException
```
    Deprecated.
    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
```
protected void marshalOutputStream(Object graph,
                                   OutputStream outputStream)
                            throws XmlMappingException,
                                   IOException
```
    Deprecated.
    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
    IOException - if an I/O exception occurs
  - marshalWriter
```
protected void marshalWriter(Object graph,
                             Writer writer)
                      throws XmlMappingException,
                             IOException
```
    Deprecated.
    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
    IOException - if an I/O exception occurs
  - unmarshalDomNode
```
protected Object unmarshalDomNode(Node node)
                           throws XmlMappingException
```
    Deprecated.
    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 Object unmarshalXmlEventReader(XMLEventReader eventReader)
                                  throws XmlMappingException
```
    Deprecated.
    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 Object unmarshalXmlStreamReader(XMLStreamReader streamReader)
                                   throws XmlMappingException
```
    Deprecated.
    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 Object unmarshalSaxReader(XMLReader xmlReader,
                                    InputSource inputSource)
                             throws XmlMappingException,
                                    IOException
```
    Deprecated.
    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
    IOException - if an I/O exception occurs
  - unmarshalInputStream
```
protected Object unmarshalInputStream(InputStream inputStream)
                               throws XmlMappingException,
                                      IOException
```
    Deprecated.
    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
    IOException - if an I/O exception occurs
  - unmarshalReader
```
protected Object unmarshalReader(Reader reader)
                          throws XmlMappingException,
                                 IOException
```
    Deprecated.
    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
    IOException - if an I/O exception occurs
  - validate
```
protected void validate(org.apache.xmlbeans.XmlObject object)
                 throws ValidationFailureException
```
    Deprecated.
    Validate the given XmlObject.
    Parameters:
    object - the xml object to validate
    Throws:
    ValidationFailureException - if the given object is not valid
  - convertXmlBeansException
```
protected XmlMappingException convertXmlBeansException(Exception ex,
                                                       boolean marshalling)
```
    Deprecated.
    Convert the given XMLBeans 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 XMLBeans itself does not make this distinction in its exception hierarchy.
    Parameters:
    ex - XMLBeans Exception that occured
    marshalling - indicates whether the exception occurs during marshalling (true), or unmarshalling (false)
    Returns:
    the corresponding XmlMappingException

Class XmlBeansMarshaller

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

Constructor Detail

XmlBeansMarshaller

Method Detail

setXmlOptions

getXmlOptions

setValidating

isValidating

supports

marshalDomNode

marshalXmlEventWriter

marshalXmlStreamWriter

marshalSaxHandlers

marshalOutputStream

marshalWriter

unmarshalDomNode

unmarshalXmlEventReader

unmarshalXmlStreamReader

unmarshalSaxReader

unmarshalInputStream

unmarshalReader

validate

convertXmlBeansException