Class DoubleValidator

java.lang.Object

org.apache.commons.validator.routines.AbstractFormatValidator

org.apache.commons.validator.routines.AbstractNumberValidator

org.apache.commons.validator.routines.DoubleValidator

All Implemented Interfaces:

Serializable

public class DoubleValidator
extends AbstractNumberValidator

Double Validation and Conversion routines (Double).

This validator provides a number of methods for validating/converting a String value to a Double using 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 the validate() methods to validate and receive a converted Double 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:

1.3.0

See Also:

• Serialized Form

Field Summary

Fields inherited from class AbstractNumberValidator

CURRENCY_FORMAT, PERCENT_FORMAT, STANDARD_FORMAT

Modifier and Type	Field	Description
static final int	CURRENCY_FORMAT	Currency NumberFormat type.
static final int	PERCENT_FORMAT	Percent NumberFormat type.
static final int	STANDARD_FORMAT	Standard NumberFormat type.

Constructor Summary

Constructors

Constructor	Description
DoubleValidator()	Constructs a strict instance.
DoubleValidator(boolean strict, int formatType)	Construct an instance with the specified strict setting and format type.

Method Summary

Modifier and Type	Method	Description
static DoubleValidator	getInstance()	Gets the singleton instance of this validator.
boolean	isInRange(double value, double min, double max)	Check if the value is within a specified range.
boolean	isInRange(Double value, double min, double max)	Check if the value is within a specified range.
boolean	maxValue(double value, double max)	Check if the value is less than or equal to a maximum.
boolean	maxValue(Double value, double max)	Check if the value is less than or equal to a maximum.
boolean	maxValue(Number value, Number max)	Tests if the value is less than or equal to a maximum, comparing the exact values.
boolean	minValue(double value, double min)	Check if the value is greater than or equal to a minimum.
boolean	minValue(Double value, double min)	Check if the value is greater than or equal to a minimum.
boolean	minValue(Number value, Number min)	Tests if the value is greater than or equal to a minimum, comparing the exact values.
protected Object	processParsedValue(Object value, Format formatter)	Convert the parsed value to a Double.
Double	validate(String value)	Validate/convert a Double using the default Locale.
Double	validate(String value, String pattern)	Validate/convert a Double using the specified pattern.
Double	validate(String value, String pattern, Locale locale)	Validate/convert a Double using the specified pattern and/ or Locale.
Double	validate(String value, Locale locale)	Validate/convert a Double using the specified Locale.

Methods inherited from class AbstractNumberValidator

determineScale, getFormat, getFormat, getFormatType, isAllowFractions, isInRange, isValid, parse

Modifier and Type	Method	Description
protected int	determineScale(NumberFormat format)	Returns the multiplier of the NumberFormat.
protected Format	getFormat(String pattern, Locale locale)	Gets a NumberFormat for the specified pattern and/or Locale.
protected Format	getFormat(Locale locale)	Gets the NumberFormat for the specified Locale.
int	getFormatType()	Gets the type of NumberFormat created by this validator instance.
boolean	isAllowFractions()	Tests whether the number being validated is a decimal or integer.
boolean	isInRange(Number value, Number min, Number max)	Tests if the value is within a specified range.
boolean	isValid(String value, String pattern, Locale locale)	Tests validity using the specified Locale.
protected Object	parse(String value, String pattern, Locale locale)	Parses the value using the specified pattern.

Methods inherited from class AbstractFormatValidator

format, format, format, format, format, isStrict, isValid, isValid, isValid, parse

Modifier and Type	Method	Description
String	format(Object value)	Formats an object into a String using the default Locale.
String	format(Object value, String pattern)	Formats an object into a String using the specified pattern.
String	format(Object value, String pattern, Locale locale)	Formats an object using the specified pattern and/or Locale.
protected String	format(Object value, Format formatter)	Formats a value with the specified Format.
String	format(Object value, Locale locale)	Formats an object into a String using the specified Locale.
boolean	isStrict()	Tests whether validated values should adhere strictly to the Format used.
boolean	isValid(String value)	Validates using the default Locale.
boolean	isValid(String value, String pattern)	Validates using the specified pattern.
boolean	isValid(String value, Locale locale)	Validates using the specified Locale.
protected Object	parse(String value, Format formatter)	Parses the value with the specified Format.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DoubleValidator

public DoubleValidator()

Constructs a strict instance.

DoubleValidator

public DoubleValidator(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 DoubleValidator getInstance()

Gets the singleton instance of this validator.

Returns:

A singleton instance of the DoubleValidator.

isInRange

public boolean isInRange(double value,
 double min,
 double 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(Double value,
 double min,
 double 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(double value,
 double 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(Double value,
 double 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(Number value,
 Number max)

Tests if the value is less than or equal to a maximum, comparing the exact values.

This overrides the Number overload inherited from the superclass, which narrows the bound to a double before comparing and so loses precision for a BigDecimal or BigInteger bound that carries more significant digits than a double can hold. A non-finite Double or Float operand keeps the doubleValue() comparison so the documented infinity behavior is unchanged.

Overrides:

maxValue in class AbstractNumberValidator

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(double value,
 double 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(Double value,
 double 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(Number value,
 Number min)

Tests if the value is greater than or equal to a minimum, comparing the exact values.

This overrides the Number overload inherited from the superclass, which narrows the bound to a double before comparing and so loses precision for a BigDecimal or BigInteger bound that carries more significant digits than a double can hold. A non-finite Double or Float operand keeps the doubleValue() comparison so the documented infinity behavior is unchanged.

Overrides:

minValue in class AbstractNumberValidator

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 Double.

Specified by:

processParsedValue in class AbstractNumberValidator

Parameters:

value - The parsed Number object created.

formatter - The Format used to parse the value with.

Returns:

The validated/converted Double value if valid or null if invalid.

validate

public Double validate(String value)

Validate/convert a Double using the default Locale.

Parameters:

value - The value validation is being performed on.

Returns:

The parsed Double if valid or null if invalid.

validate

public Double validate(String value,
 Locale locale)

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

validate

public Double validate(String value,
 String pattern)

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

validate

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

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