|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.springframework.oxm.support.AbstractMarshaller
org.springframework.oxm.xstream.XStreamMarshaller
public class XStreamMarshaller
Implementation of the Marshaller interface for XStream.
By default, XStream does not require any further configuration, though class aliases can be used to have more control over the behavior of XStream.
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.
setAliases(java.util.Map) ,
setConverters(com.thoughtworks.xstream.converters.ConverterMatcher[]),
setEncoding(java.lang.String)| Field Summary | |
|---|---|
static String |
DEFAULT_ENCODING
The default encoding used for stream access: UTF-8. |
| Fields inherited from class org.springframework.oxm.support.AbstractMarshaller |
|---|
logger |
| Constructor Summary | |
|---|---|
XStreamMarshaller()
|
|
| Method Summary | |
|---|---|
void |
afterPropertiesSet()
Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware). |
protected XmlMappingException |
convertXStreamException(Exception ex,
boolean marshalling)
Convert the given XStream exception to an appropriate exception from the org.springframework.oxm hierarchy. |
protected void |
customizeXStream(com.thoughtworks.xstream.XStream xstream)
Template to allow for customizing of the given XStream. |
com.thoughtworks.xstream.XStream |
getXStream()
Returns the XStream instance used by this marshaller. |
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 |
setAliases(Map<String,?> aliases)
Sets an alias/type map, consisting of string aliases mapped to classes. |
void |
setAliasesByType(Map<String,?> aliases)
Sets the aliases by type map, consisting of string aliases mapped to classes. |
void |
setAnnotatedClass(Class<?> annotatedClass)
Set the classes for which mappings will be read from class-level JDK 1.5+ annotation metadata. |
void |
setAnnotatedClasses(Class<?>[] annotatedClasses)
Set annotated classes for which aliases will be read from class-level JDK 1.5+ annotation metadata. |
void |
setAutodetectAnnotations(boolean autodetectAnnotations)
Set the autodetection mode of XStream. |
void |
setBeanClassLoader(ClassLoader classLoader)
Callback that supplies the bean class loader to
a bean instance. |
void |
setConverters(com.thoughtworks.xstream.converters.ConverterMatcher[] converters)
Set the Converters or SingleValueConverters to be registered
with the XStream instance. |
void |
setEncoding(String encoding)
Set the encoding to be used for stream access. |
void |
setFieldAliases(Map<String,String> aliases)
Sets a field alias/type map, consiting of field names |
void |
setImplicitCollections(Map<Class<?>,String> implicitCollections)
Specify implicit collection fields, as a Map consisting of Class instances
mapped to comma separated collection field names. |
void |
setMode(int mode)
Set the XStream mode. |
void |
setOmittedFields(Map<Class<?>,String> omittedFields)
Specify omitted fields, as a Map consisting of Class instances
mapped to comma separated field names. |
void |
setStreamDriver(com.thoughtworks.xstream.io.HierarchicalStreamDriver streamDriver)
Set the XStream hierarchical stream driver to be used with stream readers and writers. |
void |
setSupportedClasses(Class[] supportedClasses)
Set the classes supported by this marshaller. |
void |
setUseAttributeFor(Map<?,?> attributes)
Set the types to use XML attributes for. |
void |
setUseAttributeForTypes(Class[] types)
Set types to use XML attributes for. |
boolean |
supports(Class clazz)
Indicates whether this marshaller can marshal instances of the supplied type. |
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. |
| Methods inherited from class org.springframework.oxm.support.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 |
| Field Detail |
|---|
public static final String DEFAULT_ENCODING
| Constructor Detail |
|---|
public XStreamMarshaller()
| Method Detail |
|---|
public com.thoughtworks.xstream.XStream getXStream()
public void setMode(int mode)
XStream.XPATH_REFERENCES,
XStream.ID_REFERENCES,
XStream.NO_REFERENCESpublic void setConverters(com.thoughtworks.xstream.converters.ConverterMatcher[] converters)
Converters or SingleValueConverters to be registered
with the XStream instance.
Converter,
SingleValueConverter
public void setAliases(Map<String,?> aliases)
throws ClassNotFoundException
Class instances, or String class names.
ClassNotFoundExceptionXStream.alias(String, Class)
public void setAliasesByType(Map<String,?> aliases)
throws ClassNotFoundException
Class instances, or String class names.
ClassNotFoundExceptionXStream.aliasType(String, Class)
public void setFieldAliases(Map<String,String> aliases)
throws ClassNotFoundException,
NoSuchFieldException
aliases -
ClassNotFoundException
NoSuchFieldExceptionXStream.aliasField(String, Class, String)public void setUseAttributeForTypes(Class[] types)
XStream.useAttributeFor(Class)public void setUseAttributeFor(Map<?,?> attributes)
<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.
public void setImplicitCollections(Map<Class<?>,String> implicitCollections)
Class instances
mapped to comma separated collection field names.
XStream.addImplicitCollection(Class, String)public void setOmittedFields(Map<Class<?>,String> omittedFields)
Class instances
mapped to comma separated field names.
XStream.omitField(Class, String)public void setAnnotatedClass(Class<?> annotatedClass)
XStream.processAnnotations(Class)public void setAnnotatedClasses(Class<?>[] annotatedClasses)
XStream.processAnnotations(Class[])public void setAutodetectAnnotations(boolean autodetectAnnotations)
Note that auto-detection implies that the XStream is configured while it is processing the XML streams, and thus introduces a potential concurrency problem.
XStream.autodetectAnnotations(boolean)public void setStreamDriver(com.thoughtworks.xstream.io.HierarchicalStreamDriver streamDriver)
public void setEncoding(String encoding)
DEFAULT_ENCODINGpublic void setSupportedClasses(Class[] supportedClasses)
If this property is empty (the default), all classes are supported.
supports(Class)public void setBeanClassLoader(ClassLoader classLoader)
BeanClassLoaderAwareclass 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.
setBeanClassLoader in interface BeanClassLoaderAwareclassLoader - the owning class loader; may be null in
which case a default ClassLoader must be used, for example
the ClassLoader obtained via
ClassUtils.getDefaultClassLoader()
public final void afterPropertiesSet()
throws Exception
InitializingBeanThis 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.
afterPropertiesSet in interface InitializingBeanException - in the event of misconfiguration (such
as failure to set an essential property) or if initialization fails.protected void customizeXStream(com.thoughtworks.xstream.XStream xstream)
XStream.
The default implementation is empty.
xstream - the XStream instancepublic boolean supports(Class clazz)
Marshaller
supports in interface Marshallersupports in interface Unmarshallerclazz - 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 otherwise
protected void marshalDomNode(Object graph,
Node node)
throws XmlMappingException
AbstractMarshallerNode.
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 AbstractMarshallergraph - 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 void marshalXmlEventWriter(Object graph,
XMLEventWriter eventWriter)
throws XmlMappingException
AbstractMarshallerXMLEventWriter.
marshalXmlEventWriter in class AbstractMarshallergraph - the root of the object graph to marshaleventWriter - the XMLEventWriter to write to
XmlMappingException - if the given object cannot be marshalled to the DOM node
protected void marshalXmlStreamWriter(Object graph,
XMLStreamWriter streamWriter)
throws XmlMappingException
AbstractMarshallerXMLStreamWriter.
marshalXmlStreamWriter in class AbstractMarshallergraph - the root of the object graph to marshalstreamWriter - the XMLStreamWriter to write to
XmlMappingException - if the given object cannot be marshalled to the DOM node
protected void marshalOutputStream(Object graph,
OutputStream outputStream)
throws XmlMappingException,
IOException
AbstractMarshallerOutputStream.
marshalOutputStream in class AbstractMarshallergraph - 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 occurs
protected void marshalSaxHandlers(Object graph,
ContentHandler contentHandler,
LexicalHandler lexicalHandler)
throws XmlMappingException
AbstractMarshallerContentHandler.
marshalSaxHandlers in class AbstractMarshallergraph - the root of the object graph to marshalcontentHandler - the SAX ContentHandlerlexicalHandler - the SAX2 LexicalHandler. Can be null.
XmlMappingException - if the given object cannot be marshalled to the handlers
protected void marshalWriter(Object graph,
Writer writer)
throws XmlMappingException,
IOException
AbstractMarshallerWriter.
marshalWriter in class AbstractMarshallergraph - 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 occurs
protected Object unmarshalDomNode(Node node)
throws XmlMappingException
AbstractMarshallerNode.
unmarshalDomNode in class AbstractMarshallernode - the DOM node that contains the objects to be unmarshalled
XmlMappingException - if the given DOM node cannot be mapped to an object
protected Object unmarshalXmlEventReader(XMLEventReader eventReader)
throws XmlMappingException
AbstractMarshallerXMLEventReader.
unmarshalXmlEventReader in class AbstractMarshallereventReader - the XMLEventReader to read from
XmlMappingException - if the given event reader cannot be converted to an object
protected Object unmarshalXmlStreamReader(XMLStreamReader streamReader)
throws XmlMappingException
AbstractMarshallerXMLStreamReader.
unmarshalXmlStreamReader in class AbstractMarshallerstreamReader - the XMLStreamReader to read from
XmlMappingException - if the given stream reader cannot be converted to an object
protected Object unmarshalInputStream(InputStream inputStream)
throws XmlMappingException,
IOException
AbstractMarshallerInputStream.
unmarshalInputStream in class AbstractMarshallerinputStream - the InputStreamStream to read from
XmlMappingException - if the given stream cannot be converted to an object
IOException - if an I/O exception occurs
protected Object unmarshalReader(Reader reader)
throws XmlMappingException,
IOException
AbstractMarshallerReader.
unmarshalReader in class AbstractMarshallerreader - the Reader to read from
XmlMappingException - if the given reader cannot be converted to an object
IOException - if an I/O exception occurs
protected Object unmarshalSaxReader(XMLReader xmlReader,
InputSource inputSource)
throws XmlMappingException,
IOException
AbstractMarshallerXMLReader
and InputSource.
unmarshalSaxReader in class AbstractMarshallerxmlReader - 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 occurs
protected XmlMappingException convertXStreamException(Exception ex,
boolean marshalling)
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.
ex - XStream exception that occuredmarshalling - indicates whether the exception occurs during marshalling (true),
or unmarshalling (false)
XmlMappingException
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||