Class LongValidator
- java.lang.Object
-
- org.apache.commons.validator.routines.AbstractFormatValidator
-
- org.apache.commons.validator.routines.AbstractNumberValidator
-
- org.apache.commons.validator.routines.LongValidator
-
- All Implemented Interfaces:
java.io.Serializable
public class LongValidator extends AbstractNumberValidator
Long Validation and Conversion routines (
java.lang.Long
).This validator provides a number of methods for validating/converting a
String
value to aLong
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 convertedLong
value.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 a specified pattern
- using the format for a specified
Locale
- using the format for the default
Locale
- Since:
- Validator 1.3.0
- Version:
- $Revision: 478334 $ $Date: 2006-11-22 21:31:54 +0000 (Wed, 22 Nov 2006) $
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description private static LongValidator
VALIDATOR
-
Fields inherited from class org.apache.commons.validator.routines.AbstractNumberValidator
CURRENCY_FORMAT, PERCENT_FORMAT, STANDARD_FORMAT
-
-
Constructor Summary
Constructors Constructor Description LongValidator()
Construct a strict instance.LongValidator(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 LongValidator
getInstance()
Return a singleton instance of this validator.boolean
isInRange(long value, long min, long max)
Check if the value is within a specified range.boolean
isInRange(java.lang.Long value, long min, long max)
Check if the value is within a specified range.boolean
maxValue(long value, long max)
Check if the value is less than or equal to a maximum.boolean
maxValue(java.lang.Long value, long max)
Check if the value is less than or equal to a maximum.boolean
minValue(long value, long min)
Check if the value is greater than or equal to a minimum.boolean
minValue(java.lang.Long value, long 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)
Convert the parsed value to aLong
.java.lang.Long
validate(java.lang.String value)
Validate/convert aLong
using the defaultLocale
.java.lang.Long
validate(java.lang.String value, java.lang.String pattern)
Validate/convert aLong
using the specified pattern.java.lang.Long
validate(java.lang.String value, java.lang.String pattern, java.util.Locale locale)
Validate/convert aLong
using the specified pattern and/ orLocale
.java.lang.Long
validate(java.lang.String value, java.util.Locale locale)
Validate/convert aLong
using the specifiedLocale
.-
Methods inherited from class org.apache.commons.validator.routines.AbstractNumberValidator
determineScale, getFormat, getFormat, getFormatType, isAllowFractions, isInRange, isValid, maxValue, minValue, parse
-
-
-
-
Field Detail
-
VALIDATOR
private static final LongValidator VALIDATOR
-
-
Constructor Detail
-
LongValidator
public LongValidator()
Construct a strict instance.
-
LongValidator
public LongValidator(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 LongValidator getInstance()
Return a singleton instance of this validator.- Returns:
- A singleton instance of the LongValidator.
-
validate
public java.lang.Long validate(java.lang.String value)
Validate/convert a
Long
using the defaultLocale
.- Parameters:
value
- The value validation is being performed on.- Returns:
- The parsed
Long
if valid ornull
if invalid.
-
validate
public java.lang.Long validate(java.lang.String value, java.lang.String pattern)
Validate/convert a
Long
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
Long
if valid ornull
if invalid.
-
validate
public java.lang.Long validate(java.lang.String value, java.util.Locale locale)
Validate/convert a
Long
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
Long
if valid ornull
if invalid.
-
validate
public java.lang.Long validate(java.lang.String value, java.lang.String pattern, java.util.Locale locale)
Validate/convert a
Long
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
Long
if valid ornull
if invalid.
-
isInRange
public boolean isInRange(long value, long min, long 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.Long value, long min, long 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(long 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.
-
minValue
public boolean minValue(java.lang.Long 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.
-
maxValue
public boolean maxValue(long 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.
-
maxValue
public boolean maxValue(java.lang.Long 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.
-
processParsedValue
protected java.lang.Object processParsedValue(java.lang.Object value, java.text.Format formatter)
Convert the parsed value to aLong
.- 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 aLong
.
-
-