Package org.apache.commons.validator.routines

Class PercentValidator

java.lang.Object
org.apache.commons.validator.routines.AbstractFormatValidator
org.apache.commons.validator.routines.AbstractNumberValidator
org.apache.commons.validator.routines.BigDecimalValidator
org.apache.commons.validator.routines.PercentValidator
All Implemented Interfaces:
Serializable
public class PercentValidator extends BigDecimalValidator

Percentage Validation and Conversion routines (java.math.BigDecimal).

This is one implementation of a percent validator that has the following features:

  • It is lenient about the presence of the percent symbol
  • It converts the percent to a java.math.BigDecimal

However any of the number validators can be used for percent validation. For example, if you wanted a percent validator that converts to a java.lang.Float then you can simply instantiate an FloatValidator with the appropriate format type:

... = new FloatValidator(false, FloatValidator.PERCENT_FORMAT);

Pick the appropriate validator, depending on the type (i.e Float, Double or BigDecimal) you want the percent converted to. Please note, it makes no sense to use one of the validators that doesn't handle fractions (i.e. byte, short, integer, long and BigInteger) since percentages are converted to fractions (i.e 50% is converted to 0.5).

Since:
1.3.0
See Also:

  • Constructor Details

    • PercentValidator

      public PercentValidator()
      Constructs a strict instance.

    • PercentValidator

      public PercentValidator(boolean strict)
      Constructs an instance with the specified strict setting.
      Parameters:
      strict - true if strict Format parsing should be used.

  • Method Details

    • getInstance

      public static BigDecimalValidator getInstance()
      Gets the singleton instance of this validator.
      Returns:
      A singleton instance of the PercentValidator.

    • parse

      protected Object parse(String value, Format formatter)

      Parse the value with the specified Format.

      This implementation is lenient whether the currency symbol is present or not. The default NumberFormat behavior is for the parsing to "fail" if the currency symbol is missing. This method re-parses with a format without the currency symbol if it fails initially.

      Overrides:
      parse in class AbstractFormatValidator
      Parameters:
      value - The value to be parsed.
      formatter - The Format to parse the value with.
      Returns:
      The parsed value if valid or null if invalid.