Class IntegerValidator
- java.lang.Object
-
- org.apache.commons.validator.routines.AbstractFormatValidator
-
- org.apache.commons.validator.routines.AbstractNumberValidator
-
- org.apache.commons.validator.routines.IntegerValidator
-
- All Implemented Interfaces:
java.io.Serializable
public class IntegerValidator extends AbstractNumberValidator
Integer Validation and Conversion routines (
java.lang.Integer
).This validator provides a number of methods for validating/converting a
String
value to aInteger
usingjava.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 thevalidate()
methods to validate and receive a convertedInteger
value.Once a value has been successfully 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
- Since:
- Validator 1.3.0
- Version:
- $Revision: 1782756 $
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class org.apache.commons.validator.routines.AbstractNumberValidator
CURRENCY_FORMAT, PERCENT_FORMAT, STANDARD_FORMAT
-
-
Constructor Summary
Constructors Constructor Description IntegerValidator()
Construct a strict instance.IntegerValidator(boolean strict, int formatType)
Construct an instance with the specified strict setting and format type.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static IntegerValidator
getInstance()
Return a singleton instance of this validator.boolean
isInRange(int value, int min, int max)
Check if the value is within a specified range.boolean
isInRange(java.lang.Integer value, int min, int max)
Check if the value is within a specified range.boolean
maxValue(int value, int max)
Check if the value is less than or equal to a maximum.boolean
maxValue(java.lang.Integer value, int max)
Check if the value is less than or equal to a maximum.boolean
minValue(int value, int min)
Check if the value is greater than or equal to a minimum.boolean
minValue(java.lang.Integer value, int min)
Check if the value is greater than or equal to a minimum.protected java.lang.Object
processParsedValue(java.lang.Object value, java.text.Format formatter)
Perform further validation and convert theNumber
to anInteger
.java.lang.Integer
validate(java.lang.String value)
Validate/convert anInteger
using the defaultLocale
.java.lang.Integer
validate(java.lang.String value, java.lang.String pattern)
Validate/convert anInteger
using the specified pattern.java.lang.Integer
validate(java.lang.String value, java.lang.String pattern, java.util.Locale locale)
Validate/convert aInteger
using the specified pattern and/ orLocale
.java.lang.Integer
validate(java.lang.String value, java.util.Locale locale)
Validate/convert anInteger
using the specifiedLocale
.-
Methods inherited from class org.apache.commons.validator.routines.AbstractNumberValidator
determineScale, getFormat, getFormat, getFormatType, isAllowFractions, isInRange, isValid, maxValue, minValue, parse
-
-
-
-
Constructor Detail
-
IntegerValidator
public IntegerValidator()
Construct a strict instance.
-
IntegerValidator
public IntegerValidator(boolean strict, int formatType)
Construct an instance with the specified strict setting and format type.
The
formatType
specified what type ofNumberFormat
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 strictFormat
parsing should be used.formatType
- TheNumberFormat
type to create for validation, default is STANDARD_FORMAT.
-
-
Method Detail
-
getInstance
public static IntegerValidator getInstance()
Return a singleton instance of this validator.- Returns:
- A singleton instance of the IntegerValidator.
-
validate
public java.lang.Integer validate(java.lang.String value)
Validate/convert an
Integer
using the defaultLocale
.- Parameters:
value
- The value validation is being performed on.- Returns:
- The parsed
Integer
if valid ornull
if invalid.
-
validate
public java.lang.Integer validate(java.lang.String value, java.lang.String pattern)
Validate/convert an
Integer
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
Integer
if valid ornull
if invalid.
-
validate
public java.lang.Integer validate(java.lang.String value, java.util.Locale locale)
Validate/convert an
Integer
using the specifiedLocale
.- 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
Integer
if valid ornull
if invalid.
-
validate
public java.lang.Integer validate(java.lang.String value, java.lang.String pattern, java.util.Locale locale)
Validate/convert a
Integer
using the specified pattern and/ orLocale
.- Parameters:
value
- The value validation is being performed on.pattern
- The pattern used to validate the value against, or the default for theLocale
ifnull
.locale
- The locale to use for the date format, system default if null.- Returns:
- The parsed
Integer
if valid ornull
if invalid.
-
isInRange
public boolean isInRange(int value, int min, int max)
Check if the value is within a specified range.- Parameters:
value
- TheNumber
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.
-
isInRange
public boolean isInRange(java.lang.Integer value, int min, int max)
Check if the value is within a specified range.- Parameters:
value
- TheNumber
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.
-
minValue
public boolean minValue(int value, int 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.
-
minValue
public boolean minValue(java.lang.Integer value, int 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.
-
maxValue
public boolean maxValue(int value, int 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.
-
maxValue
public boolean maxValue(java.lang.Integer value, int 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.
-
processParsedValue
protected java.lang.Object processParsedValue(java.lang.Object value, java.text.Format formatter)
Perform further validation and convert the
Number
to anInteger
.- Specified by:
processParsedValue
in classAbstractNumberValidator
- Parameters:
value
- The parsedNumber
object created.formatter
- The Format used to parse the value with.- Returns:
- The parsed
Number
converted to anInteger
if valid ornull
if invalid.
-
-