Class XStream
Example
XStream xstream = new XStream(); String xml = xstream.toXML(myObject); // serialize to XML Object myObject2 = xstream.fromXML(xml); // deserialize from XML
Aliasing classes
To create shorter XML, you can specify aliases for classes using the alias()
method. For example, you
can shorten all occurrences of element <com.blah.MyThing>
to <my-thing>
by
registering an alias for the class.
xstream.alias("my-thing", MyThing.class);
Converters
XStream contains a map of Converter
instances, each of which acts as a
strategy for converting a particular type of class to XML and back again. Out of the box, XStream contains converters
for most basic types (String, Date, int, boolean, etc) and collections (Map, List, Set, Properties, etc). For other
objects reflection is used to serialize each field recursively.
Extra converters can be registered using the registerConverter()
method. Some non-standard converters
are supplied in the com.thoughtworks.xstream.converters.extended
package and you can create your own by
implementing the Converter
interface.
Example
xstream.registerConverter(new SqlTimestampConverter()); xstream.registerConverter(new DynamicProxyConverter());
The converters can be registered with an explicit priority. By default they are registered with
XStream.PRIORITY_NORMAL. Converters of same priority will be used in the reverse sequence they have been registered.
The default converter, i.e. the converter which will be used if no other registered converter is suitable, can be
registered with priority XStream.PRIORITY_VERY_LOW. XStream uses by default the
ReflectionConverter
as the fallback converter.
Example
xstream.registerConverter(new CustomDefaultConverter(), XStream.PRIORITY_VERY_LOW);
Object graphs
XStream has support for object graphs; a deserialized object graph will keep references intact, including circular references.
XStream can signify references in XML using either relative/absolute XPath or IDs. The mode can be changed using
setMode()
:
xstream.setMode(XStream.XPATH_RELATIVE_REFERENCES); |
(Default) Uses XPath relative references to signify duplicate references. This produces XML with the least clutter. |
xstream.setMode(XStream.XPATH_ABSOLUTE_REFERENCES); |
Uses XPath absolute references to signify duplicate references. This produces XML with the least clutter. |
xstream.setMode(XStream.SINGLE_NODE_XPATH_RELATIVE_REFERENCES); |
Uses XPath relative references to signify duplicate references. The XPath expression ensures that a single node only is selected always. |
xstream.setMode(XStream.SINGLE_NODE_XPATH_ABSOLUTE_REFERENCES); |
Uses XPath absolute references to signify duplicate references. The XPath expression ensures that a single node only is selected always. |
xstream.setMode(XStream.ID_REFERENCES); |
Uses ID references to signify duplicate references. In some scenarios, such as when using hand-written XML, this is easier to work with. |
xstream.setMode(XStream.NO_REFERENCES); |
This disables object graph support and treats the object structure like a tree. Duplicate references are treated as two separate objects and circular references cause an exception. This is slightly faster and uses less memory than the other two modes. |
Thread safety
The XStream instance is thread-safe. That is, once the XStream instance has been created and configured, it may be shared across multiple threads allowing objects to be serialized/deserialized concurrently. Note, that this only applies if annotations are not auto-detected on-the-fly.
Implicit collections
To avoid the need for special tags for collections, you can define implicit collections using one of the
addImplicitCollection
methods.
-
Nested Class Summary
Nested Classes -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final String
private AnnotationConfiguration
private AttributeAliasingMapper
private AttributeMapper
private ClassAliasingMapper
private ClassLoaderReference
static final String
static final String
private int
private ConverterLookup
private ConverterRegistry
private DefaultImplementationsMapper
private ElementIgnoringMapper
private FieldAliasingMapper
private HierarchicalStreamDriver
static final int
private static final Pattern
private ImmutableTypesMapper
private ImplicitCollectionMapper
private LocalConversionMapper
private Mapper
private MarshallingStrategy
static final int
private PackageAliasingMapper
static final int
static final int
static final int
static final int
private ReflectionProvider
private SecurityMapper
static final int
static final int
private SystemAttributeAliasingMapper
static final int
static final int
-
Constructor Summary
ConstructorsModifierConstructorDescriptionXStream()
Constructs a default XStream.XStream
(ReflectionProvider reflectionProvider) Constructs an XStream with a specialReflectionProvider
.XStream
(ReflectionProvider reflectionProvider, HierarchicalStreamDriver hierarchicalStreamDriver) Constructs an XStream with a specialHierarchicalStreamDriver
andReflectionProvider
.XStream
(ReflectionProvider reflectionProvider, HierarchicalStreamDriver driver, ClassLoaderReference classLoaderReference) Constructs an XStream with a specialHierarchicalStreamDriver
,ReflectionProvider
and aClassLoaderReference
.XStream
(ReflectionProvider reflectionProvider, HierarchicalStreamDriver driver, ClassLoaderReference classLoaderReference, Mapper mapper) Constructs an XStream with a specialHierarchicalStreamDriver
,ReflectionProvider
, a preparedMapper
chain and theClassLoaderReference
.XStream
(ReflectionProvider reflectionProvider, HierarchicalStreamDriver driver, ClassLoaderReference classLoaderReference, Mapper mapper, ConverterLookup converterLookup, ConverterRegistry converterRegistry) Constructs an XStream with a specialHierarchicalStreamDriver
,ReflectionProvider
, a preparedMapper
chain, theClassLoaderReference
and an ownConverterLookup
andConverterRegistry
.private
XStream
(ReflectionProvider reflectionProvider, HierarchicalStreamDriver driver, ClassLoaderReference classLoader, Mapper mapper, DefaultConverterLookup defaultConverterLookup) XStream
(ReflectionProvider reflectionProvider, HierarchicalStreamDriver driver, ClassLoader classLoader) Deprecated.XStream
(ReflectionProvider reflectionProvider, HierarchicalStreamDriver driver, ClassLoader classLoader, Mapper mapper) Deprecated.XStream
(ReflectionProvider reflectionProvider, HierarchicalStreamDriver driver, ClassLoader classLoader, Mapper mapper, ConverterLookup converterLookup, ConverterRegistry converterRegistry) XStream
(ReflectionProvider reflectionProvider, Mapper mapper, HierarchicalStreamDriver driver) Deprecated.As of 1.3, useXStream(ReflectionProvider, HierarchicalStreamDriver, ClassLoader, Mapper)
insteadXStream
(HierarchicalStreamDriver hierarchicalStreamDriver) Constructs an XStream with a specialHierarchicalStreamDriver
. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addDefaultImplementation
(Class defaultImplementation, Class ofType) Associate a default implementation of a class with an object.void
addImmutableType
(Class type) Deprecated.As of 1.4.9 useaddImmutableType(Class, boolean)
void
addImmutableType
(Class type, boolean isReferenceable) Add immutable types.private void
addImmutableTypeDynamically
(String className, boolean isReferenceable) void
addImplicitArray
(Class ownerType, String fieldName) Adds an implicit array.void
addImplicitArray
(Class ownerType, String fieldName, Class itemType) Adds an implicit array which is used for all items of the given itemType when the array type matches.void
addImplicitArray
(Class ownerType, String fieldName, String itemName) Adds an implicit array which is used for all items of the given element name defined by itemName.void
addImplicitCollection
(Class ownerType, String fieldName) Adds a default implicit collection which is used for any unmapped XML tag.void
addImplicitCollection
(Class ownerType, String fieldName, Class itemType) Adds implicit collection which is used for all items of the given itemType.void
addImplicitCollection
(Class ownerType, String fieldName, String itemFieldName, Class itemType) Adds implicit collection which is used for all items of the given element name defined by itemFieldName.void
addImplicitMap
(Class ownerType, String fieldName, Class itemType, String keyFieldName) Adds an implicit map.void
addImplicitMap
(Class ownerType, String fieldName, String itemName, Class itemType, String keyFieldName) Adds an implicit map.void
addPermission
(TypePermission permission) Add a new security permission.void
Alias a Class to a shorter name to be used in XML elements.void
Alias a Class to a shorter name to be used in XML elements.void
aliasAttribute
(Class definedIn, String attributeName, String alias) Create an alias for an attribute.void
aliasAttribute
(String alias, String attributeName) Create an alias for an attributeprivate void
aliasDynamically
(String alias, String className) void
aliasField
(String alias, Class definedIn, String fieldName) Create an alias for a field name.void
aliasPackage
(String name, String pkgName) Alias a package to a shorter name to be used in XML elements.void
aliasSystemAttribute
(String alias, String systemAttributeName) Create an alias for a system attribute.void
Alias a type to a shorter name to be used in XML elements.void
allowTypeHierarchy
(Class type) Add security permission for a type hierarchy.void
allowTypes
(Class[] types) Add security permission for explicit types.void
allowTypes
(String[] names) Add security permission for explicit types by name.void
allowTypesByRegExp
(String[] regexps) Add security permission for types matching one of the specified regular expressions.void
allowTypesByRegExp
(Pattern[] regexps) Add security permission for types matching one of the specified regular expressions.void
allowTypesByWildcard
(String[] patterns) Add security permission for types matching one of the specified wildcard patterns.void
autodetectAnnotations
(boolean mode) Set the auto-detection mode of the AnnotationMapper.private Mapper
private Mapper
buildMapperDynamically
(String className, Class[] constructorParamTypes, Object[] constructorParamValues) Creates an ObjectInputStream that deserializes a stream of objects from a reader using XStream.createObjectInputStream
(HierarchicalStreamReader reader, DataHolder dataHolder) Creates an ObjectInputStream that deserializes a stream of objects from a reader using XStream.Creates an ObjectInputStream that deserializes a stream of objects from an InputStream using XStream.createObjectInputStream
(Reader xmlReader) Creates an ObjectInputStream that deserializes a stream of objects from a reader using XStream.Creates an ObjectOutputStream that serializes a stream of objects to the writer using XStream.createObjectOutputStream
(HierarchicalStreamWriter writer, String rootNodeName) Creates an ObjectOutputStream that serializes a stream of objects to the writer using XStream.createObjectOutputStream
(HierarchicalStreamWriter writer, String rootNodeName, DataHolder dataHolder) Creates an ObjectOutputStream that serializes a stream of objects to the writer using XStream.Creates an ObjectOutputStream that serializes a stream of objects to the OutputStream using XStream.createObjectOutputStream
(OutputStream out, String rootNodeName) Creates an ObjectOutputStream that serializes a stream of objects to the OutputStream using XStream.createObjectOutputStream
(Writer writer) Creates an ObjectOutputStream that serializes a stream of objects to the writer using XStream.createObjectOutputStream
(Writer writer, String rootNodeName) Creates an ObjectOutputStream that serializes a stream of objects to the writer using XStream.void
denyPermission
(TypePermission permission) Add security permission denying another one.void
denyTypeHierarchy
(Class type) Add security permission forbidding a type hierarchy.private void
denyTypeHierarchyDynamically
(String className) void
Add security permission forbidding explicit types.void
Add security permission forbidding explicit types by name.void
denyTypesByRegExp
(String[] regexps) Add security permission forbidding types matching one of the specified regular expressions.void
denyTypesByRegExp
(Pattern[] regexps) Add security permission forbidding types matching one of the specified regular expressions.void
denyTypesByWildcard
(String[] patterns) Add security permission forbidding types matching one of the specified wildcard patterns.Deserialize an object from a file.Deserialize an object from a file, populating the fields of the given root object instead of instantiating a new one.fromXML
(InputStream input) Deserialize an object from an XML InputStream.fromXML
(InputStream input, Object root) Deserialize an object from an XML InputStream, populating the fields of the given root object instead of instantiating a new one.Deserialize an object from an XML Reader.Deserialize an object from an XML Reader, populating the fields of the given root object instead of instantiating a new one.Deserialize an object from an XML String.Deserialize an object from an XML String, populating the fields of the given root object instead of instantiating a new one.Deserialize an object from a URL.Deserialize an object from a URL, populating the fields of the given root object instead of instantiating a new one.Retrieve the ClassLoader XStream uses to load classes.Retrieve the reference to this instance' ClassLoader.Retrieve theMapper
.Retrieve theReflectionProvider
in use.void
Ignore all unknown elements.void
ignoreUnknownElements
(String pattern) Add pattern for unknown element names to ignore.void
ignoreUnknownElements
(Pattern pattern) Add pattern for unknown element names to ignore.void
marshal
(Object obj, HierarchicalStreamWriter writer) Serialize and object to a hierarchical data structure (such as XML).void
marshal
(Object obj, HierarchicalStreamWriter writer, DataHolder dataHolder) Serialize and object to a hierarchical data structure (such as XML).Create a DataHolder that can be used to pass data to the converters.void
Prevents a field from being serialized.void
processAnnotations
(Class type) Process the annotations of the given type and configure the XStream.void
processAnnotations
(Class[] types) Process the annotations of the given types and configure the XStream.void
registerConverter
(Converter converter) void
registerConverter
(Converter converter, int priority) void
registerConverter
(SingleValueConverter converter) void
registerConverter
(SingleValueConverter converter, int priority) private void
registerConverterDynamically
(String className, int priority, Class[] constructorParamTypes, Object[] constructorParamValues) void
registerLocalConverter
(Class definedIn, String fieldName, Converter converter) Register a localConverter
for a field.void
registerLocalConverter
(Class definedIn, String fieldName, SingleValueConverter converter) Register a localSingleValueConverter
for a field.void
setClassLoader
(ClassLoader classLoader) Change the ClassLoader XStream uses to load classes.void
setCollectionUpdateLimit
(int maxSeconds) Set time limit for adding elements to collections or maps.void
setMarshallingStrategy
(MarshallingStrategy marshallingStrategy) void
setMode
(int mode) Change mode for dealing with duplicate references.protected void
protected void
protected void
static void
setupDefaultSecurity
(XStream xstream) Deprecated.As of 1.4.18protected void
private void
protected void
Serialize an object to a pretty-printed XML String.void
toXML
(Object obj, OutputStream out) Serialize an object to the given OutputStream as pretty-printed XML.void
Serialize an object to the given Writer as pretty-printed XML.unmarshal
(HierarchicalStreamReader reader) Deserialize an object from a hierarchical data structure (such as XML).unmarshal
(HierarchicalStreamReader reader, Object root) Deserialize an object from a hierarchical data structure (such as XML), populating the fields of the given root object instead of instantiating a new one.unmarshal
(HierarchicalStreamReader reader, Object root, DataHolder dataHolder) Deserialize an object from a hierarchical data structure (such as XML).void
useAttributeFor
(Class type) Use an attribute for an arbitrary type.void
useAttributeFor
(Class definedIn, String fieldName) Use an attribute for a field declared in a specific type.void
useAttributeFor
(String fieldName, Class type) Use an attribute for a field or a specific type.protected boolean
Deprecated.As of 1.4.8protected MapperWrapper
wrapMapper
(MapperWrapper next)
-
Field Details
-
collectionUpdateLimit
private int collectionUpdateLimit -
reflectionProvider
-
hierarchicalStreamDriver
-
classLoaderReference
-
marshallingStrategy
-
converterLookup
-
converterRegistry
-
mapper
-
packageAliasingMapper
-
classAliasingMapper
-
fieldAliasingMapper
-
elementIgnoringMapper
-
attributeAliasingMapper
-
systemAttributeAliasingMapper
-
attributeMapper
-
defaultImplementationsMapper
-
immutableTypesMapper
-
implicitCollectionMapper
-
localConversionMapper
-
securityMapper
-
annotationConfiguration
-
NO_REFERENCES
public static final int NO_REFERENCES- See Also:
-
ID_REFERENCES
public static final int ID_REFERENCES- See Also:
-
XPATH_RELATIVE_REFERENCES
public static final int XPATH_RELATIVE_REFERENCES- See Also:
-
XPATH_ABSOLUTE_REFERENCES
public static final int XPATH_ABSOLUTE_REFERENCES- See Also:
-
SINGLE_NODE_XPATH_RELATIVE_REFERENCES
public static final int SINGLE_NODE_XPATH_RELATIVE_REFERENCES- See Also:
-
SINGLE_NODE_XPATH_ABSOLUTE_REFERENCES
public static final int SINGLE_NODE_XPATH_ABSOLUTE_REFERENCES- See Also:
-
PRIORITY_VERY_HIGH
public static final int PRIORITY_VERY_HIGH- See Also:
-
PRIORITY_NORMAL
public static final int PRIORITY_NORMAL- See Also:
-
PRIORITY_LOW
public static final int PRIORITY_LOW- See Also:
-
PRIORITY_VERY_LOW
public static final int PRIORITY_VERY_LOW- See Also:
-
COLLECTION_UPDATE_LIMIT
- See Also:
-
COLLECTION_UPDATE_SECONDS
- See Also:
-
ANNOTATION_MAPPER_TYPE
- See Also:
-
IGNORE_ALL
-
-
Constructor Details
-
XStream
public XStream()Constructs a default XStream.The instance will use the
XppDriver
as default and tries to determine the best match for theReflectionProvider
on its own.- Throws:
XStream.InitializationException
- in case of an initialization problem
-
XStream
Constructs an XStream with a specialReflectionProvider
.The instance will use the
XppDriver
as default.- Parameters:
reflectionProvider
- the reflection provider to use or null for best matching reflection provider- Throws:
XStream.InitializationException
- in case of an initialization problem
-
XStream
Constructs an XStream with a specialHierarchicalStreamDriver
.The instance will tries to determine the best match for the
ReflectionProvider
on its own.- Parameters:
hierarchicalStreamDriver
- the driver instance- Throws:
XStream.InitializationException
- in case of an initialization problem
-
XStream
public XStream(ReflectionProvider reflectionProvider, HierarchicalStreamDriver hierarchicalStreamDriver) Constructs an XStream with a specialHierarchicalStreamDriver
andReflectionProvider
.- Parameters:
reflectionProvider
- the reflection provider to use or null for best matching ProviderhierarchicalStreamDriver
- the driver instance- Throws:
XStream.InitializationException
- in case of an initialization problem
-
XStream
public XStream(ReflectionProvider reflectionProvider, Mapper mapper, HierarchicalStreamDriver driver) Deprecated.As of 1.3, useXStream(ReflectionProvider, HierarchicalStreamDriver, ClassLoader, Mapper)
insteadConstructs an XStream with a specialHierarchicalStreamDriver
,ReflectionProvider
and a preparedMapper
chain.- Parameters:
reflectionProvider
- the reflection provider to use or null for best matching Providermapper
- the instance with theMapper
chain or null for the default chaindriver
- the driver instance- Throws:
XStream.InitializationException
- in case of an initialization problem
-
XStream
public XStream(ReflectionProvider reflectionProvider, HierarchicalStreamDriver driver, ClassLoaderReference classLoaderReference) Constructs an XStream with a specialHierarchicalStreamDriver
,ReflectionProvider
and aClassLoaderReference
.- Parameters:
reflectionProvider
- the reflection provider to use or null for best matching Providerdriver
- the driver instanceclassLoaderReference
- the reference to theClassLoader
to use- Throws:
XStream.InitializationException
- in case of an initialization problem- Since:
- 1.4.5
-
XStream
public XStream(ReflectionProvider reflectionProvider, HierarchicalStreamDriver driver, ClassLoader classLoader) Deprecated.Constructs an XStream with a specialHierarchicalStreamDriver
,ReflectionProvider
and theClassLoader
to use.- Throws:
XStream.InitializationException
- in case of an initialization problem- Since:
- 1.3
-
XStream
public XStream(ReflectionProvider reflectionProvider, HierarchicalStreamDriver driver, ClassLoader classLoader, Mapper mapper) Deprecated.Constructs an XStream with a specialHierarchicalStreamDriver
,ReflectionProvider
, a preparedMapper
chain and theClassLoader
to use.- Parameters:
reflectionProvider
- the reflection provider to use or null for best matching Providerdriver
- the driver instanceclassLoader
- theClassLoader
to usemapper
- the instance with theMapper
chain or null for the default chain- Throws:
XStream.InitializationException
- in case of an initialization problem- Since:
- 1.3
-
XStream
public XStream(ReflectionProvider reflectionProvider, HierarchicalStreamDriver driver, ClassLoaderReference classLoaderReference, Mapper mapper) Constructs an XStream with a specialHierarchicalStreamDriver
,ReflectionProvider
, a preparedMapper
chain and theClassLoaderReference
.The
ClassLoaderReference
should also be used for theMapper
chain.- Parameters:
reflectionProvider
- the reflection provider to use or null for best matching Providerdriver
- the driver instanceclassLoaderReference
- the reference to theClassLoader
to usemapper
- the instance with theMapper
chain or null for the default chain- Throws:
XStream.InitializationException
- in case of an initialization problem- Since:
- 1.4.5
-
XStream
private XStream(ReflectionProvider reflectionProvider, HierarchicalStreamDriver driver, ClassLoaderReference classLoader, Mapper mapper, DefaultConverterLookup defaultConverterLookup) -
XStream
public XStream(ReflectionProvider reflectionProvider, HierarchicalStreamDriver driver, ClassLoader classLoader, Mapper mapper, ConverterLookup converterLookup, ConverterRegistry converterRegistry) Deprecated.Constructs an XStream with a specialHierarchicalStreamDriver
,ReflectionProvider
, a preparedMapper
chain, theClassLoaderReference
and an ownConverterLookup
andConverterRegistry
.- Parameters:
reflectionProvider
- the reflection provider to use or null for best matching Providerdriver
- the driver instanceclassLoader
- theClassLoader
to usemapper
- the instance with theMapper
chain or null for the default chainconverterLookup
- the instance that is used to lookup the convertersconverterRegistry
- an instance to manage the converter instances- Throws:
XStream.InitializationException
- in case of an initialization problem- Since:
- 1.3
-
XStream
public XStream(ReflectionProvider reflectionProvider, HierarchicalStreamDriver driver, ClassLoaderReference classLoaderReference, Mapper mapper, ConverterLookup converterLookup, ConverterRegistry converterRegistry) Constructs an XStream with a specialHierarchicalStreamDriver
,ReflectionProvider
, a preparedMapper
chain, theClassLoaderReference
and an ownConverterLookup
andConverterRegistry
.The ClassLoaderReference should also be used for the Mapper chain. The ConverterLookup should access the ConverterRegistry if you intent to register
Converter
instances with XStream facade or you are using annotations.- Parameters:
reflectionProvider
- the reflection provider to use or null for best matching Providerdriver
- the driver instanceclassLoaderReference
- the reference to theClassLoader
to usemapper
- the instance with theMapper
chain or null for the default chainconverterLookup
- the instance that is used to lookup the convertersconverterRegistry
- an instance to manage the converter instances or null to prevent any further registry (including annotations)- Throws:
XStream.InitializationException
- in case of an initialization problem- Since:
- 1.4.5
-
-
Method Details
-
buildMapper
-
buildMapperDynamically
-
wrapMapper
-
useXStream11XmlFriendlyMapper
protected boolean useXStream11XmlFriendlyMapper()Deprecated.As of 1.4.8 -
setupMappers
private void setupMappers() -
setupSecurity
protected void setupSecurity() -
denyTypeHierarchyDynamically
-
setupDefaultSecurity
Deprecated.As of 1.4.18Setup the security framework of a XStream instance.This method was a pure helper method for XStream 1.4.10 to 1.4.17. It initialized an XStream instance with a whitelist of well-known and simply types of the Java runtime as it is done in XStream 1.4.18 by default. This method will do therefore nothing in XStream 1.4.18 or higher.
- Parameters:
xstream
-- Since:
- 1.4.10
-
setupAliases
protected void setupAliases() -
aliasDynamically
-
setupDefaultImplementations
protected void setupDefaultImplementations() -
setupConverters
protected void setupConverters() -
registerConverterDynamically
-
setupImmutableTypes
protected void setupImmutableTypes() -
addImmutableTypeDynamically
-
setMarshallingStrategy
-
setCollectionUpdateLimit
public void setCollectionUpdateLimit(int maxSeconds) Set time limit for adding elements to collections or maps. Manipulated content may be used to create recursive hash code calculations or sort operations. AnInputManipulationException
is thrown, if the summed up time to add elements to collections or maps exceeds the provided limit. Note, that the time to add an individual element is calculated in seconds, not milliseconds. However, attacks typically use objects with exponential growing calculation times.- Parameters:
maxSeconds
- limit in seconds or 0 to disable check- Since:
- 1.4.19
-
toXML
Serialize an object to a pretty-printed XML String.- Throws:
XStreamException
- if the object cannot be serialized
-
toXML
Serialize an object to the given Writer as pretty-printed XML. The Writer will be flushed afterwards and in case of an exception.- Throws:
XStreamException
- if the object cannot be serialized
-
toXML
Serialize an object to the given OutputStream as pretty-printed XML. The OutputStream will be flushed afterwards and in case of an exception.- Throws:
XStreamException
- if the object cannot be serialized
-
marshal
Serialize and object to a hierarchical data structure (such as XML).- Throws:
XStreamException
- if the object cannot be serialized
-
marshal
Serialize and object to a hierarchical data structure (such as XML).- Parameters:
dataHolder
- Extra data you can use to pass to your converters. Use this as you want. If not present, XStream shall create one lazily as needed.- Throws:
XStreamException
- if the object cannot be serialized
-
fromXML
Deserialize an object from an XML String.- Throws:
XStreamException
- if the object cannot be deserialized
-
fromXML
Deserialize an object from an XML Reader.- Throws:
XStreamException
- if the object cannot be deserialized
-
fromXML
Deserialize an object from an XML InputStream.- Throws:
XStreamException
- if the object cannot be deserialized
-
fromXML
Deserialize an object from a URL. Depending on the parser implementation, some might take the file path as SystemId to resolve additional references.- Throws:
XStreamException
- if the object cannot be deserialized- Since:
- 1.4
-
fromXML
Deserialize an object from a file. Depending on the parser implementation, some might take the file path as SystemId to resolve additional references.- Throws:
XStreamException
- if the object cannot be deserialized- Since:
- 1.4
-
fromXML
Deserialize an object from an XML String, populating the fields of the given root object instead of instantiating a new one. Note, that this is a special use case! With the ReflectionConverter XStream will write directly into the raw memory area of the existing object. Use with care!- Throws:
XStreamException
- if the object cannot be deserialized
-
fromXML
Deserialize an object from an XML Reader, populating the fields of the given root object instead of instantiating a new one. Note, that this is a special use case! With the ReflectionConverter XStream will write directly into the raw memory area of the existing object. Use with care!- Throws:
XStreamException
- if the object cannot be deserialized
-
fromXML
Deserialize an object from a URL, populating the fields of the given root object instead of instantiating a new one. Note, that this is a special use case! With the ReflectionConverter XStream will write directly into the raw memory area of the existing object. Use with care! Depending on the parser implementation, some might take the file path as SystemId to resolve additional references.- Throws:
XStreamException
- if the object cannot be deserialized- Since:
- 1.4
-
fromXML
Deserialize an object from a file, populating the fields of the given root object instead of instantiating a new one. Note, that this is a special use case! With the ReflectionConverter XStream will write directly into the raw memory area of the existing object. Use with care! Depending on the parser implementation, some might take the file path as SystemId to resolve additional references.- Throws:
XStreamException
- if the object cannot be deserialized- Since:
- 1.4
-
fromXML
Deserialize an object from an XML InputStream, populating the fields of the given root object instead of instantiating a new one. Note, that this is a special use case! With the ReflectionConverter XStream will write directly into the raw memory area of the existing object. Use with care!- Throws:
XStreamException
- if the object cannot be deserialized
-
unmarshal
Deserialize an object from a hierarchical data structure (such as XML).- Throws:
XStreamException
- if the object cannot be deserialized
-
unmarshal
Deserialize an object from a hierarchical data structure (such as XML), populating the fields of the given root object instead of instantiating a new one. Note, that this is a special use case! With the ReflectionConverter XStream will write directly into the raw memory area of the existing object. Use with care!- Throws:
XStreamException
- if the object cannot be deserialized
-
unmarshal
Deserialize an object from a hierarchical data structure (such as XML).- Parameters:
root
- If present, the passed in object will have its fields populated, as opposed to XStream creating a new instance. Note, that this is a special use case! With the ReflectionConverter XStream will write directly into the raw memory area of the existing object. Use with care!dataHolder
- Extra data you can use to pass to your converters. Use this as you want. If not present, XStream shall create one lazily as needed.- Throws:
XStreamException
- if the object cannot be deserialized
-
alias
Alias a Class to a shorter name to be used in XML elements.- Parameters:
name
- Short nametype
- Type to be aliased- Throws:
XStream.InitializationException
- if noClassAliasingMapper
is available
-
aliasType
Alias a type to a shorter name to be used in XML elements. Any class that is assignable to this type will be aliased to the same name.- Parameters:
name
- Short nametype
- Type to be aliased- Throws:
XStream.InitializationException
- if noClassAliasingMapper
is available- Since:
- 1.2
-
alias
Alias a Class to a shorter name to be used in XML elements.- Parameters:
name
- Short nametype
- Type to be aliaseddefaultImplementation
- Default implementation of type to use if no other specified.- Throws:
XStream.InitializationException
- if noDefaultImplementationsMapper
or noClassAliasingMapper
is available
-
aliasPackage
Alias a package to a shorter name to be used in XML elements.- Parameters:
name
- Short namepkgName
- package to be aliased- Throws:
XStream.InitializationException
- if noDefaultImplementationsMapper
or noPackageAliasingMapper
is available- Since:
- 1.3.1
-
aliasField
Create an alias for a field name.- Parameters:
alias
- the alias itselfdefinedIn
- the type that declares the fieldfieldName
- the name of the field- Throws:
XStream.InitializationException
- if noFieldAliasingMapper
is available
-
aliasAttribute
Create an alias for an attribute- Parameters:
alias
- the alias itselfattributeName
- the name of the attribute- Throws:
XStream.InitializationException
- if noAttributeAliasingMapper
is available
-
aliasSystemAttribute
Create an alias for a system attribute. XStream will not write a system attribute if its alias is set tonull
. However, this is not reversible, i.e. deserialization of the result is likely to fail afterwards and will not produce an object equal to the originally written one.- Parameters:
alias
- the alias itself (may benull
)systemAttributeName
- the name of the system attribute- Throws:
XStream.InitializationException
- if noSystemAttributeAliasingMapper
is available- Since:
- 1.3.1
-
aliasAttribute
Create an alias for an attribute.- Parameters:
definedIn
- the type where the attribute is definedattributeName
- the name of the attributealias
- the alias itself- Throws:
XStream.InitializationException
- if noAttributeAliasingMapper
is available- Since:
- 1.2.2
-
useAttributeFor
Use an attribute for a field or a specific type.- Parameters:
fieldName
- the name of the fieldtype
- the Class of the type to be rendered as XML attribute- Throws:
XStream.InitializationException
- if noAttributeMapper
is available- Since:
- 1.2
-
useAttributeFor
Use an attribute for a field declared in a specific type.- Parameters:
definedIn
- the Class containing such fieldfieldName
- the name of the field- Throws:
XStream.InitializationException
- if noAttributeMapper
is available- Since:
- 1.2.2
-
useAttributeFor
Use an attribute for an arbitrary type.- Parameters:
type
- the Class of the type to be rendered as XML attribute- Throws:
XStream.InitializationException
- if noAttributeMapper
is available- Since:
- 1.2
-
addDefaultImplementation
Associate a default implementation of a class with an object. Whenever XStream encounters an instance of this type, it will use the default implementation instead. For example, java.util.ArrayList is the default implementation of java.util.List.- Parameters:
defaultImplementation
-ofType
-- Throws:
XStream.InitializationException
- if noDefaultImplementationsMapper
is available
-
addImmutableType
Deprecated.As of 1.4.9 useaddImmutableType(Class, boolean)
Add immutable types. The value of the instances of these types will always be written into the stream even if they appear multiple times. However, references are still supported at deserialization time.- Throws:
XStream.InitializationException
- if noImmutableTypesMapper
is available
-
addImmutableType
Add immutable types. The value of the instances of these types will always be written into the stream even if they appear multiple times.Note, while a reference-keeping marshaller will not write references for immutable types into the stream, a reference-keeping unmarshaller can still support such references in the stream for compatibility reasons at the expense of memory consumption. Therefore declare these types only as referenceable if your already persisted streams do contain such references. Otherwise you may waste a lot of memory during deserialization.
- Parameters:
isReferenceable
-true
if support at deserialization time is required for compatibility at the cost of a higher memory footprint,false
otherwise- Throws:
XStream.InitializationException
- if noImmutableTypesMapper
is available- Since:
- 1.4.9
-
registerConverter
-
registerConverter
-
registerConverter
-
registerConverter
-
registerLocalConverter
Register a localConverter
for a field.- Parameters:
definedIn
- the class type the field is defined infieldName
- the field nameconverter
- the converter to use- Since:
- 1.3
-
registerLocalConverter
public void registerLocalConverter(Class definedIn, String fieldName, SingleValueConverter converter) Register a localSingleValueConverter
for a field.- Parameters:
definedIn
- the class type the field is defined infieldName
- the field nameconverter
- the converter to use- Since:
- 1.3
-
getMapper
Retrieve theMapper
. This is by default a chain ofMapperWrappers
.- Returns:
- the mapper
- Since:
- 1.2
-
getReflectionProvider
Retrieve theReflectionProvider
in use.- Returns:
- the mapper
- Since:
- 1.2.1
-
getConverterLookup
-
setMode
public void setMode(int mode) Change mode for dealing with duplicate references. Valid values areXPATH_ABSOLUTE_REFERENCES
,XPATH_RELATIVE_REFERENCES
,XStream.ID_REFERENCES
andXStream.NO_REFERENCES
.- Throws:
IllegalArgumentException
- if the mode is not one of the declared types- See Also:
-
addImplicitCollection
Adds a default implicit collection which is used for any unmapped XML tag.- Parameters:
ownerType
- class owning the implicit collectionfieldName
- name of the field in the ownerType. This field must be a concrete collection type or matching the default implementation type of the collection type.
-
addImplicitCollection
Adds implicit collection which is used for all items of the given itemType.- Parameters:
ownerType
- class owning the implicit collectionfieldName
- name of the field in the ownerType. This field must be a concrete collection type or matching the default implementation type of the collection type.itemType
- type of the items to be part of this collection- Throws:
XStream.InitializationException
- if noImplicitCollectionMapper
is available
-
addImplicitCollection
public void addImplicitCollection(Class ownerType, String fieldName, String itemFieldName, Class itemType) Adds implicit collection which is used for all items of the given element name defined by itemFieldName.- Parameters:
ownerType
- class owning the implicit collectionfieldName
- name of the field in the ownerType. This field must be a concrete collection type or matching the default implementation type of the collection type.itemFieldName
- element name of the implicit collectionitemType
- item type to be aliases be the itemFieldName- Throws:
XStream.InitializationException
- if noImplicitCollectionMapper
is available
-
addImplicitArray
Adds an implicit array.- Parameters:
ownerType
- class owning the implicit arrayfieldName
- name of the array field- Since:
- 1.4
-
addImplicitArray
Adds an implicit array which is used for all items of the given itemType when the array type matches.- Parameters:
ownerType
- class owning the implicit arrayfieldName
- name of the array field in the ownerTypeitemType
- type of the items to be part of this array- Throws:
XStream.InitializationException
- if noImplicitCollectionMapper
is available or the array type does not match the itemType- Since:
- 1.4
-
addImplicitArray
Adds an implicit array which is used for all items of the given element name defined by itemName.- Parameters:
ownerType
- class owning the implicit arrayfieldName
- name of the array field in the ownerTypeitemName
- alias name of the items- Throws:
XStream.InitializationException
- if noImplicitCollectionMapper
is available- Since:
- 1.4
-
addImplicitMap
Adds an implicit map.- Parameters:
ownerType
- class owning the implicit mapfieldName
- name of the field in the ownerType. This field must be a concrete map type or matching the default implementation type of the map type.itemType
- type of the items to be part of this map as valuekeyFieldName
- the name of the field of the itemType that is used for the key in the map- Since:
- 1.4
-
addImplicitMap
public void addImplicitMap(Class ownerType, String fieldName, String itemName, Class itemType, String keyFieldName) Adds an implicit map.- Parameters:
ownerType
- class owning the implicit mapfieldName
- name of the field in the ownerType. This field must be a concrete map type or matching the default implementation type of the map type.itemName
- alias name of the itemsitemType
- type of the items to be part of this map as valuekeyFieldName
- the name of the field of the itemType that is used for the key in the map- Since:
- 1.4
-
newDataHolder
Create a DataHolder that can be used to pass data to the converters. The DataHolder is provided with a call tomarshal(Object, HierarchicalStreamWriter, DataHolder)
,unmarshal(HierarchicalStreamReader, Object, DataHolder)
,createObjectInputStream(HierarchicalStreamReader, DataHolder)
orcreateObjectOutputStream(HierarchicalStreamWriter, String, DataHolder)
.- Returns:
- a new
DataHolder
-
createObjectOutputStream
Creates an ObjectOutputStream that serializes a stream of objects to the writer using XStream.To change the name of the root element (from <object-stream>), use
createObjectOutputStream(java.io.Writer, String)
.- Throws:
IOException
- Since:
- 1.0.3
- See Also:
-
createObjectOutputStream
public ObjectOutputStream createObjectOutputStream(HierarchicalStreamWriter writer) throws IOException Creates an ObjectOutputStream that serializes a stream of objects to the writer using XStream.To change the name of the root element (from <object-stream>), use
createObjectOutputStream(java.io.Writer, String)
.- Throws:
IOException
- Since:
- 1.0.3
- See Also:
-
createObjectOutputStream
public ObjectOutputStream createObjectOutputStream(Writer writer, String rootNodeName) throws IOException Creates an ObjectOutputStream that serializes a stream of objects to the writer using XStream.- Throws:
IOException
- Since:
- 1.0.3
- See Also:
-
createObjectOutputStream
Creates an ObjectOutputStream that serializes a stream of objects to the OutputStream using XStream.To change the name of the root element (from <object-stream>), use
createObjectOutputStream(java.io.Writer, String)
.- Throws:
IOException
- Since:
- 1.3
- See Also:
-
createObjectOutputStream
public ObjectOutputStream createObjectOutputStream(OutputStream out, String rootNodeName) throws IOException Creates an ObjectOutputStream that serializes a stream of objects to the OutputStream using XStream.- Throws:
IOException
- Since:
- 1.3
- See Also:
-
createObjectOutputStream
public ObjectOutputStream createObjectOutputStream(HierarchicalStreamWriter writer, String rootNodeName) throws IOException Creates an ObjectOutputStream that serializes a stream of objects to the writer using XStream.Because an ObjectOutputStream can contain multiple items and XML only allows a single root node, the stream must be written inside an enclosing node.
It is necessary to call ObjectOutputStream.close() when done, otherwise the stream will be incomplete.
Example
ObjectOutputStream out = xstream.createObjectOutputStream(aWriter, "things"); out.writeInt(123); out.writeObject("Hello"); out.writeObject(someObject) out.close();
- Parameters:
writer
- The writer to serialize the objects to.rootNodeName
- The name of the root node enclosing the stream of objects.- Throws:
IOException
- Since:
- 1.0.3
- See Also:
-
createObjectOutputStream
public ObjectOutputStream createObjectOutputStream(HierarchicalStreamWriter writer, String rootNodeName, DataHolder dataHolder) throws IOException Creates an ObjectOutputStream that serializes a stream of objects to the writer using XStream.- Throws:
IOException
- Since:
- 1.4.10
- See Also:
-
createObjectInputStream
Creates an ObjectInputStream that deserializes a stream of objects from a reader using XStream.- Throws:
IOException
- Since:
- 1.0.3
- See Also:
-
createObjectInputStream
Creates an ObjectInputStream that deserializes a stream of objects from an InputStream using XStream.- Throws:
IOException
- Since:
- 1.3
- See Also:
-
createObjectInputStream
public ObjectInputStream createObjectInputStream(HierarchicalStreamReader reader) throws IOException Creates an ObjectInputStream that deserializes a stream of objects from a reader using XStream.It is necessary to call ObjectInputStream.close() when done, otherwise the stream might keep system resources.
Example
ObjectInputStream in = xstream.createObjectOutputStream(aReader); int a = out.readInt(); Object b = out.readObject(); Object c = out.readObject();
- Throws:
IOException
- Since:
- 1.0.3
- See Also:
-
createObjectInputStream
public ObjectInputStream createObjectInputStream(HierarchicalStreamReader reader, DataHolder dataHolder) throws IOException Creates an ObjectInputStream that deserializes a stream of objects from a reader using XStream.- Throws:
IOException
- Since:
- 1.4.10
- See Also:
-
setClassLoader
Change the ClassLoader XStream uses to load classes. Creating an XStream instance it will register for all kind of classes and types of the current JDK, but not for any 3rd party type. To ensure that all other types are loaded with your class loader, you should call this method as early as possible - or consider to provide the class loader directly in the constructor.- Since:
- 1.1.1
-
getClassLoader
Retrieve the ClassLoader XStream uses to load classes.- Since:
- 1.1.1
-
getClassLoaderReference
Retrieve the reference to this instance' ClassLoader. Use this reference for other XStream components (like converters) to ensure that they will use a changed ClassLoader instance automatically.- Returns:
- the reference
- Since:
- 1.4.5
-
omitField
Prevents a field from being serialized. To omit a field you must always provide the declaring type and not necessarily the type that is converted.- Throws:
XStream.InitializationException
- if noElementIgnoringMapper
is available- Since:
- 1.1.3
-
ignoreUnknownElements
public void ignoreUnknownElements()Ignore all unknown elements.- Since:
- 1.4.5
-
ignoreUnknownElements
Add pattern for unknown element names to ignore.- Parameters:
pattern
- the name pattern as regular expression- Since:
- 1.4.5
-
ignoreUnknownElements
Add pattern for unknown element names to ignore.- Parameters:
pattern
- the name pattern as regular expression- Since:
- 1.4.5
-
processAnnotations
Process the annotations of the given types and configure the XStream.- Parameters:
types
- the types with XStream annotations- Since:
- 1.3
-
processAnnotations
Process the annotations of the given type and configure the XStream. A call of this method will automatically turn the auto-detection mode for annotations off.- Parameters:
type
- the type with XStream annotations- Since:
- 1.3
-
autodetectAnnotations
public void autodetectAnnotations(boolean mode) Set the auto-detection mode of the AnnotationMapper. Note that auto-detection implies that the XStream is configured while it is processing the XML steams. This is a potential concurrency problem. Also is it technically not possible to detect all class aliases at deserialization. You have been warned!- Parameters:
mode
-true
if annotations are auto-detected- Since:
- 1.3
-
addPermission
Add a new security permission.Permissions are evaluated in the added sequence. An instance of
NoTypePermission
orAnyTypePermission
will implicitly wipe any existing permission.- Parameters:
permission
- the permission to add- Since:
- 1.4.7
-
allowTypes
Add security permission for explicit types by name.- Parameters:
names
- the type names to allow- Since:
- 1.4.7
-
allowTypes
Add security permission for explicit types.- Parameters:
types
- the types to allow- Since:
- 1.4.7
-
allowTypeHierarchy
Add security permission for a type hierarchy.- Parameters:
type
- the base type to allow- Since:
- 1.4.7
-
allowTypesByRegExp
Add security permission for types matching one of the specified regular expressions.- Parameters:
regexps
- the regular expressions to allow type names- Since:
- 1.4.7
-
allowTypesByRegExp
Add security permission for types matching one of the specified regular expressions.- Parameters:
regexps
- the regular expressions to allow type names- Since:
- 1.4.7
-
allowTypesByWildcard
Add security permission for types matching one of the specified wildcard patterns.Supported are patterns with path expressions using dot as separator:
- ?: one non-control character except separator, e.g. for 'java.net.Inet?Address'
- *: arbitrary number of non-control characters except separator, e.g. for types in a package like 'java.lang.*'
- **: arbitrary number of non-control characters including separator, e.g. for types in a package and subpackages like 'java.lang.**'
- Parameters:
patterns
- the patterns to allow type names- Since:
- 1.4.7
-
denyPermission
Add security permission denying another one.- Parameters:
permission
- the permission to deny- Since:
- 1.4.7
-
denyTypes
Add security permission forbidding explicit types by name.- Parameters:
names
- the type names to forbid- Since:
- 1.4.7
-
denyTypes
Add security permission forbidding explicit types.- Parameters:
types
- the types to forbid- Since:
- 1.4.7
-
denyTypeHierarchy
Add security permission forbidding a type hierarchy.- Parameters:
type
- the base type to forbid- Since:
- 1.4.7
-
denyTypesByRegExp
Add security permission forbidding types matching one of the specified regular expressions.- Parameters:
regexps
- the regular expressions to forbid type names- Since:
- 1.4.7
-
denyTypesByRegExp
Add security permission forbidding types matching one of the specified regular expressions.- Parameters:
regexps
- the regular expressions to forbid type names- Since:
- 1.4.7
-
denyTypesByWildcard
Add security permission forbidding types matching one of the specified wildcard patterns.Supported are patterns with path expressions using dot as separator:
- ?: one non-control character except separator, e.g. for 'java.net.Inet?Address'
- *: arbitrary number of non-control characters except separator, e.g. for types in a package like 'java.lang.*'
- **: arbitrary number of non-control characters including separator, e.g. for types in a package and subpackages like 'java.lang.**'
- Parameters:
patterns
- the patterns to forbid names- Since:
- 1.4.7
-
InitializationException
instead