org.openmrs.serialization

Class SimpleXStreamSerializer

java.lang.Object

org.openmrs.serialization.SimpleXStreamSerializer

All Implemented Interfaces:

OpenmrsSerializer

public class SimpleXStreamSerializer
extends java.lang.Object
implements OpenmrsSerializer

This serializer uses the xstream library to serialize and deserialize objects.
All classes are automatically aliased. So a serialization of the Patient class will not be: <org.openmrs.Patient ...> <element ... </org.openmrs.Patient> but instead will be: <patient ...> <element ... </patient>

Field Summary

Fields

Modifier and Type	Field and Description
com.thoughtworks.xstream.XStream	xstream

Constructor Summary

Constructors

Constructor and Description
SimpleXStreamSerializer() Default Constructor
SimpleXStreamSerializer(com.thoughtworks.xstream.XStream customXstream) Constructor that takes a custom XStream object

Method Summary

Modifier and Type	Method and Description
<T> T	deserialize(java.lang.String serializedObject, java.lang.Class<? extends T> clazz) Deserialize the given string into a full object
com.thoughtworks.xstream.XStream	getXstream() Expose the xstream object, so that module can config with xstream as need
java.lang.String	serialize(java.lang.Object o) Turn the current object into an identifying string that can be retrieved later

Methods inherited from class java.lang.Object

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

Field Detail

xstream

public com.thoughtworks.xstream.XStream xstream

Constructor Detail

SimpleXStreamSerializer

public SimpleXStreamSerializer()
                        throws SerializationException

Default Constructor

Throws:

SerializationException

SimpleXStreamSerializer

public SimpleXStreamSerializer(com.thoughtworks.xstream.XStream customXstream)
                        throws SerializationException

Constructor that takes a custom XStream object

Parameters:

customXstream -

Throws:

SerializationException

Method Detail

getXstream

public com.thoughtworks.xstream.XStream getXstream()

Expose the xstream object, so that module can config with xstream as need

Returns:

xstream can be configed by module

serialize

public java.lang.String serialize(java.lang.Object o)
                           throws SerializationException

Description copied from interface: OpenmrsSerializer

Turn the current object into an identifying string that can be retrieved later

Specified by:

serialize in interface OpenmrsSerializer

Parameters:

o - - the object to serialize

Returns:

String representing this object

Throws:

SerializationException

See Also:

OpenmrsSerializer.serialize(java.lang.Object)

deserialize

public <T> T deserialize(java.lang.String serializedObject,
                         java.lang.Class<? extends T> clazz)
                  throws SerializationException

Description copied from interface: OpenmrsSerializer

Deserialize the given string into a full object

Specified by:

deserialize in interface OpenmrsSerializer

Parameters:

serializedObject - - String to deserialize

clazz - - The class to deserialize the Object into

Returns:

hydrated object of the appropriate type

Throws:

SerializationException

See Also:

OpenmrsSerializer.deserialize(String, Class)