org.apache.commons.validator.routines
Class IntegerValidator

java.lang.Object
  extended by org.apache.commons.validator.routines.AbstractFormatValidator
      extended by org.apache.commons.validator.routines.AbstractNumberValidator
          extended by org.apache.commons.validator.routines.IntegerValidator
All Implemented Interfaces:
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 a Integer 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 Integer 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:

Since:
Validator 1.3.0
Version:
$Revision: 493905 $ $Date: 2007-01-08 03:11:38 +0100 (Mo, 08. Jan 2007) $
See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.apache.commons.validator.routines.AbstractNumberValidator
CURRENCY_FORMAT, PERCENT_FORMAT, STANDARD_FORMAT
 
Constructor Summary
IntegerValidator()
          Construct a strict instance.
IntegerValidator(boolean strict, int formatType)
          Construct an instance with the specified strict setting and format type.
 
Method Summary
static IntegerValidator getInstance()
          Return a singleton instance of this validator.
 boolean isInRange(Integer value, int min, int max)
          Check if the value is within a specified range.
 boolean isInRange(int value, int min, int max)
          Check if the value is within a specified range.
 boolean maxValue(Integer value, int max)
          Check if the value is less than or equal to a maximum.
 boolean maxValue(int value, int max)
          Check if the value is less than or equal to a maximum.
 boolean minValue(Integer value, int min)
          Check if the value is greater than or equal to a minimum.
 boolean minValue(int value, int min)
          Check if the value is greater than or equal to a minimum.
protected  Object processParsedValue(Object value, Format formatter)
          Perform further validation and convert the Number to an Integer.
 Integer validate(String value)
          Validate/convert an Integer using the default Locale.
 Integer validate(String value, Locale locale)
          Validate/convert an Integer using the specified Locale.
 Integer validate(String value, String pattern)
          Validate/convert an Integer using the specified pattern.
 Integer validate(String value, String pattern, Locale locale)
          Validate/convert a Integer 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
 
Methods inherited from class org.apache.commons.validator.routines.AbstractFormatValidator
format, format, format, format, format, isStrict, isValid, isValid, isValid, parse
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

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 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.
Method Detail

getInstance

public static IntegerValidator getInstance()
Return a singleton instance of this validator.

Returns:
A singleton instance of the IntegerValidator.

validate

public Integer validate(String value)

Validate/convert an Integer using the default Locale.

Parameters:
value - The value validation is being performed on.
Returns:
The parsed Integer if valid or null if invalid.

validate

public Integer validate(String value,
                        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 or null if invalid.

validate

public Integer validate(String value,
                        Locale locale)

Validate/convert an Integer 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 Integer if valid or null if invalid.

validate

public Integer validate(String value,
                        String pattern,
                        Locale locale)

Validate/convert a Integer 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 Integer if valid or null if invalid.

isInRange

public boolean isInRange(int value,
                         int min,
                         int 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.

isInRange

public boolean isInRange(Integer value,
                         int min,
                         int 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.

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(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(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 Object processParsedValue(Object value,
                                    Format formatter)

Perform further validation and convert the Number to an Integer.

Specified by:
processParsedValue in class AbstractNumberValidator
Parameters:
value - The parsed Number object created.
formatter - The Format used to parse the value with.
Returns:
The parsed Number converted to an Integer if valid or null if invalid.


Copyright © 2002-2010 Apache Software Foundation. All Rights Reserved.