org.apache.commons.validator.routines

Class ShortValidator

public class ShortValidator extends AbstractNumberValidator

Short Validation and Conversion routines (java.lang.Short).

This validator provides a number of methods for validating/converting a String value to a Short 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 Short 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: 478334 $ $Date: 2006-11-22 21:31:54 +0000 (Wed, 22 Nov 2006) $

Field Summary
static ShortValidatorVALIDATOR
Constructor Summary
ShortValidator()
Construct a strict instance.
ShortValidator(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).
Method Summary
static ShortValidatorgetInstance()
Return a singleton instance of this validator.
booleanisInRange(short value, short min, short max)
Check if the value is within a specified range.
booleanisInRange(Short value, short min, short max)
Check if the value is within a specified range.
booleanmaxValue(short value, short max)
Check if the value is less than or equal to a maximum.
booleanmaxValue(Short value, short max)
Check if the value is less than or equal to a maximum.
booleanminValue(short value, short min)
Check if the value is greater than or equal to a minimum.
booleanminValue(Short value, short min)
Check if the value is greater than or equal to a minimum.
protected ObjectprocessParsedValue(Object value, Format formatter)

Perform further validation and convert the Number to a Short.

Shortvalidate(String value)

Validate/convert a Short using the default Locale.

Shortvalidate(String value, String pattern)

Validate/convert a Short using the specified pattern.

Shortvalidate(String value, Locale locale)

Validate/convert a Short using the specified Locale.

Shortvalidate(String value, String pattern, Locale locale)

Validate/convert a Short using the specified pattern and/ or Locale.

Field Detail

VALIDATOR

private static final ShortValidator VALIDATOR

Constructor Detail

ShortValidator

public ShortValidator()
Construct a strict instance.

ShortValidator

public ShortValidator(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 ShortValidator getInstance()
Return a singleton instance of this validator.

Returns: A singleton instance of the ShortValidator.

isInRange

public boolean isInRange(short value, short min, short 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(Short value, short min, short 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(short value, short 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(Short value, short 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(short value, short 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(Short value, short 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)

Perform further validation and convert the Number to a Short.

Parameters: value The parsed Number object created. formatter The Format used to parse the value with.

Returns: The parsed Number converted to a Short if valid or null if invalid.

validate

public Short validate(String value)

Validate/convert a Short using the default Locale.

Parameters: value The value validation is being performed on.

Returns: The parsed Short if valid or null if invalid.

validate

public Short validate(String value, String pattern)

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

validate

public Short validate(String value, Locale locale)

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

validate

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

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

Copyright (c) 2001-2004 Apache Software Foundation