public class

PropertiesConverter

extends Object
implements Converter
java.lang.Object
   ↳ com.thoughtworks.xstream.converters.collections.PropertiesConverter

Class Overview

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.

Summary

Public Constructors
PropertiesConverter()
PropertiesConverter(boolean sort)
Public Methods
boolean canConvert(Class type)
Determines whether the converter can marshall a particular type.
void marshal(Object source, HierarchicalStreamWriter writer, MarshallingContext context)
Convert an object to textual data.
Object unmarshal(HierarchicalStreamReader reader, UnmarshallingContext context)
Convert textual data back into an object.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.thoughtworks.xstream.converters.Converter
From interface com.thoughtworks.xstream.converters.ConverterMatcher

Public Constructors

public PropertiesConverter ()

public PropertiesConverter (boolean sort)

Public Methods

public boolean canConvert (Class type)

Determines whether the converter can marshall a particular type.

Parameters
type the Class representing the object type to be converted

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