Class NumberConverter
java.lang.Object
org.apache.commons.beanutils.converters.AbstractConverter
org.apache.commons.beanutils.converters.NumberConverter
- All Implemented Interfaces:
Converter
- Direct Known Subclasses:
BigDecimalConverter,BigIntegerConverter,ByteConverter,DoubleConverter,FloatConverter,IntegerConverter,LongConverter,ShortConverter
Converter implementation that handles conversion
to and from java.lang.Number objects.
This implementation handles conversion for the following
java.lang.Number types.
java.lang.Bytejava.lang.Shortjava.lang.Integerjava.lang.Longjava.lang.Floatjava.lang.Doublejava.math.BigDecimaljava.math.BigInteger
String Conversions (to and from)
This class provides a number of ways in which number conversions to/from Strings can be achieved:- Using the default format for the default Locale, configure using:
setUseLocaleFormat(true)
- Using the default format for a specified Locale, configure using:
setLocale(Locale)
- Using a specified pattern for the default Locale, configure using:
setPattern(String)
- Using a specified pattern for a specified Locale, configure using:
setPattern(String)setLocale(Locale)
- If none of the above are configured the
toNumber(String)method is used to convert from String to Number and the Number'stoString()method used to convert from Number to String.
N.B.Patterns can only be specified using the standard
pattern characters and NOT in localized form (see java.text.DecimalFormat).
For example to cater for number styles used in Germany such as 0.000,00 the pattern
is specified in the normal form 0,000.00 and the locale set to Locale.GERMANY.
- Since:
- 1.8.0
-
Constructor Summary
ConstructorsConstructorDescriptionNumberConverter(boolean allowDecimals) Construct a java.lang.Number Converter that throws aConversionExceptionif a error occurs.NumberConverter(boolean allowDecimals, Object defaultValue) Construct ajava.lang.NumberConverter that returns a default value if an error occurs. -
Method Summary
Modifier and TypeMethodDescriptionprotected StringconvertToString(Object value) Convert an input Number object into a String.protected <T> TconvertToType(Class<T> targetType, Object value) Convert the input object into a Number object of the specified type.Return the Locale for the Converter (ornullif none specified).Return the number format pattern used to convert Numbers to/from ajava.lang.String(ornullif none specified).booleanTests whether decimals are allowed in the number.voidSet the Locale for the Converter.voidsetPattern(String pattern) Set a number format pattern to use to convert Numbers to/from ajava.lang.String.voidsetUseLocaleFormat(boolean useLocaleFormat) Set whether a format should be used to convert the Number.toString()Provide a String representation of this number converter.Methods inherited from class org.apache.commons.beanutils.converters.AbstractConverter
conversionException, convert, convertArray, getDefault, getDefaultType, handleError, handleMissing, isUseDefault, setDefaultValue
-
Constructor Details
-
NumberConverter
Construct a java.lang.Number Converter that throws aConversionExceptionif a error occurs.- Parameters:
allowDecimals- Indicates whether decimals are allowed
-
NumberConverter
Construct ajava.lang.NumberConverter that returns a default value if an error occurs.- Parameters:
allowDecimals- Indicates whether decimals are alloweddefaultValue- The default value to be returned
-
-
Method Details
-
convertToString
Convert an input Number object into a String.- Overrides:
convertToStringin classAbstractConverter- Parameters:
value- The input value to be converted- Returns:
- the converted String value.
- Throws:
Throwable- if an error occurs converting to a String
-
convertToType
Convert the input object into a Number object of the specified type.- Specified by:
convertToTypein classAbstractConverter- Type Parameters:
T- Target type of the conversion.- Parameters:
targetType- 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
-
getLocale
Return the Locale for the Converter (ornullif none specified).- Returns:
- The locale to use for conversion
-
getPattern
Return the number format pattern used to convert Numbers to/from ajava.lang.String(ornullif none specified).See
java.text.DecimalFormatfor details of how to specify the pattern.- Returns:
- The format pattern.
-
isAllowDecimals
Tests whether decimals are allowed in the number.- Returns:
- Whether decimals are allowed in the number
-
setLocale
Set the Locale for the Converter.- Parameters:
locale- The locale to use for conversion
-
setPattern
Set a number format pattern to use to convert Numbers to/from ajava.lang.String.See
java.text.DecimalFormatfor details of how to specify the pattern.- Parameters:
pattern- The format pattern.
-
setUseLocaleFormat
Set whether a format should be used to convert the Number.- Parameters:
useLocaleFormat-trueif a number format should be used.
-
toString
Provide a String representation of this number converter.- Overrides:
toStringin classAbstractConverter- Returns:
- A String representation of this number converter
-