| java.lang.Object
 org.apache.commons.beanutils.converters.AbstractConverter
org.apache.commons.beanutils.converters.BooleanConverter
| BooleanConverter | | final public class BooleanConverter extends AbstractConverter (Code) | | org.apache.commons.beanutils.Converter implementaion that handles conversion
to and from Boolean objects.
org.apache.commons.beanutils.Converter implementaion that
handles conversion to and from java.lang.Boolean objects.
Can be configured to either return a default value or throw a
ConversionException if a conversion error occurs.
By default any object whose string representation is one of the values
{"yes", "y", "true", "on", "1"} is converted to Boolean.TRUE, and
string representations {"no", "n", "false", "off", "0"} are converted
to Boolean.FALSE. The recognised true/false strings can be changed by:
String[] trueStrings = {"oui", "o", "1"};
String[] falseStrings = {"non", "n", "0"};
Converter bc = new BooleanConverter(trueStrings, falseStrings);
ConvertUtils.register(bc, Boolean.class);
ConvertUtils.register(bc, Boolean.TYPE);
In addition, it is recommended that the BooleanArrayConverter also be
modified to recognise the same set of values:
Converter bac = new BooleanArrayConverter(bc, BooleanArrayConverter.NO_DEFAULT);
ConvertUtils.register(bac, bac.MODEL);
Case is ignored when converting values to true or false.
author:
Craig R. McClanahan
version:
$Revision: 555845 $ $Date: 2007-07-13 03:52:05 +0100 (Fri, 13 Jul 2007) $
since:
1.3 |
| Field Summary | |
| final public static Object | NO_DEFAULT
This is a special reference that can be passed as the "default object"
to the constructor to indicate that no default is desired. |
| Constructor Summary | |
| public | BooleanConverter()
Create a
org.apache.commons.beanutils.Converter that will throw a
ConversionException if a conversion error occurs, ie the string value being converted is
not one of the known true strings, nor one of the known false strings. | | public | BooleanConverter(Object defaultValue)
Create a
org.apache.commons.beanutils.Converter that will return the specified default value
if a conversion error occurs, ie the string value being converted is
not one of the known true strings, nor one of the known false strings.
Parameters:
defaultValue - The default value to be returned if the valuebeing converted is not recognised. | | public | BooleanConverter(String[] trueStrings, String[] falseStrings)
Create a
org.apache.commons.beanutils.Converter that will throw a
ConversionException if a conversion error occurs, ie the string value being converted is
not one of the known true strings, nor one of the known false strings.
The provided string arrays are copied, so that changes to the elements
of the array after this call is made do not affect this object.
Parameters:
trueStrings - is the set of strings which should convert to thevalue Boolean.TRUE. | | public | BooleanConverter(String[] trueStrings, String[] falseStrings, Object defaultValue)
Create a
org.apache.commons.beanutils.Converter that will return
the specified default value if a conversion error occurs.
The provided string arrays are copied, so that changes to the elements
of the array after this call is made do not affect this object.
Parameters:
trueStrings - is the set of strings which should convert to thevalue Boolean.TRUE. |
| Method Summary | |
| protected Object | convertToType(Class type, Object value)
Convert the specified input object into an output object of the
specified type.
Parameters:
type - is the type to which this value should be converted. |
| NO_DEFAULT | | final public static Object NO_DEFAULT(Code) | | This is a special reference that can be passed as the "default object"
to the constructor to indicate that no default is desired. Note that
the value 'null' cannot be used for this purpose, as the caller may
want a null to be returned as the default.
|
| BooleanConverter | | public BooleanConverter(Object defaultValue)(Code) | | Create a
org.apache.commons.beanutils.Converter that will return the specified default value
if a conversion error occurs, ie the string value being converted is
not one of the known true strings, nor one of the known false strings.
Parameters:
defaultValue - The default value to be returned if the valuebeing converted is not recognised. This value may be null, in whichcase null will be returned on conversion failure. When non-null, it isexpected that this value will be either Boolean.TRUE or Boolean.FALSE.The special value BooleanConverter.NO_DEFAULT can also be passed here,in which case this constructor acts like the no-argument one. |
| BooleanConverter | | public BooleanConverter(String[] trueStrings, String[] falseStrings)(Code) | | Create a
org.apache.commons.beanutils.Converter that will throw a
ConversionException if a conversion error occurs, ie the string value being converted is
not one of the known true strings, nor one of the known false strings.
The provided string arrays are copied, so that changes to the elements
of the array after this call is made do not affect this object.
Parameters:
trueStrings - is the set of strings which should convert to thevalue Boolean.TRUE. The value null must not be present. Case isignored.
Parameters:
falseStrings - is the set of strings which should convert to thevalue Boolean.TRUE. The value null must not be present. Case isignored. |
| BooleanConverter | | public BooleanConverter(String[] trueStrings, String[] falseStrings, Object defaultValue)(Code) | | Create a
org.apache.commons.beanutils.Converter that will return
the specified default value if a conversion error occurs.
The provided string arrays are copied, so that changes to the elements
of the array after this call is made do not affect this object.
Parameters:
trueStrings - is the set of strings which should convert to thevalue Boolean.TRUE. The value null must not be present. Case isignored.
Parameters:
falseStrings - is the set of strings which should convert to thevalue Boolean.TRUE. The value null must not be present. Case isignored.
Parameters:
defaultValue - The default value to be returned if the valuebeing converted is not recognised. This value may be null, in whichcase null will be returned on conversion failure. When non-null, it isexpected that this value will be either Boolean.TRUE or Boolean.FALSE.The special value BooleanConverter.NO_DEFAULT can also be passed here,in which case an exception will be thrown on conversion failure. |
| convertToType | | protected Object convertToType(Class type, Object value) throws Throwable(Code) | | Convert the specified input object into an output object of the
specified type.
Parameters:
type - is the type to which this value should be converted. In thecase of this BooleanConverter class, this value is ignored.
Parameters:
value - is the input value to be converted. The toString methodshall be invoked on this object, and the result compared (ignoringcase) against the known "true" and "false" string values. Boolean.TRUE if the value was a recognised "true" value, Boolean.FALSE if the value was a recognised "false" value, orthe default value if the value was not recognised and the constructorwas provided with a default value.
throws:
Throwable - if an error occurs converting to the specified type |
|
|