org.apache.commons.validator.routines

Class BigIntegerValidator

Implemented Interfaces:
Serializable

public class BigIntegerValidator
extends AbstractNumberValidator

BigInteger Validation and Conversion routines (java.math.BigInteger).

This validator provides a number of methods for validating/converting a String value to a BigInteger using java.text.NumberFormat to parse either:

Use one of the isValid() methods to just validate or one of the validate() methods to validate and receive a converted BigInteger value.

Once a value has been sucessfully converted the following methods can be used to perform minimum, maximum and range checks:

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:

Version:
$Revision: 478334 $ $Date: 2006-11-22 21:31:54 +0000 (Wed, 22 Nov 2006) $
Since:
Validator 1.3.0

Field Summary

private static BigIntegerValidator
VALIDATOR

Fields inherited from class org.apache.commons.validator.routines.AbstractNumberValidator

CURRENCY_FORMAT, PERCENT_FORMAT, STANDARD_FORMAT, allowFractions, formatType

Fields inherited from class org.apache.commons.validator.routines.AbstractFormatValidator

strict

Constructor Summary

BigIntegerValidator()
Construct a strict instance.
BigIntegerValidator(boolean strict, int formatType)
Construct an instance with the specified strict setting and format type.

Method Summary

static BigIntegerValidator
getInstance()
Return a singleton instance of this validator.
boolean
isInRange(BigInteger value, long min, long max)
Check if the value is within a specified range.
boolean
maxValue(BigInteger value, long max)
Check if the value is less than or equal to a maximum.
boolean
minValue(BigInteger value, long 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 BigInteger.
BigInteger
validate(String value)
Validate/convert a BigInteger using the default Locale.
BigInteger
validate(String value, Locale locale)
Validate/convert a BigInteger using the specified Locale.
BigInteger
validate(String value, String pattern)
Validate/convert a BigInteger using the specified pattern.
BigInteger
validate(String value, String pattern, Locale locale)
Validate/convert a BigInteger using the specified pattern and/ or Locale.

Methods inherited from class org.apache.commons.validator.routines.AbstractNumberValidator

determineScale, getFormat, getFormat, getFormatType, isAllowFractions, isInRange, isValid, maxValue, minValue, parse, processParsedValue

Methods inherited from class org.apache.commons.validator.routines.AbstractFormatValidator

format, format, format, format, format, getFormat, isStrict, isValid, isValid, isValid, isValid, parse, processParsedValue

Field Details

VALIDATOR

private static final BigIntegerValidator VALIDATOR

Constructor Details

BigIntegerValidator

public BigIntegerValidator()
Construct a strict instance.

BigIntegerValidator

public BigIntegerValidator(boolean strict,
                           int formatType)
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.
formatType - The NumberFormat type to create for validation, default is STANDARD_FORMAT.

Method Details

getInstance

public static BigIntegerValidator getInstance()
Return a singleton instance of this validator.
Returns:
A singleton instance of the BigIntegerValidator.

isInRange

public boolean isInRange(BigInteger value,
                         long min,
                         long max)
Check if the value is within a specified range.
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.

maxValue

public boolean maxValue(BigInteger value,
                        long max)
Check if the value is less than or equal to a maximum.
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.

minValue

public boolean minValue(BigInteger value,
                        long min)
Check if the value is greater than or equal to a minimum.
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.

processParsedValue

protected Object processParsedValue(Object value,
                                    Format formatter)
Convert the parsed value to a BigInteger.
Overrides:
processParsedValue in interface AbstractNumberValidator
Parameters:
value - The parsed Number object created.
formatter - The Format used to parse the value with.
Returns:
The parsed Number converted to a BigInteger.

validate

public BigInteger validate(String value)
Validate/convert a BigInteger using the default Locale.
Parameters:
value - The value validation is being performed on.
Returns:
The parsed BigInteger if valid or null if invalid.

validate

public BigInteger validate(String value,
                           Locale locale)
Validate/convert a BigInteger 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 BigInteger if valid or null if invalid.

validate

public BigInteger validate(String value,
                           String pattern)
Validate/convert a BigInteger using the specified pattern.
Parameters:
value - The value validation is being performed on.
pattern - The pattern used to validate the value against.
Returns:
The parsed BigInteger if valid or null if invalid.

validate

public BigInteger validate(String value,
                           String pattern,
                           Locale locale)
Validate/convert a BigInteger 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 BigInteger if valid or null if invalid.

Copyright (c) 2001-2004 Apache Software Foundation