XSHelper (stdlib 8.2.2 API)

java.lang.Object
- com.thoughtworks.xstream.XStream
- - com.peterphi.std.xstream.XSHelper

```
public class XSHelper
extends com.thoughtworks.xstream.XStream
```
A light abstraction layer over XStream, allowing the user to ignore some implementation-specific aspects

Nested Class Summary
- Nested classes/interfaces inherited from class com.thoughtworks.xstream.XStream
  com.thoughtworks.xstream.XStream.InitializationException

Field Summary

Fields
Modifier and Type Field and Description

boolean hideErrors
- Fields inherited from class com.thoughtworks.xstream.XStream
  ID_REFERENCES, NO_REFERENCES, PRIORITY_LOW, PRIORITY_NORMAL, PRIORITY_VERY_HIGH, PRIORITY_VERY_LOW, SINGLE_NODE_XPATH_ABSOLUTE_REFERENCES, SINGLE_NODE_XPATH_RELATIVE_REFERENCES, XPATH_ABSOLUTE_REFERENCES, XPATH_RELATIVE_REFERENCES

Fields
Modifier and Type	Field and Description
`boolean`	`hideErrors`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T> T`	`clone(T obj)` Performs a deep clone using serialisation; this is equivalent to `(MyType) this.deserialise(this.serialise(obj))` Be careful when using this to clone classes you do not own: they may refer to complex/system datastructures with unintended consequences
`static XSHelper`	`create()` Creates a new instance of the XSHelper class, using the most efficient underlying implementations possible
`static XSHelper`	`create(com.thoughtworks.xstream.io.HierarchicalStreamDriver drv)`
`<T> T`	`deserialise(File f)` Deserialises an Object from a File.
`<T> T`	`deserialise(InputStream stream)` Deserialise an XML document from an InputStream into an Object
`<T> T`	`deserialise(Reader stream)` Deserialise an XML document from an InputStream into an Object
`<T> T`	`deserialise(String xml)` Deserialises a String into an Object
`XSHelper`	`disableGraph()`
`XSHelper`	`enableGraph()`
`int`	`getMode()` Returns the current graphing mode
`boolean`	`getPrettyPrint()`
`static boolean`	`hasXPP3()` Determines if XPP3 is available, caching the results of the first query
`void`	`parseAnnotations(Class<?>... classes)`
`BooleanMessage`	`serialise(File f, Object o)` Serialises an object into an OutputStream
`String`	`serialise(Object o)` Serialises an object into a String
`BooleanMessage`	`serialise(OutputStream os, Object o)` Serialises an object into an OutputStream
`BooleanMessage`	`serialise(Writer os, Object o)` Serialises an object into an OutputStream
`void`	`setMode(int mode)` Sets the current graphing mode, logging its value for use in this class. Possible values are: `XStream.NO_REFERENCES, XStream.XPATH_RELATIVE_REFERENCES, XStream.XPATH_ABSOLUTE_REFERENCES, XStream.ID_REFERENCES`
`void`	`setNoObjectGraph(boolean disable)`
`XSHelper`	`setPrettyPrint(boolean value)` Enables/Disables pretty printing (indented XML output)

Methods inherited from class com.thoughtworks.xstream.XStream
addDefaultImplementation, addImmutableType, addImplicitArray, addImplicitArray, addImplicitArray, addImplicitCollection, addImplicitCollection, addImplicitCollection, addImplicitMap, addImplicitMap, alias, alias, aliasAttribute, aliasAttribute, aliasField, aliasPackage, aliasSystemAttribute, aliasType, autodetectAnnotations, createObjectInputStream, createObjectInputStream, createObjectInputStream, createObjectOutputStream, createObjectOutputStream, createObjectOutputStream, createObjectOutputStream, createObjectOutputStream, createObjectOutputStream, fromXML, fromXML, fromXML, fromXML, fromXML, fromXML, fromXML, fromXML, fromXML, fromXML, getClassLoader, getConverterLookup, getMapper, getReflectionProvider, marshal, marshal, newDataHolder, omitField, processAnnotations, processAnnotations, registerConverter, registerConverter, registerConverter, registerConverter, registerLocalConverter, registerLocalConverter, setClassLoader, setMarshallingStrategy, setupAliases, setupConverters, setupDefaultImplementations, setupImmutableTypes, toXML, toXML, toXML, unmarshal, unmarshal, unmarshal, useAttributeFor, useAttributeFor, useAttributeFor, useXStream11XmlFriendlyMapper, wrapMapper

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

- Field Detail
  - hideErrors
```
public boolean hideErrors
```
- Method Detail
  - hasXPP3
```
public static boolean hasXPP3()
```
    Determines if XPP3 is available, caching the results of the first query
    
    Returns:
    
    True if XPP3 is available, otherwise false
  - create
```
public static XSHelper create()
```
    Creates a new instance of the XSHelper class, using the most efficient underlying implementations possible
    
    Returns:
  - create
```
public static XSHelper create(com.thoughtworks.xstream.io.HierarchicalStreamDriver drv)
```
  - parseAnnotations
```
public void parseAnnotations(Class<?>... classes)
```
  - serialise
```
public BooleanMessage serialise(OutputStream os,
                                Object o)
```
    Serialises an object into an OutputStream
    
    Parameters:
    
    os - The OutputStream to use
    
    o - The object to serialise
    
    Returns:
    
    True if the serialisation succeeded
  - serialise
```
public BooleanMessage serialise(Writer os,
                                Object o)
```
    Serialises an object into an OutputStream
    
    Parameters:
    
    os - The Writer to use
    
    o - The object to serialise
    
    Returns:
    
    True if the serialisation succeeded
  - serialise
```
public BooleanMessage serialise(File f,
                                Object o)
```
    Serialises an object into an OutputStream
    
    Parameters:
    
    os - The OutputStream to use
    
    o - The object to serialise
    
    Returns:
    
    True if the serialisation succeeded
  - serialise
```
public String serialise(Object o)
```
    Serialises an object into a String
    
    Parameters:
    
    o - The object to serialise
    
    Returns:
    
    The serialised object, or null if an exception occurred. Any exceptions are logged.
  - deserialise
```
public <T> T deserialise(File f)
```
    Deserialises an Object from a File.
    
    Parameters:
    
    f - The file to deserialise
    
    Returns:
    
    The deserialised object, or null if an exception occurred. All exceptions are logged.
  - deserialise
```
public <T> T deserialise(String xml)
```
    Deserialises a String 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 <T> T deserialise(InputStream stream)
```
    Deserialise an XML document from an InputStream into an Object
    
    Parameters:
    
    stream - The InputStream
    
    Returns:
    
    The Object (or null if an exception occurred). All exceptions are logged
  - deserialise
```
public <T> T deserialise(Reader stream)
```
    Deserialise an XML document from an InputStream into an Object
    
    Parameters:
    
    stream - The Reader
    
    Returns:
    
    The Object (or null if an exception occurred). All exceptions are logged
  - clone
```
public <T> T clone(T obj)
```
    Performs a deep clone using serialisation; this is equivalent to (MyType) this.deserialise(this.serialise(obj))
    Be careful when using this to clone classes you do not own: they may refer to complex/system datastructures with unintended consequences
    
    Type Parameters:
    
    T - some class
    
    Parameters:
    
    obj - some object
    
    Returns:
    
    a very deep clone of that object
  - setNoObjectGraph
```
public void setNoObjectGraph(boolean disable)
```
  - enableGraph
```
public XSHelper enableGraph()
```
    Returns:
    
    a copy of this (for chaining)
  - disableGraph
```
public XSHelper disableGraph()
```
    Returns:
    
    a copy of this (for chaining)
  - setMode
```
public void setMode(int mode)
```
    Sets the current graphing mode, logging its value for use in this class.
    Possible values are: XStream.NO_REFERENCES, XStream.XPATH_RELATIVE_REFERENCES, XStream.XPATH_ABSOLUTE_REFERENCES, XStream.ID_REFERENCES
    
    Overrides:
    
    setMode in class com.thoughtworks.xstream.XStream
  - getPrettyPrint
```
public boolean getPrettyPrint()
```
  - setPrettyPrint
```
public XSHelper setPrettyPrint(boolean value)
```
    Enables/Disables pretty printing (indented XML output)
    
    Parameters:
    
    value - true for pretty printing, false for compact output
    
    Returns:
    
    a copy of this (for chaining)
  - getMode
```
public int getMode()
```
    Returns the current graphing mode
    
    Returns:

Class XSHelper

Nested Class Summary

Nested classes/interfaces inherited from class com.thoughtworks.xstream.XStream

Field Summary

Fields inherited from class com.thoughtworks.xstream.XStream

Method Summary

Methods inherited from class com.thoughtworks.xstream.XStream

Methods inherited from class java.lang.Object

Field Detail

hideErrors

Method Detail

hasXPP3

create

create

parseAnnotations

serialise

serialise

serialise

serialise

deserialise

deserialise

deserialise

deserialise

clone

setNoObjectGraph

enableGraph

disableGraph

setMode

getPrettyPrint

setPrettyPrint

getMode