org.apache.commons.beanutils.converters
Class StringConverter

java.lang.Object
  org.apache.commons.beanutils.converters.AbstractConverter
      org.apache.commons.beanutils.converters.StringConverter

All Implemented Interfaces:

Converter

public final class StringConverter
extends AbstractConverter

Converter implementation that converts an incoming object into a java.lang.String object.

Note that ConvertUtils really is designed to do string->object conversions, and offers very little support for object->string conversions. The ConvertUtils/ConvertUtilsBean methods only select a converter to apply based upon the target type being converted to, and generally assume that the input is a string (by calling its toString method if needed).

This class is therefore just a dummy converter that converts its input into a string by calling the input object's toString method and returning that value.

It is possible to replace this converter with something that has a big if/else statement that selects behaviour based on the real type of the object being converted (or possibly has a map of converters, and looks them up based on the class of the input object). However this is not part of the existing ConvertUtils framework.

Since:

1.3

Version:

$Revision: 690380 $ $Date: 2008-08-29 21:04:38 +0100 (Fri, 29 Aug 2008) $

Author:

Craig R. McClanahan

Constructor Summary

StringConverter()
Construct a java.lang.String Converter that throws a ConversionException if an error occurs.

StringConverter(Object defaultValue)
Construct a java.lang.String Converter that returns a default value if an error occurs.

Method Summary

protected Object	convertToType(Class type, Object value) Convert the specified input object into an output object of the specified type.
protected Class	getDefaultType() Return the default type this Converter handles.

Methods inherited from class org.apache.commons.beanutils.converters.AbstractConverter

convert, convertArray, convertToString, getDefault, handleError, handleMissing, isUseDefault, setDefaultValue, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

StringConverter

public StringConverter()

Construct a java.lang.String Converter that throws a ConversionException if an error occurs.

StringConverter

public StringConverter(Object defaultValue)

Construct a java.lang.String Converter that returns a default value if an error occurs.

Parameters:

defaultValue - The default value to be returned if the value to be converted is missing or an error occurs converting the value.

Method Detail

getDefaultType

protected Class getDefaultType()

Return the default type this Converter handles.

Specified by:

getDefaultType in class AbstractConverter

Returns:

The default type this Converter handles.

Since:

1.8.0

convertToType

protected Object convertToType(Class type,
                               Object value)
                        throws Throwable

Convert the specified input object into an output object of the specified type.

Specified by:

convertToType in class AbstractConverter

Parameters:

type - Data type to which this value should be converted.

value - The input value to be converted.

Returns:

The converted value.

Throws:

Throwable - if an error occurs converting to the specified type

Since:

1.8.0