org.apache.commons.validator.routines
public class BigDecimalValidator extends AbstractNumberValidator
BigDecimal Validation and Conversion routines (java.math.BigDecimal).
This validator provides a number of methods for
validating/converting a String value to
a BigDecimal using java.text.NumberFormat
to parse either:
LocaleLocaleLocaleLocaleUse one of the isValid() methods to just validate or
one of the validate() methods to validate and receive a
converted BigDecimal value.
Fraction/decimal values are automatically trimmed to the appropriate length.
Once a value has been sucessfully converted the following methods can be used to perform minimum, maximum and range checks:
minValue() checks whether the value is greater
than or equal to a specified minimum.maxValue() checks whether the value is less
than or equal to a specified maximum.isInRange() checks whether the value is within
a specified range of values.So that the same mechanism used for parsing an input value
for validation can be used to format output, corresponding
format() methods are also provided. That is you can
format either:
LocaleLocaleLocaleLocaleSince: Validator 1.3.0
Version: $Revision: 478334 $ $Date: 2006-11-22 21:31:54 +0000 (Wed, 22 Nov 2006) $
| Field Summary | |
|---|---|
| static BigDecimalValidator | VALIDATOR |
| Constructor Summary | |
|---|---|
| BigDecimalValidator()
Construct a strict instance. | |
| BigDecimalValidator(boolean strict) Construct an instance with the specified strict setting. | |
| protected | BigDecimalValidator(boolean strict, int formatType, boolean allowFractions) Construct an instance with the specified strict setting and format type. The
|
| Method Summary | |
|---|---|
| static BigDecimalValidator | getInstance()
Return a singleton instance of this validator. |
| boolean | isInRange(BigDecimal value, double min, double max)
Check if the value is within a specified range.
|
| boolean | maxValue(BigDecimal value, double max)
Check if the value is less than or equal to a maximum.
|
| boolean | minValue(BigDecimal value, double min)
Check if the value is greater than or equal to a minimum.
|
| protected Object | processParsedValue(Object value, Format formatter)
Convert the parsed value to a BigDecimal.
|
| BigDecimal | validate(String value) Validate/convert a |
| BigDecimal | validate(String value, String pattern) Validate/convert a |
| BigDecimal | validate(String value, Locale locale) Validate/convert a |
| BigDecimal | validate(String value, String pattern, Locale locale) Validate/convert a |
Construct an instance with the specified strict setting.
Parameters: strict true if strict
Format parsing should be used.
Construct an instance with the specified strict setting and format type.
The formatType specified what type of
NumberFormat is created - valid types
are:
Parameters: strict true if strict
Format parsing should be used. formatType The NumberFormat type to
create for validation, default is STANDARD_FORMAT. allowFractions true if fractions are
allowed or false if integers only.
Returns: A singleton instance of the BigDecimalValidator.
Parameters: value The Number value to check. min The minimum value of the range. max The maximum value of the range.
Returns: true if the value is within the
specified range.
Parameters: value The value validation is being performed on. max The maximum value.
Returns: true if the value is less than
or equal to the maximum.
Parameters: value The value validation is being performed on. min The minimum value.
Returns: true if the value is greater than
or equal to the minimum.
BigDecimal.
Parameters: value The parsed Number object created. formatter The Format used to parse the value with.
Returns: The parsed Number converted to a
BigDecimal.
Validate/convert a BigDecimal using the default
Locale.
Parameters: value The value validation is being performed on.
Returns: The parsed BigDecimal if valid or null
if invalid.
Validate/convert a BigDecimal using the
specified pattern.
Parameters: value The value validation is being performed on. pattern The pattern used to validate the value against, or the
default for the Locale if null.
Returns: The parsed BigDecimal if valid or null if invalid.
Validate/convert a BigDecimal using the
specified Locale.
Parameters: value The value validation is being performed on. locale The locale to use for the number format, system default if null.
Returns: The parsed BigDecimal if valid or null if invalid.
Validate/convert a BigDecimal using the
specified pattern and/ or Locale.
Parameters: value The value validation is being performed on. pattern The pattern used to validate the value against, or the
default for the Locale if null. locale The locale to use for the date format, system default if null.
Returns: The parsed BigDecimal if valid or null if invalid.