| java.lang.Object
 org.apache.commons.validator.routines.AbstractFormatValidator
org.apache.commons.validator.routines.AbstractNumberValidator
org.apache.commons.validator.routines.BigDecimalValidator
All known Subclasses: org.apache.commons.validator.routines.CurrencyValidator, org.apache.commons.validator.routines.PercentValidator,
| BigDecimalValidator | | public class BigDecimalValidator extends AbstractNumberValidator (Code) | | 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:
- using the default format for the default
Locale
- using a specified pattern with the default
Locale
- using the default format for a specified
Locale
- using a specified pattern with a specified
Locale
Use 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:
- using the default format for the default
Locale
- using a specified pattern with the default
Locale
- using the default format for a specified
Locale
- using a specified pattern with a specified
Locale
version:
$Revision: 478334 $ $Date: 2006-11-22 21:31:54 +0000 (Wed, 22 Nov 2006) $
since:
Validator 1.3.0 |
| Method Summary | |
| public static BigDecimalValidator | getInstance()
Return a singleton instance of this validator. | | public boolean | isInRange(BigDecimal value, double min, double max)
Check if the value is within a specified range.
Parameters:
value - The Number value to check.
Parameters:
min - The minimum value of the range.
Parameters:
max - The maximum value of the range. | | public boolean | maxValue(BigDecimal value, double max)
Check if the value is less than or equal to a maximum.
Parameters:
value - The value validation is being performed on.
Parameters:
max - The maximum value. | | public boolean | minValue(BigDecimal value, double min)
Check if the value is greater than or equal to a minimum.
Parameters:
value - The value validation is being performed on.
Parameters:
min - The minimum value. | | protected Object | processParsedValue(Object value, Format formatter)
Convert the parsed value to a BigDecimal.
Parameters:
value - The parsed Number object created.
Parameters:
formatter - The Format used to parse the value with. | | public BigDecimal | validate(String value)
Validate/convert a BigDecimal using the default
Locale. | | public BigDecimal | validate(String value, String pattern)
Validate/convert a BigDecimal using the
specified pattern. | | public BigDecimal | validate(String value, Locale locale)
Validate/convert a BigDecimal using the
specified Locale. | | public BigDecimal | validate(String value, String pattern, Locale locale)
Validate/convert a BigDecimal using the
specified pattern and/ or Locale. |
| BigDecimalValidator | | public BigDecimalValidator()(Code) | | Construct a strict instance.
|
| BigDecimalValidator | | public BigDecimalValidator(boolean strict)(Code) | | Construct an instance with the specified strict setting.
Parameters:
strict - true if strict Format parsing should be used. |
| BigDecimalValidator | | protected BigDecimalValidator(boolean strict, int formatType, boolean allowFractions)(Code) | | Construct an instance with the specified strict setting
and format type.
The formatType specified what type of
NumberFormat is created - valid types
are:
- AbstractNumberValidator.STANDARD_FORMAT -to create
standard number formats (the default).
- AbstractNumberValidator.CURRENCY_FORMAT -to create
currency number formats.
- AbstractNumberValidator.PERCENT_FORMAT -to create
percent number formats (the default).
Parameters:
strict - true if strict Format parsing should be used.
Parameters:
formatType - The NumberFormat type tocreate for validation, default is STANDARD_FORMAT.
Parameters:
allowFractions - true if fractions areallowed or false if integers only. |
| getInstance | | public static BigDecimalValidator getInstance()(Code) | | Return a singleton instance of this validator.
A singleton instance of the BigDecimalValidator. |
| isInRange | | public boolean isInRange(BigDecimal value, double min, double max)(Code) | | Check if the value is within a specified range.
Parameters:
value - The Number value to check.
Parameters:
min - The minimum value of the range.
Parameters:
max - The maximum value of the range. true if the value is within thespecified range. |
| maxValue | | public boolean maxValue(BigDecimal value, double max)(Code) | | Check if the value is less than or equal to a maximum.
Parameters:
value - The value validation is being performed on.
Parameters:
max - The maximum value. true if the value is less thanor equal to the maximum. |
| minValue | | public boolean minValue(BigDecimal value, double min)(Code) | | Check if the value is greater than or equal to a minimum.
Parameters:
value - The value validation is being performed on.
Parameters:
min - The minimum value. true if the value is greater thanor equal to the minimum. |
| processParsedValue | | protected Object processParsedValue(Object value, Format formatter)(Code) | | Convert the parsed value to a BigDecimal.
Parameters:
value - The parsed Number object created.
Parameters:
formatter - The Format used to parse the value with. The parsed Number converted to a BigDecimal. |
| validate | | public BigDecimal validate(String value)(Code) | | Validate/convert a BigDecimal using the default
Locale.
Parameters:
value - The value validation is being performed on. The parsed BigDecimal if valid or nullif invalid. |
| validate | | public BigDecimal validate(String value, String pattern)(Code) | | Validate/convert a BigDecimal using the
specified pattern.
Parameters:
value - The value validation is being performed on.
Parameters:
pattern - The pattern used to validate the value against, or thedefault for the Locale if null. The parsed BigDecimal if valid or null if invalid. |
| validate | | public BigDecimal validate(String value, Locale locale)(Code) | | Validate/convert a BigDecimal using the
specified Locale.
Parameters:
value - The value validation is being performed on.
Parameters:
locale - The locale to use for the number format, system default if null. The parsed BigDecimal if valid or null if invalid. |
| validate | | public BigDecimal validate(String value, String pattern, Locale locale)(Code) | | Validate/convert a BigDecimal using the
specified pattern and/ or Locale.
Parameters:
value - The value validation is being performed on.
Parameters:
pattern - The pattern used to validate the value against, or thedefault for the Locale if null.
Parameters:
locale - The locale to use for the date format, system default if null. The parsed BigDecimal if valid or null if invalid. |
| Fields inherited from org.apache.commons.validator.routines.AbstractNumberValidator | final public static int CURRENCY_FORMAT(Code)(Java Doc)
final public static int PERCENT_FORMAT(Code)(Java Doc)
final public static int STANDARD_FORMAT(Code)(Java Doc)
|
| Methods inherited from org.apache.commons.validator.routines.AbstractNumberValidator | protected int determineScale(NumberFormat format)(Code)(Java Doc)
protected Format getFormat(String pattern, Locale locale)(Code)(Java Doc)
protected Format getFormat(Locale locale)(Code)(Java Doc)
public int getFormatType()(Code)(Java Doc)
public boolean isAllowFractions()(Code)(Java Doc)
public boolean isInRange(Number value, Number min, Number max)(Code)(Java Doc)
public boolean isValid(String value, String pattern, Locale locale)(Code)(Java Doc)
public boolean maxValue(Number value, Number max)(Code)(Java Doc)
public boolean minValue(Number value, Number min)(Code)(Java Doc)
protected Object parse(String value, String pattern, Locale locale)(Code)(Java Doc)
abstract protected Object processParsedValue(Object value, Format formatter)(Code)(Java Doc)
|
| Methods inherited from org.apache.commons.validator.routines.AbstractFormatValidator | public String format(Object value)(Code)(Java Doc)
public String format(Object value, String pattern)(Code)(Java Doc)
public String format(Object value, Locale locale)(Code)(Java Doc)
public String format(Object value, String pattern, Locale locale)(Code)(Java Doc)
protected String format(Object value, Format formatter)(Code)(Java Doc)
abstract protected Format getFormat(String pattern, Locale locale)(Code)(Java Doc)
public boolean isStrict()(Code)(Java Doc)
public boolean isValid(String value)(Code)(Java Doc)
public boolean isValid(String value, String pattern)(Code)(Java Doc)
public boolean isValid(String value, Locale locale)(Code)(Java Doc)
abstract public boolean isValid(String value, String pattern, Locale locale)(Code)(Java Doc)
protected Object parse(String value, Format formatter)(Code)(Java Doc)
abstract protected Object processParsedValue(Object value, Format formatter)(Code)(Java Doc)
|
|
|