com.adaptris.core

Class AdapterXStreamMarshallerFactory

java.lang.Object

com.adaptris.core.AdapterMarshallerFactory

com.adaptris.core.AdapterXStreamMarshallerFactory

public class AdapterXStreamMarshallerFactory
extends AdapterMarshallerFactory

XStream Marshaller Specific Factory class.

Nested Class Summary

Nested classes/interfaces inherited from class com.adaptris.core.AdapterMarshallerFactory

AdapterMarshallerFactory.MarshallingOutput

Field Summary

Fields

Modifier and Type	Field and Description
protected static AdapterXStreamMarshallerFactory	instance
static boolean	XSTREAM_DBG Whether not extended debugging is emitted; defaults to false unless explicitly set via either the system property interlok.xstream.debug or adp.xtream.debug.
static boolean	XSTREAM_JDK_STAX_ONLY Whether or not we force XStream to use the JVMs internal Stax implementation; this defaults to 'true' unless explicitly set via the system property interlok.xstream.jdk.stax.

Method Summary

Modifier and Type	Method and Description
protected com.thoughtworks.xstream.XStream	configureXStream(com.thoughtworks.xstream.XStream xstream, AdapterMarshallerFactory.MarshallingOutput outputMode) Configures the given XStream object. It is expected that the Factory has been initialised and that all of the configuration settings have been processed and stored already.
AdaptrisMarshaller	createMarshaller()
AdaptrisMarshaller	createMarshaller(AdapterMarshallerFactory.MarshallingOutput outputType)
com.thoughtworks.xstream.XStream	createXStream() Public method that returns a configure XStream object instance read for use
com.thoughtworks.xstream.XStream	createXStream(AdapterMarshallerFactory.MarshallingOutput outputType) Public method that returns a configure XStream object instance read for use configured for the given form of output.
protected com.thoughtworks.xstream.XStream	createXStreamInstance(AdapterMarshallerFactory.MarshallingOutput outputMode) Creates the XStream object instance
static AdapterXStreamMarshallerFactory	getInstance()
protected static void	readXStreamConfigProperties() Reads in and stores all of the xstream configuration items from various resources

Methods inherited from class com.adaptris.core.AdapterMarshallerFactory

createMarshaller

Methods inherited from class java.lang.Object

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

Field Detail

XSTREAM_DBG

public static final transient boolean XSTREAM_DBG

Whether not extended debugging is emitted; defaults to false unless explicitly set via either the system property interlok.xstream.debug or adp.xtream.debug.

XSTREAM_JDK_STAX_ONLY

public static final transient boolean XSTREAM_JDK_STAX_ONLY

Whether or not we force XStream to use the JVMs internal Stax implementation; this defaults to 'true' unless explicitly set via the system property interlok.xstream.jdk.stax.

instance

protected static AdapterXStreamMarshallerFactory instance

Method Detail

getInstance

public static AdapterXStreamMarshallerFactory getInstance()

createMarshaller

public AdaptrisMarshaller createMarshaller()
                                    throws CoreException

Specified by:

createMarshaller in class AdapterMarshallerFactory

Throws:

CoreException

createMarshaller

public AdaptrisMarshaller createMarshaller(AdapterMarshallerFactory.MarshallingOutput outputType)
                                    throws CoreException

Specified by:

createMarshaller in class AdapterMarshallerFactory

Throws:

CoreException

readXStreamConfigProperties

protected static void readXStreamConfigProperties()

Reads in and stores all of the xstream configuration items from various resources

createXStreamInstance

protected com.thoughtworks.xstream.XStream createXStreamInstance(AdapterMarshallerFactory.MarshallingOutput outputMode)

Creates the XStream object instance

Parameters:

outputMode - - The type of output to generate ie JSON/XML

Returns:

- newly created instance

createXStream

public com.thoughtworks.xstream.XStream createXStream()

Public method that returns a configure XStream object instance read for use

Returns:

Xstream configured for XML output

createXStream

public com.thoughtworks.xstream.XStream createXStream(AdapterMarshallerFactory.MarshallingOutput outputType)

Public method that returns a configure XStream object instance read for use configured for the given form of output.

Parameters:

outputType - - Type of output to configure XStream for ie JSON or XML

Returns:

Xstream configured for the specified output type

configureXStream

protected com.thoughtworks.xstream.XStream configureXStream(com.thoughtworks.xstream.XStream xstream,
                                                            AdapterMarshallerFactory.MarshallingOutput outputMode)

Configures the given XStream object.
It is expected that the Factory has been initialised and that all of the configuration settings have been processed and stored already.

Parameters:

xstream - - XStream instance to configure

outputMode - - The output type to configure XStream for