XStreamHelper (stdlib 8.2.2 API)

java.lang.Object
- com.peterphi.std.xstream.XStreamHelper

```
public class XStreamHelper
extends Object
```
Title: XStream Helper Class

Description: Provides some static helper functions for dealing with serialisation

Copyright: Copyright (c) 2006-2009

Version:

$Revision$

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`addAlias(String alias, Class aliasedClass)` Adds an alias to the internally cached XStream instance
`static void`	`addAlias(String alias, Class aliasedClass, Class defaultImplementation)` Adds an alias (including a default implementation) to the internally cached XStream instance
`static <T> T`	`clone(T obj)` Performs a deep clone.
`static XSHelper`	`create()`
`static Object`	`deserialise(File f)` Deserialises an Object from a File
`static Object`	`deserialise(InputStream stream)` Deserialises an InputStream into an Object using the default XStream instance
`static Object`	`deserialise(String xml)` Uses the default XStream instance to deserialise an XML document into an Object
`static boolean`	`getCacheXstream()` Determines whether XStream instance caching is currently enabled
`static boolean`	`getNoObjectGraph()` Returns the current state of object graph serialisation
`static boolean`	`getRegisterStandardTypeConverters()` Determines whether standard type converters have been enabled
`static void`	`registerConverter(com.thoughtworks.xstream.converters.Converter converter)` Registers a Converter with the internal XStream instance
`static BooleanMessage`	`serialise(File f, Object o)` Uses the default XStream instance to serialise an object to a File
`static String`	`serialise(Object o)` Uses the default XStream instance to serialise an object to a String
`static BooleanMessage`	`serialise(OutputStream os, Object o)` Uses the default XStream instance to serialise an object to an OutputStream
`static void`	`setCacheXstream(boolean val)` Enables or disables the caching of XStream instances internally When changed any cached xstream instance will be discarded
`static void`	`setNoObjectGraph(boolean val)` Enables or disabled object graph serialisation (whether the same object is duplicated or linked in the output XML document)
`static void`	`setRegisterStandardTypeConverters(boolean val)` Sets whether the standard type converters (eg.
`static void`	`setXs(XSHelper xs)` Sets the internal XStream instance to use (provided caching is enabled)
`static Class`	`typeOf(com.thoughtworks.xstream.XStream xs, String s)` Helper method to allow easy testing of the type of a serialised type.
`static void`	`useAttributeFor(Class<? extends Object> definedIn, String fieldName)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - setNoObjectGraph
```
public static void setNoObjectGraph(boolean val)
```
    Enables or disabled object graph serialisation (whether the same object is duplicated or linked in the output XML document)
    
    Parameters:
    
    val - True to disable object graph serialisation, otherwise false to enable it
  - getNoObjectGraph
```
public static boolean getNoObjectGraph()
```
    Returns the current state of object graph serialisation
    
    Returns:
    
    True if object graph serialisation has been disabled, otherwise true if it is enabled
  - setRegisterStandardTypeConverters
```
public static void setRegisterStandardTypeConverters(boolean val)
```
    Sets whether the standard type converters (eg. InetAddressConverter, etc.) should be registered. When changed, any cached xstream instance will be discarded
    
    Parameters:
    
    val - boolean - if true, the typ
  - getRegisterStandardTypeConverters
```
public static boolean getRegisterStandardTypeConverters()
```
    Determines whether standard type converters have been enabled
    
    Returns:
  - setCacheXstream
```
public static void setCacheXstream(boolean val)
```
    Enables or disables the caching of XStream instances internally When changed any cached xstream instance will be discarded
    
    Parameters:
    
    val -
  - getCacheXstream
```
public static boolean getCacheXstream()
```
    Determines whether XStream instance caching is currently enabled
    
    Returns:
  - setXs
```
public static void setXs(XSHelper xs)
```
    Sets the internal XStream instance to use (provided caching is enabled)
    
    Parameters:
    
    xs -
    
    Throws:
    
    Error - if XStream caching is not enabled
  - create
```
public static XSHelper create()
```
  - useAttributeFor
```
public static void useAttributeFor(Class<? extends Object> definedIn,
                                   String fieldName)
```
  - addAlias
```
public static void addAlias(String alias,
                            Class aliasedClass)
```
    Adds an alias to the internally cached XStream instance
    
    Parameters:
    
    alias - The alias name
    
    aliasedClass - The class to be aliased
    
    Throws:
    
    Error - when XStream caching is disabled
  - addAlias
```
public static void addAlias(String alias,
                            Class aliasedClass,
                            Class defaultImplementation)
```
    Adds an alias (including a default implementation) to the internally cached XStream instance
    
    Parameters:
    
    alias - The alias name
    
    aliasedClass - The class to be aliased
    
    defaultImplementation - The default implementation
    
    Throws:
    
    Error - when XStream caching is disabled
  - registerConverter
```
public static void registerConverter(com.thoughtworks.xstream.converters.Converter converter)
```
    Registers a Converter with the internal XStream instance
    
    Parameters:
    
    converter - The converter to register
    
    Throws:
    
    Error - when XStream caching is disabled
  - serialise
```
public static String serialise(Object o)
```
    Uses the default XStream instance to serialise an object to a String
    
    Parameters:
    
    o - The object to serialise
    
    Returns:
    
    The serialised object or null if an exception occurred. All exceptions are logged
  - serialise
```
public static BooleanMessage serialise(File f,
                                       Object o)
```
    Uses the default XStream instance to serialise an object to a File
    
    Parameters:
    
    f - The file to serialise to
    
    o - The object to serialise
    
    Returns:
    
    True if the serialisation succeeded, otherwise false and an error message
  - serialise
```
public static BooleanMessage serialise(OutputStream os,
                                       Object o)
```
    Uses the default XStream instance to serialise an object to an OutputStream
    
    Parameters:
    
    os - the stream to output to
    
    o - The object to serialise
    
    Returns:
    
    True if the serialisation succeeded, otherwise false and an error message
  - deserialise
```
public static Object deserialise(File f)
```
    Deserialises an Object from a File
    
    Parameters:
    
    f - The file to deserialise
    
    Returns:
    
    The object (or null if the deserialisation failed)
  - deserialise
```
public static Object deserialise(String xml)
```
    Uses the default XStream instance to deserialise an XML document into an Object
    
    Parameters:
    
    xml - The XML document to deserialise
    
    Returns:
    
    The object (or null if an exception occurred). All exceptions are logged.
  - deserialise
```
public static Object deserialise(InputStream stream)
```
    Deserialises an InputStream into an Object using the default XStream instance
    
    Parameters:
    
    stream - The InputStream
    
    Returns:
    
    The Object (or null if an exception occurred). All exceptions are logged.
  - typeOf
```
public static Class typeOf(com.thoughtworks.xstream.XStream xs,
                           String s)
```
    Helper method to allow easy testing of the type of a serialised type. It's not recommended that you use this method
    
    Parameters:
    
    xs - the XStream instance to use
    
    s - The string representing the serialised object
    
    Returns:
  - clone
```
public static <T> T clone(T obj)
```
    Performs a deep clone. See XSHelper.clone
    
    Type Parameters:
    
    T -
    
    Parameters:
    
    obj -
    
    Returns:

Class XStreamHelper

Method Summary

Methods inherited from class java.lang.Object

Method Detail

setNoObjectGraph

getNoObjectGraph

setRegisterStandardTypeConverters

getRegisterStandardTypeConverters

setCacheXstream

getCacheXstream

setXs

create

useAttributeFor

addAlias

addAlias

registerConverter

serialise

serialise

serialise

deserialise

deserialise

deserialise

typeOf

clone