XStream

Constructs a default XStream. The instance will use the XppDriver as default and tries to determine the best match for the ReflectionProvider on its own.

Constructs an XStream with a special ReflectionProvider. The instance will use the XppDriver as default.

Constructs an XStream with a special HierarchicalStreamDriver. The instance will tries to determine the best match for the ReflectionProvider on its own.

Constructs an XStream with a special HierarchicalStreamDriver and ReflectionProvider.

Constructs an XStream with a special HierarchicalStreamDriver and ReflectionProvider and additionally with a prepared Mapper.

Constructs an XStream with a special HierarchicalStreamDriver and ReflectionProvider and additionally with a prepared ClassLoader to use.

Constructs an XStream with a special HierarchicalStreamDriver and ReflectionProvider and additionally with a prepared Mapper and the ClassLoader in use.

Note, if the class loader should be changed later again, you should provide a ClassLoaderReference as ClassLoader that is also use in the Mapper chain.

Constructs an XStream with a special HierarchicalStreamDriver, ReflectionProvider, a prepared Mapper and the ClassLoader in use and an own ConverterRegistry.

Note, if the class loader should be changed later again, you should provide a ClassLoaderReference as ClassLoader that is also use in the Mapper chain.

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.

Add immutable types. The value of the instances of these types will always be written into the stream even if they appear multiple times.

Adds implicit collection which is used for all items of the given element name defined by itemFieldName.

Adds a default implicit collection which is used for any unmapped XML tag.

Adds implicit collection which is used for all items of the given itemType.

Alias a Class to a shorter name to be used in XML elements.

Alias a Class to a shorter name to be used in XML elements.

Create an alias for an attribute

Create an alias for an attribute.

Create an alias for a field name.

Alias a package to a shorter name to be used in XML elements.

Create an alias for a system attribute. XStream will not write a system attribute if its alias is set to null. 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.

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.

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!

Creates an ObjectInputStream that deserializes a stream of objects from a reader using XStream.

Creates an ObjectInputStream that deserializes a stream of objects from a reader using XStream.

Example

 ObjectInputStream in = xstream.createObjectOutputStream(aReader);
 int a = out.readInt();
 Object b = out.readObject();
 Object c = out.readObject();
 

Creates an ObjectInputStream that deserializes a stream of objects from an InputStream using XStream.

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 writer using XStream.

To change the name of the root element (from <object-stream>), use createObjectOutputStream(java.io.Writer, String).

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).

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();
 

Creates an ObjectOutputStream that serializes a stream of objects to the OutputStream using XStream.

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).

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!

Deserialize an object from an XML Reader.

Deserialize an object from an XML String.

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!

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!

Deserialize an object from an XML InputStream.

Retrieve the ClassLoader XStream uses to load classes.

Retrieve the Mapper. This is by default a chain of MapperWrappers.

Retrieve the ReflectionProvider in use.

Serialize and object to a hierarchical data structure (such as XML).

Serialize and object to a hierarchical data structure (such as XML).

Create a DataHolder that can be used to pass data to the converters. The DataHolder is provided with a call to marshal(Object, HierarchicalStreamWriter, DataHolder) or unmarshal(HierarchicalStreamReader, Object, DataHolder).

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.

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.

Process the annotations of the given types and configure the XStream.

Register a local SingleValueConverter for a field.

Register a local Converter for a field.

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 classloader, you should call this method as early as possible - or consider to provide the classloader directly in the constructor.

Change mode for dealing with duplicate references. Valid values are XPATH_ABSOLUTE_REFERENCES, XPATH_RELATIVE_REFERENCES, XStream.ID_REFERENCES and XStream.NO_REFERENCES.

Serialize an object to the given Writer as pretty-printed XML. The Writer will be flushed afterwards and in case of an exception.

Serialize an object to the given OutputStream as pretty-printed XML. The OutputStream will be flushed afterwards and in case of an exception.

Serialize an object to a pretty-printed XML String.

Deserialize an object from a hierarchical data structure (such as XML).

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!

Deserialize an object from a hierarchical data structure (such as XML).

Use an attribute for a field or a specific type.

Use an attribute for an arbitrary type.

Use an attribute for a field declared in a specific type.