org.axonframework.serialization.xml

Class XStreamSerializer.Builder

java.lang.Object

org.axonframework.serialization.AbstractXStreamSerializer.Builder

org.axonframework.serialization.xml.XStreamSerializer.Builder

Enclosing class:

XStreamSerializer

public static class XStreamSerializer.Builder
extends AbstractXStreamSerializer.Builder

Builder class to instantiate a XStreamSerializer.

The XStream is defaulted to a XStream.XStream(HierarchicalStreamDriver) call, providing a CompactDriver, the Charset is defaulted to a Charset.forName(String) using the UTF-8 character set, the RevisionResolver defaults to an AnnotationRevisionResolver and the Converter defaults to a ChainingConverter.

Upon instantiation, several defaults aliases are added to the XStream instance, for example for the GenericDomainEventMessage, the GenericCommandMessage and the MetaData objects among others. Additionally, a MetaData Converter is registered too. Lastly, if the provided Converter instance is of type ChainingConverter, then the XStreamSerializer.registerConverters(ChainingConverter) function will be called. This will register the Dom4JToByteArrayConverter, InputStreamToDom4jConverter, XomToStringConverter and InputStreamToXomConverter to the Converter chain.

Method Summary

Modifier and Type	Method and Description
XStreamSerializer	build() Initializes a XStreamSerializer as specified through this Builder.
XStreamSerializer.Builder	charset(Charset charset) Sets the Charset used for the in- and output streams required by XStream for the to and from xml function calls.
XStreamSerializer.Builder	converter(Converter converter) Sets the Converter used as a converter factory providing converter instances utilized by upcasters to convert between different content types.
XStreamSerializer.Builder	revisionResolver(RevisionResolver revisionResolver) Sets the RevisionResolver used to resolve the revision from an object to be serialized.
XStreamSerializer.Builder	xStream(com.thoughtworks.xstream.XStream xStream) Sets the XStream used to perform the serialization of objects to XML, and vice versa.

Methods inherited from class org.axonframework.serialization.AbstractXStreamSerializer.Builder

validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

xStream

public XStreamSerializer.Builder xStream(com.thoughtworks.xstream.XStream xStream)

Sets the XStream used to perform the serialization of objects to XML, and vice versa. Defaults to a XStream.XStream(HierarchicalStreamDriver) call, providing the CompactDriver.

Overrides:

xStream in class AbstractXStreamSerializer.Builder

Parameters:

xStream - the XStream used to perform the serialization of objects to XML, and vice versa

Returns:

the current Builder instance, for fluent interfacing

charset

public XStreamSerializer.Builder charset(Charset charset)

Description copied from class: AbstractXStreamSerializer.Builder

Sets the Charset used for the in- and output streams required by XStream for the to and from xml function calls. Defaults to a Charset.forName(String) using the UTF-8 character set.

Overrides:

charset in class AbstractXStreamSerializer.Builder

Parameters:

charset - the Charset used for the in- and output streams required by XStream

Returns:

the current Builder instance, for fluent interfacing

revisionResolver

public XStreamSerializer.Builder revisionResolver(RevisionResolver revisionResolver)

Description copied from class: AbstractXStreamSerializer.Builder

Sets the RevisionResolver used to resolve the revision from an object to be serialized. Defaults to an AnnotationRevisionResolver which resolves the revision based on the contents of the Revision annotation on the serialized classes.

Overrides:

revisionResolver in class AbstractXStreamSerializer.Builder

Parameters:

revisionResolver - a RevisionResolver used to resolve the revision from an object to be serialized

Returns:

the current Builder instance, for fluent interfacing

converter

public XStreamSerializer.Builder converter(Converter converter)

Description copied from class: AbstractXStreamSerializer.Builder

Sets the Converter used as a converter factory providing converter instances utilized by upcasters to convert between different content types. Defaults to a ChainingConverter.

Overrides:

converter in class AbstractXStreamSerializer.Builder

Parameters:

converter - a Converter used as a converter factory providing converter instances utilized by upcasters to convert between different content types

Returns:

the current Builder instance, for fluent interfacing

build

public XStreamSerializer build()

Initializes a XStreamSerializer as specified through this Builder.

Returns:

a XStreamSerializer as specified through this Builder