com.thoughtworks.xstream.converters.extended
Class ToStringConverter

java.lang.Object
  extended by com.thoughtworks.xstream.converters.basic.AbstractSingleValueConverter
      extended by com.thoughtworks.xstream.converters.extended.ToStringConverter
All Implemented Interfaces:
ConverterMatcher, SingleValueConverter

public class ToStringConverter
extends AbstractSingleValueConverter

Convenient converter for classes with natural string representation. Converter for classes that adopt the following convention: - a constructor that takes a single string parameter - a toString() that is overloaded to issue a string that is meaningful

Author:
Paul Hammant

Constructor Summary
ToStringConverter(java.lang.Class clazz)
           
 
Method Summary
 boolean canConvert(java.lang.Class type)
          Determines whether the converter can marshall a particular type.
 java.lang.Object fromString(java.lang.String str)
          Unmarshals an Object from its single value representation.
 java.lang.String toString(java.lang.Object obj)
          Marshals an Object into a single value representation.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ToStringConverter

public ToStringConverter(java.lang.Class clazz)
                  throws java.lang.NoSuchMethodException
Throws:
java.lang.NoSuchMethodException
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
Specified by:
canConvert in class AbstractSingleValueConverter
Parameters:
type - the Class representing the object type to be converted

toString

public java.lang.String toString(java.lang.Object obj)
Description copied from interface: SingleValueConverter
Marshals an Object into a single value representation.

Specified by:
toString in interface SingleValueConverter
Overrides:
toString in class AbstractSingleValueConverter
Parameters:
obj - the Object to be converted
Returns:
a String with the single value of the Object or null

fromString

public java.lang.Object fromString(java.lang.String str)
Description copied from interface: SingleValueConverter
Unmarshals an Object from its single value representation.

Specified by:
fromString in interface SingleValueConverter
Specified by:
fromString in class AbstractSingleValueConverter
Parameters:
str - the String with the single value of the Object
Returns:
the Object


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