java.lang.Object | |
↳ | org.apache.commons.beanutils.converters.AbstractConverter |
Known Direct Subclasses |
Known Indirect Subclasses |
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 typePublic Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Construct a Converter that throws a
ConversionException if an error occurs. | |||||||||||
Construct a Converter that returns a default
value if an error occurs.
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Convert the input object into an output object of the
specified type.
| |||||||||||
Indicates whether a default value will be returned or exception
thrown in the event of a conversion error.
| |||||||||||
Provide a String representation of this converter.
|
Protected Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Return the first element from an Array (or Collection)
or the value unchanged if not an Array (or Collection).
| |||||||||||
Convert the input object into a String.
| |||||||||||
Convert the input object into an output object of the
specified type.
| |||||||||||
Return the default value for conversions to the specified
type.
| |||||||||||
Return the default type this
Converter handles. | |||||||||||
Handle Conversion Errors.
| |||||||||||
Handle missing values.
| |||||||||||
Set the default value, converting as required.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
From interface
org.apache.commons.beanutils.Converter
|
Construct a Converter that throws a
ConversionException
if an error occurs.
Construct a Converter that returns a default value if an error occurs.
defaultValue | The default value to be returned if the value to be converted is missing or an error occurs converting the value. |
---|
Convert the input object into an output object of the specified type.
type | Data type to which this value should be converted |
---|---|
value | The input value to be converted |
ConversionException | if conversion cannot be performed successfully and no default is specified. |
---|
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 for
conversion errors or false
if a ConversionException
will be thrown.
Provide a String representation of this converter.
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.
value | The value to convert |
---|
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.
value | The input value to be converted. |
---|
Throwable | if an error occurs converting to a String |
---|
Convert the input object into an output object of the specified type.
Typical implementations will provide a minimum of
String --> type
conversion.
type | Data type to which this value should be converted. |
---|---|
value | The input value to be converted. |
Throwable | if an error occurs converting to the specified type |
---|
Return the default value for conversions to the specified type.
type | Data type to which this value should be converted. |
---|
Return the default type this Converter
handles.
Converter
handles.
Handle Conversion Errors.
If a default value has been specified then it is returned otherwise a ConversionException is thrown.
type | Data type to which this value should be converted. |
---|---|
value | The input value to be converted |
cause | The exception thrown by the convert method |
ConversionException | if no default value has been
specified for this Converter .
|
---|
Handle missing values.
If a default value has been specified then it is returned otherwise a ConversionException is thrown.
type | Data type to which this value should be converted. |
---|
ConversionException | if no default value has been
specified for this Converter .
|
---|
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.
defaultValue | The default value to be returned if the value to be converted is missing or an error occurs converting the value. |
---|
ConversionException | if an error occurs converting the default value |
---|