Converter

implements ConverterMatcher

com.thoughtworks.xstream.converters.Converter

Known Indirect Subclasses

AbstractBasicConverter, AbstractCollectionConverter, AbstractReflectionConverter, AnnotationReflectionConverter, ArrayConverter, BitSetConverter, CGLIBEnhancedConverter, CharArrayConverter, CharConverter, CollectionConverter, ColorConverter, DynamicProxyConverter, EncodedByteArrayConverter, EnumConverter, EnumMapConverter, and 19 others.

AbstractBasicConverter	This class is deprecated. Since 1.2 use `AbstractSingleValueConverter`
AbstractCollectionConverter	Base helper class for converters that need to handle collections of items (arrays, Lists, Maps, etc).
AbstractReflectionConverter
AnnotationReflectionConverter	This class is deprecated. since 1.3, build into `ReflectionConverter`
ArrayConverter	Converts an array of objects or primitives to XML, using a nested child element for each item.
BitSetConverter	Converts a java.util.BitSet to XML, as a compact comma delimited list of ones and zeros.
CGLIBEnhancedConverter	Converts a proxy created by the CGLIB Enhancer.
CharArrayConverter	Converts a char[] to XML, storing the contents as a single String.
CharConverter	Converts a char primitive or java.lang.Character wrapper to a String.
CollectionConverter	Converts most common Collections (Lists and Sets) to XML, specifying a nested element for each item.
ColorConverter	Converts a java.awt.Color to XML, using four nested elements: red, green, blue, alpha.
DynamicProxyConverter	Converts a dynamic proxy to XML, storing the implemented interfaces and handler.
EncodedByteArrayConverter	Converts a byte array to a single Base64 encoding string.
EnumConverter	Converter for JDK 1.5 enums.
EnumMapConverter	Serializes an Java 5 EnumMap, including the type of Enum it's for.
EnumSetConverter	Serializes a Java 5 EnumSet.
ExternalizableConverter	Converts any object that implements the java.io.Externalizable interface, allowing compatibility with native Java serialization.
FontConverter
GregorianCalendarConverter	Converts a java.util.GregorianCalendar to XML.
JavaBeanConverter	Can convert any bean with a public default constructor.
JavaMethodConverter	Converts a java.lang.reflect.Method to XML.
LookAndFeelConverter	A converter for Swing LookAndFeel implementations.
MapConverter	Converts a java.util.Map to XML, specifying an 'entry' element with 'key' and 'value' children.
NullConverter	Special converter to signify nulls at the root level.
PropertiesConverter	Special converter for java.util.Properties that stores properties in a more compact form than java.util.Map.
ReflectionConverter
RegexPatternConverter	Ensures java.util.regex.Pattern is compiled upon deserialization.
SelfStreamingInstanceChecker	A special converter that prevents self-serialization.
SerializableConverter	Emulates the mechanism used by standard Java Serialization for classes that implement java.io.Serializable AND implement or inherit a custom readObject()/writeObject() method.
SingleValueConverterWrapper	Wrapper to convert a `SingleValueConverter` into a `Converter`.
SubjectConverter	Converts a Subject instance.
ThrowableConverter	Converter for Throwable (and Exception) that retains stack trace, for JDK1.4 only.
TreeMapConverter	Converts a java.util.TreeMap to XML, and serializes the associated java.util.Comparator.
TreeSetConverter	Converts a java.util.TreeSet to XML, and serializes the associated java.util.Comparator.

Class Overview

Converter implementations are responsible marshalling Java objects to/from textual data.

If an exception occurs during processing, a ConversionException should be thrown.

If working with the high level XStream facade, you can register new converters using the XStream.registerConverter() method.

If working with the lower level API, the ConverterLookup implementation is responsible for looking up the appropriate converter.

Converters for object that can store all information in a single value should implement SingleValueConverter.

AbstractSingleValueConverter provides a starting point.

AbstractCollectionConverter provides a starting point for objects that hold a collection of other objects (such as Lists and Maps).

Summary

Public Methods
abstract void	marshal(Object source, HierarchicalStreamWriter writer, MarshallingContext context) Convert an object to textual data.
abstract Object	unmarshal(HierarchicalStreamReader reader, UnmarshallingContext context) Convert textual data back into an object.

[Expand]

Inherited Methods

From interface com.thoughtworks.xstream.converters.ConverterMatcher

Public Methods

public abstract void marshal (Object source, HierarchicalStreamWriter writer, MarshallingContext context)

Convert an object to textual data.

Parameters

source	The object to be marshalled.
writer	A stream to write to.
context	A context that allows nested objects to be processed by XStream.

public abstract Object unmarshal (HierarchicalStreamReader reader, UnmarshallingContext context)

Convert textual data back into an object.

Parameters

reader	The stream to read the text from.

Returns

The resulting object.

Interfaces

Classes

Exceptions

Converter

Class Overview

See Also

Summary

Public Methods

public abstract void marshal (Object source, HierarchicalStreamWriter writer, MarshallingContext context)

Parameters

public abstract Object unmarshal (HierarchicalStreamReader reader, UnmarshallingContext context)

Parameters

Returns