com.thoughtworks.xstream.converters.collections
Class PropertiesConverter

java.lang.Object
  extended bycom.thoughtworks.xstream.converters.collections.PropertiesConverter
All Implemented Interfaces:
Converter, ConverterMatcher

public class PropertiesConverter
extends java.lang.Object
implements Converter

Special converter for java.util.Properties that stores properties in a more compact form than java.util.Map.

Because all entries of a Properties instance are Strings, a single element is used for each property with two attributes; one for key and one for value.

Additionally, default properties are also serialized, if they are present.

Author:
Joe Walnes, Kevin Ring

Constructor Summary
PropertiesConverter()
           
 
Method Summary
 boolean canConvert(java.lang.Class type)
          Determines whether the converter can marshall a particular type.
 void marshal(java.lang.Object source, HierarchicalStreamWriter writer, MarshallingContext context)
          Convert an object to textual data.
 java.lang.Object unmarshal(HierarchicalStreamReader reader, UnmarshallingContext context)
          Convert textual data back into an object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PropertiesConverter

public PropertiesConverter()
Method Detail

canConvert

public boolean canConvert(java.lang.Class type)
Description copied from interface: ConverterMatcher
Determines whether the converter can marshall a particular type.

Specified by:
canConvert in interface ConverterMatcher
Parameters:
type - the Class representing the object type to be converted

marshal

public void marshal(java.lang.Object source,
                    HierarchicalStreamWriter writer,
                    MarshallingContext context)
Description copied from interface: Converter
Convert an object to textual data.

Specified by:
marshal in interface Converter
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.

unmarshal

public java.lang.Object unmarshal(HierarchicalStreamReader reader,
                                  UnmarshallingContext context)
Description copied from interface: Converter
Convert textual data back into an object.

Specified by:
unmarshal in interface Converter
Parameters:
reader - The stream to read the text from.
context -
Returns:
The resulting object.


Joe Walnes, http://xstream.codehaus.org/