| java.lang.Object
 org.apache.commons.beanutils.converters.AbstractConverter
All known Subclasses: org.apache.commons.beanutils.converters.FileConverter, org.apache.commons.beanutils.converters.NumberConverter, org.apache.commons.beanutils.converters.ClassConverter, org.apache.commons.beanutils.converters.CharacterConverter, org.apache.commons.beanutils.converters.StringConverter, org.apache.commons.beanutils.converters.ArrayConverter, org.apache.commons.beanutils.converters.URLConverter, org.apache.commons.beanutils.converters.DateTimeConverter, org.apache.commons.beanutils.converters.BooleanConverter,
| AbstractConverter | | abstract public class AbstractConverter implements Converter(Code) | | Base
Converter implementation that provides the structure
for handling conversion to and from a specified type.
This implementation provides the basic structure for
converting to/from a specified type optionally using a default
value or throwing a
ConversionException if a
conversion error occurs.
Implementations should provide conversion to the specified
type and from the specified type to a String value
by implementing the following methods:
convertToString(value) - convert to a String
(default implementation uses the objects toString()
method).convertToType(Class, value) - convert
to the specified type
version:
$Revision: 555824 $ $Date: 2007-07-13 01:27:15 +0100 (Fri, 13 Jul 2007) $
since:
1.8.0 |
| Constructor Summary | |
| public | AbstractConverter(Class defaultType)
Construct a Converter that throws a
ConversionException if an error occurs. | | public | AbstractConverter(Class defaultType, Object defaultValue)
Construct a Converter that returns a default
value if an error occurs. |
| Method Summary | |
| public Object | convert(Class type, Object value)
Convert the input object into an output object of the
specified type. | | protected Object | convertArray(Object value)
Return the first element from an Array (or Collection)
or the value unchanged if not an Array (or Collection).
N.B. | | protected String | convertToString(Object value)
Convert the input object into a String.
N.B.This implementation simply uses the value's
toString() method and should be overriden if a
more sophisticated mechanism for conversion to a String
is required.
Parameters:
value - The input value to be converted. | | abstract protected Object | convertToType(Class type, Object value)
Convert the input object into an output object of the
specified type.
Typical implementations will provide a minimum of
String --> type conversion.
Parameters:
type - Data type to which this value should be converted.
Parameters:
value - The input value to be converted. | | protected Object | getDefault(Class type)
Return the default value for conversions to the specified
type.
Parameters:
type - Data type to which this value should be converted. | | protected Class | getDefaultType()
Return the default type this Converter handles. | | protected Object | handleError(Class type, Object value, Throwable cause)
Handle Conversion Errors. | | protected Object | handleMissing(Class type)
Handle missing values.
If a default value has been specified then it is returned
otherwise a ConversionException is thrown.
Parameters:
type - Data type to which this value should be converted. | | public boolean | isUseDefault()
Indicates whether a default value will be returned or exception
thrown in the event of a conversion error. | | Log | log()
Accessor method for Log instance. | | Class | primitive(Class type)
Change primitve Class types to the associated wrapper class.
Parameters:
type - The class type to check. | | protected void | setDefaultValue(Object defaultValue)
Set the default value, converting as required. | | public String | toString()
Provide a String representation of this converter. | | String | toString(Class type)
Provide a String representation of a java.lang.Class.
Parameters:
type - The java.lang.Class. |
| AbstractConverter | | public AbstractConverter(Class defaultType)(Code) | | Construct a Converter that throws a
ConversionException if an error occurs.
Parameters:
defaultType - The default type this Converterhandles |
| AbstractConverter | | public AbstractConverter(Class defaultType, Object defaultValue)(Code) | | Construct a Converter that returns a default
value if an error occurs.
Parameters:
defaultType - The default type this Converterhandles
Parameters:
defaultValue - The default value to be returnedif the value to be converted is missing or an erroroccurs converting the value. |
| convert | | public Object convert(Class type, Object value)(Code) | | Convert the input object into an output object of the
specified type.
Parameters:
type - Data type to which this value should be converted
Parameters:
value - The input value to be converted The converted value.
throws:
ConversionException - if conversion cannot be performedsuccessfully and no default is specified. |
| convertArray | | protected Object convertArray(Object value)(Code) | | Return the first element from an Array (or Collection)
or the value unchanged if not an Array (or Collection).
N.B. This needs to be overriden for array/Collection converters.
Parameters:
value - The value to convert The first element in an Array (or Collection)or the value unchanged if not an Array (or Collection) |
| convertToString | | protected String convertToString(Object value) throws Throwable(Code) | | Convert the input object into a String.
N.B.This implementation simply uses the value's
toString() method and should be overriden if a
more sophisticated mechanism for conversion to a String
is required.
Parameters:
value - The input value to be converted. the converted String value.
throws:
Throwable - if an error occurs converting to a String |
| convertToType | | abstract protected Object convertToType(Class type, Object value) throws Throwable(Code) | | Convert the input object into an output object of the
specified type.
Typical implementations will provide a minimum of
String --> type conversion.
Parameters:
type - Data type to which this value should be converted.
Parameters:
value - The input value to be converted. The converted value.
throws:
Throwable - if an error occurs converting to the specified type |
| getDefault | | protected Object getDefault(Class type)(Code) | | Return the default value for conversions to the specified
type.
Parameters:
type - Data type to which this value should be converted. The default value for the specified type. |
| getDefaultType | | protected Class getDefaultType()(Code) | | Return the default type this Converter handles.
The default type this Converter handles. |
| handleError | | protected Object handleError(Class type, Object value, Throwable cause)(Code) | | Handle Conversion Errors.
If a default value has been specified then it is returned
otherwise a ConversionException is thrown.
Parameters:
type - Data type to which this value should be converted.
Parameters:
value - The input value to be converted
Parameters:
cause - The exception thrown by the convert method The default value.
throws:
ConversionException - if no default value has beenspecified for this Converter. |
| handleMissing | | protected Object handleMissing(Class type)(Code) | | Handle missing values.
If a default value has been specified then it is returned
otherwise a ConversionException is thrown.
Parameters:
type - Data type to which this value should be converted. The default value.
throws:
ConversionException - if no default value has beenspecified for this Converter. |
| isUseDefault | | public boolean isUseDefault()(Code) | | Indicates whether a default value will be returned or exception
thrown in the event of a conversion error.
true if a default value will be returned forconversion errors or false if a ConversionExceptionwill be thrown. |
| log | | Log log()(Code) | | Accessor method for Log instance.
The Log instance variable is transient and
accessing it through this method ensures it
is re-initialized when this instance is
de-serialized.
The Log instance. |
| primitive | | Class primitive(Class type)(Code) | | Change primitve Class types to the associated wrapper class.
Parameters:
type - The class type to check. The converted type. |
| setDefaultValue | | protected void setDefaultValue(Object defaultValue)(Code) | | Set the default value, converting as required.
If the default value is different from the type the
Converter handles, it will be converted
to the handled type.
Parameters:
defaultValue - The default value to be returnedif the value to be converted is missing or an erroroccurs converting the value.
throws:
ConversionException - if an error occurs convertingthe default value |
| toString | | public String toString()(Code) | | Provide a String representation of this converter.
A String representation of this converter |
| toString | | String toString(Class type)(Code) | | Provide a String representation of a java.lang.Class.
Parameters:
type - The java.lang.Class. The String representation. |
|
|