|
Spring Web Services Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.springframework.oxm.AbstractMarshaller
org.springframework.oxm.xmlbeans.XmlBeansMarshaller
public class XmlBeansMarshaller
Implementation of the Marshaller
interface for XMLBeans. Further options can be set by setting the
xmlOptions
property. The XmlOptionsFactoryBean
is provided to easily wire up XmlOptions
instances.
validating
property, or by calling the validate(XmlObject)
method directly. Invalid objects will result in an XmlBeansValidationFailureException
.
Note that due to the nature of XMLBeans, this marshaller requires all passed objects to be of type
XmlObject
.
setXmlOptions(org.apache.xmlbeans.XmlOptions)
,
XmlOptionsFactoryBean
,
setValidating(boolean)
Field Summary |
---|
Fields inherited from class org.springframework.oxm.AbstractMarshaller |
---|
logger |
Constructor Summary | |
---|---|
XmlBeansMarshaller()
|
Method Summary | |
---|---|
XmlMappingException |
convertXmlBeansException(Exception ex,
boolean marshalling)
Converts the given XMLBeans exception to an appropriate exception from the org.springframework.oxm
hierarchy. |
XmlOptions |
getXmlOptions()
Returns the XmlOptions . |
boolean |
isValidating()
Returns whether this marshaller should validate in- and outgoing documents. |
protected void |
marshalDomNode(Object graph,
Node node)
Abstract template method for marshalling the given object graph to a DOM Node . |
protected void |
marshalOutputStream(Object graph,
OutputStream outputStream)
Abstract template method for marshalling the given object graph to a OutputStream . |
protected void |
marshalSaxHandlers(Object graph,
ContentHandler contentHandler,
LexicalHandler lexicalHandler)
Abstract template method for marshalling the given object graph to a SAX ContentHandler . |
protected void |
marshalWriter(Object graph,
Writer writer)
Abstract template method for marshalling the given object graph to a Writer . |
protected void |
marshalXmlEventWriter(Object graph,
XMLEventWriter eventWriter)
Abstract template method for marshalling the given object to a StAX XMLEventWriter . |
protected void |
marshalXmlStreamWriter(Object graph,
XMLStreamWriter streamWriter)
Abstract template method for marshalling the given object to a StAX XMLStreamWriter . |
void |
setValidating(boolean validating)
Sets whether this marshaller should validate in- and outgoing documents. |
void |
setXmlOptions(XmlOptions xmlOptions)
Sets the XmlOptions . |
boolean |
supports(Class clazz)
Returns true if the given class is an implementation of XmlObject . |
protected Object |
unmarshalDomNode(Node node)
Abstract template method for unmarshalling from a given DOM Node . |
protected Object |
unmarshalInputStream(InputStream inputStream)
Abstract template method for unmarshalling from a given InputStream . |
protected Object |
unmarshalReader(Reader reader)
Abstract template method for unmarshalling from a given Reader . |
protected Object |
unmarshalSaxReader(XMLReader xmlReader,
InputSource inputSource)
Abstract template method for unmarshalling using a given SAX XMLReader and
InputSource . |
protected Object |
unmarshalXmlEventReader(XMLEventReader eventReader)
Abstract template method for unmarshalling from a given Stax XMLEventReader . |
protected Object |
unmarshalXmlStreamReader(XMLStreamReader streamReader)
Abstract template method for unmarshalling from a given Stax XMLStreamReader . |
void |
validate(XmlObject object)
Validates the given XmlObject . |
Methods inherited from class org.springframework.oxm.AbstractMarshaller |
---|
createDocumentBuilder, createDocumentBuilderFactory, createXmlReader, marshal, marshalDomResult, marshalSaxResult, marshalStaxResult, marshalStreamResult, 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 |
---|
public XmlBeansMarshaller()
Method Detail |
---|
public XmlOptions getXmlOptions()
XmlOptions
.
public void setXmlOptions(XmlOptions xmlOptions)
XmlOptions
.
XmlOptionsFactoryBean
public boolean isValidating()
public void setValidating(boolean validating)
false
.
public boolean supports(Class clazz)
XmlObject
.
clazz
- the class that this marshaller is being asked if it can marshal
true
if this marshaller can indeed marshal instances of the supplied class;
false
otherwiseprotected final void marshalDomNode(Object graph, Node node) throws XmlMappingException
AbstractMarshaller
Node
.
In practice, node is be a Document
node, a DocumentFragment
node, or a
Element
node. In other words, a node that accepts children.
marshalDomNode
in class AbstractMarshaller
graph
- the root of the object graph to marshalnode
- The DOM node that will contain the result tree
XmlMappingException
- if the given object cannot be marshalled to the DOM nodeDocument
,
DocumentFragment
,
Element
protected final void marshalOutputStream(Object graph, OutputStream outputStream) throws XmlMappingException, IOException
AbstractMarshaller
OutputStream
.
marshalOutputStream
in class AbstractMarshaller
graph
- the root of the object graph to marshaloutputStream
- the OutputStream
to write to
XmlMappingException
- if the given object cannot be marshalled to the writer
IOException
- if an I/O exception occursprotected final void marshalSaxHandlers(Object graph, ContentHandler contentHandler, LexicalHandler lexicalHandler) throws XmlMappingException
AbstractMarshaller
ContentHandler
.
marshalSaxHandlers
in class AbstractMarshaller
graph
- the root of the object graph to marshalcontentHandler
- the SAX ContentHandler
lexicalHandler
- the SAX2 LexicalHandler
. Can be null
.
XmlMappingException
- if the given object cannot be marshalled to the handlersprotected final void marshalWriter(Object graph, Writer writer) throws XmlMappingException, IOException
AbstractMarshaller
Writer
.
marshalWriter
in class AbstractMarshaller
graph
- the root of the object graph to marshalwriter
- the Writer
to write to
XmlMappingException
- if the given object cannot be marshalled to the writer
IOException
- if an I/O exception occursprotected final void marshalXmlEventWriter(Object graph, XMLEventWriter eventWriter)
AbstractMarshaller
XMLEventWriter
.
marshalXmlEventWriter
in class AbstractMarshaller
graph
- the root of the object graph to marshaleventWriter
- the XMLEventWriter
to write toprotected final void marshalXmlStreamWriter(Object graph, XMLStreamWriter streamWriter) throws XmlMappingException
AbstractMarshaller
XMLStreamWriter
.
marshalXmlStreamWriter
in class AbstractMarshaller
graph
- the root of the object graph to marshalstreamWriter
- the XMLStreamWriter
to write to
XmlMappingException
- if the given object cannot be marshalled to the DOM nodeprotected final Object unmarshalDomNode(Node node) throws XmlMappingException
AbstractMarshaller
Node
.
unmarshalDomNode
in class AbstractMarshaller
node
- The DOM node that contains the objects to be unmarshalled
XmlMappingException
- if the given DOM node cannot be mapped to an objectprotected final Object unmarshalInputStream(InputStream inputStream) throws XmlMappingException, IOException
AbstractMarshaller
InputStream
.
unmarshalInputStream
in class AbstractMarshaller
inputStream
- the InputStreamStream
to read from
XmlMappingException
- if the given stream cannot be converted to an object
IOException
- if an I/O exception occursprotected final Object unmarshalReader(Reader reader) throws XmlMappingException, IOException
AbstractMarshaller
Reader
.
unmarshalReader
in class AbstractMarshaller
reader
- the Reader
to read from
XmlMappingException
- if the given reader cannot be converted to an object
IOException
- if an I/O exception occursprotected final Object unmarshalSaxReader(XMLReader xmlReader, InputSource inputSource) throws XmlMappingException, IOException
AbstractMarshaller
XMLReader
and
InputSource
.
unmarshalSaxReader
in class AbstractMarshaller
xmlReader
- the SAX XMLReader
to parse withinputSource
- the input source to parse from
XmlMappingException
- if the given reader and input source cannot be converted to an object
IOException
- if an I/O exception occursprotected final Object unmarshalXmlEventReader(XMLEventReader eventReader) throws XmlMappingException
AbstractMarshaller
XMLEventReader
.
unmarshalXmlEventReader
in class AbstractMarshaller
eventReader
- The XMLEventReader
to read from
XmlMappingException
- if the given event reader cannot be converted to an objectprotected final Object unmarshalXmlStreamReader(XMLStreamReader streamReader) throws XmlMappingException
AbstractMarshaller
XMLStreamReader
.
unmarshalXmlStreamReader
in class AbstractMarshaller
streamReader
- The XMLStreamReader
to read from
XmlMappingException
- if the given stream reader cannot be converted to an objectpublic XmlMappingException convertXmlBeansException(Exception ex, boolean marshalling)
org.springframework.oxm
hierarchy.
The default implementation delegates to XmlBeansUtils
. Can be overridden in subclasses.
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.
ex
- XMLBeans Exception that occuredmarshalling
- indicates whether the exception occurs during marshalling (true
), or
unmarshalling (false
)
XmlMappingException
XmlBeansUtils.convertXmlBeansException(Exception,boolean)
public void validate(XmlObject object) throws XmlBeansValidationFailureException
XmlObject
.
object
- the xml object to validate
XmlBeansValidationFailureException
- if the given object is not valid
|
Spring Web Services Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |