DoubleValidator.java

  1. /*
  2.  * Licensed to the Apache Software Foundation (ASF) under one or more
  3.  * contributor license agreements.  See the NOTICE file distributed with
  4.  * this work for additional information regarding copyright ownership.
  5.  * The ASF licenses this file to You under the Apache License, Version 2.0
  6.  * (the "License"); you may not use this file except in compliance with
  7.  * the License.  You may obtain a copy of the License at
  8.  *
  9.  *      http://www.apache.org/licenses/LICENSE-2.0
  10.  *
  11.  * Unless required by applicable law or agreed to in writing, software
  12.  * distributed under the License is distributed on an "AS IS" BASIS,
  13.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14.  * See the License for the specific language governing permissions and
  15.  * limitations under the License.
  16.  */
  17. package org.apache.commons.validator.routines;

  19. import java.text.Format;
  20. import java.util.Locale;

  22. /**
  23.  * <p><b>Double Validation</b> and Conversion routines (<code>java.lang.Double</code>).</p>
  24.  *
  25.  * <p>This validator provides a number of methods for
  26.  *    validating/converting a <code>String</code> value to
  27.  *    a <code>Double</code> using <code>java.text.NumberFormat</code>
  28.  *    to parse either:</p>
  29.  *    <ul>
  30.  *       <li>using the default format for the default <code>Locale</code></li>
  31.  *       <li>using a specified pattern with the default <code>Locale</code></li>
  32.  *       <li>using the default format for a specified <code>Locale</code></li>
  33.  *       <li>using a specified pattern with a specified <code>Locale</code></li>
  34.  *    </ul>
  35.  *
  36.  * <p>Use one of the <code>isValid()</code> methods to just validate or
  37.  *    one of the <code>validate()</code> methods to validate and receive a
  38.  *    <i>converted</i> <code>Double</code> value.</p>
  39.  *
  40.  * <p>Once a value has been successfully converted the following
  41.  *    methods can be used to perform minimum, maximum and range checks:</p>
  42.  *    <ul>
  43.  *       <li><code>minValue()</code> checks whether the value is greater
  44.  *           than or equal to a specified minimum.</li>
  45.  *       <li><code>maxValue()</code> checks whether the value is less
  46.  *           than or equal to a specified maximum.</li>
  47.  *       <li><code>isInRange()</code> checks whether the value is within
  48.  *           a specified range of values.</li>
  49.  *    </ul>
  50.  *
  51.  * <p>So that the same mechanism used for parsing an <i>input</i> value
  52.  *    for validation can be used to format <i>output</i>, corresponding
  53.  *    <code>format()</code> methods are also provided. That is you can
  54.  *    format either:</p>
  55.  *    <ul>
  56.  *       <li>using the default format for the default <code>Locale</code></li>
  57.  *       <li>using a specified pattern with the default <code>Locale</code></li>
  58.  *       <li>using the default format for a specified <code>Locale</code></li>
  59.  *       <li>using a specified pattern with a specified <code>Locale</code></li>
  60.  *    </ul>
  61.  *
  62.  * @since 1.3.0
  63.  */
  64. public class DoubleValidator extends AbstractNumberValidator {

  66.     private static final long serialVersionUID = 5867946581318211330L;

  68.     private static final DoubleValidator VALIDATOR = new DoubleValidator();

  70.     /**
  71.      * Gets the singleton instance of this validator.
  72.      * @return A singleton instance of the DoubleValidator.
  73.      */
  74.     public static DoubleValidator getInstance() {
  75.         return VALIDATOR;
  76.     }

  78.     /**
  79.      * Constructs a <i>strict</i> instance.
  80.      */
  81.     public DoubleValidator() {
  82.         this(true, STANDARD_FORMAT);
  83.     }

  85.     /**
  86.      * <p>Construct an instance with the specified strict setting
  87.      *    and format type.</p>
  88.      *
  89.      * <p>The <code>formatType</code> specified what type of
  90.      *    <code>NumberFormat</code> is created - valid types
  91.      *    are:</p>
  92.      *    <ul>
  93.      *       <li>AbstractNumberValidator.STANDARD_FORMAT -to create
  94.      *           <i>standard</i> number formats (the default).</li>
  95.      *       <li>AbstractNumberValidator.CURRENCY_FORMAT -to create
  96.      *           <i>currency</i> number formats.</li>
  97.      *       <li>AbstractNumberValidator.PERCENT_FORMAT -to create
  98.      *           <i>percent</i> number formats (the default).</li>
  99.      *    </ul>
  100.      *
  101.      * @param strict {@code true} if strict
  102.      *        <code>Format</code> parsing should be used.
  103.      * @param formatType The <code>NumberFormat</code> type to
  104.      *        create for validation, default is STANDARD_FORMAT.
  105.      */
  106.     public DoubleValidator(final boolean strict, final int formatType) {
  107.         super(strict, formatType, true);
  108.     }

  110.     /**
  111.      * Check if the value is within a specified range.
  112.      *
  113.      * @param value The <code>Number</code> value to check.
  114.      * @param min The minimum value of the range.
  115.      * @param max The maximum value of the range.
  116.      * @return {@code true} if the value is within the
  117.      *         specified range.
  118.      */
  119.     public boolean isInRange(final double value, final double min, final double max) {
  120.         return value >= min && value <= max;
  121.     }

  123.     /**
  124.      * Check if the value is within a specified range.
  125.      *
  126.      * @param value The <code>Number</code> value to check.
  127.      * @param min The minimum value of the range.
  128.      * @param max The maximum value of the range.
  129.      * @return {@code true} if the value is within the
  130.      *         specified range.
  131.      */
  132.     public boolean isInRange(final Double value, final double min, final double max) {
  133.         return isInRange(value.doubleValue(), min, max);
  134.     }

  136.     /**
  137.      * Check if the value is less than or equal to a maximum.
  138.      *
  139.      * @param value The value validation is being performed on.
  140.      * @param max The maximum value.
  141.      * @return {@code true} if the value is less than
  142.      *         or equal to the maximum.
  143.      */
  144.     public boolean maxValue(final double value, final double max) {
  145.         return value <= max;
  146.     }

  148.     /**
  149.      * Check if the value is less than or equal to a maximum.
  150.      *
  151.      * @param value The value validation is being performed on.
  152.      * @param max The maximum value.
  153.      * @return {@code true} if the value is less than
  154.      *         or equal to the maximum.
  155.      */
  156.     public boolean maxValue(final Double value, final double max) {
  157.         return maxValue(value.doubleValue(), max);
  158.     }

  160.     /**
  161.      * Check if the value is greater than or equal to a minimum.
  162.      *
  163.      * @param value The value validation is being performed on.
  164.      * @param min The minimum value.
  165.      * @return {@code true} if the value is greater than
  166.      *         or equal to the minimum.
  167.      */
  168.     public boolean minValue(final double value, final double min) {
  169.         return value >= min;
  170.     }

  172.     /**
  173.      * Check if the value is greater than or equal to a minimum.
  174.      *
  175.      * @param value The value validation is being performed on.
  176.      * @param min The minimum value.
  177.      * @return {@code true} if the value is greater than
  178.      *         or equal to the minimum.
  179.      */
  180.     public boolean minValue(final Double value, final double min) {
  181.         return minValue(value.doubleValue(), min);
  182.     }

  184.     /**
  185.      * Convert the parsed value to a <code>Double</code>.
  186.      *
  187.      * @param value The parsed <code>Number</code> object created.
  188.      * @param formatter The Format used to parse the value with.
  189.      * @return The validated/converted <code>Double</code> value if valid
  190.      * or {@code null} if invalid.
  191.      */
  192.     @Override
  193.     protected Object processParsedValue(final Object value, final Format formatter) {
  194.         if (value instanceof Double) {
  195.             return value;
  196.         }
  197.         return Double.valueOf(((Number) value).doubleValue());

  199.     }

  201.     /**
  202.      * <p>Validate/convert a <code>Double</code> using the default
  203.      *    <code>Locale</code>.
  204.      *
  205.      * @param value The value validation is being performed on.
  206.      * @return The parsed <code>Double</code> if valid or {@code null}
  207.      *  if invalid.
  208.      */
  209.     public Double validate(final String value) {
  210.         return (Double) parse(value, (String) null, (Locale) null);
  211.     }

  213.     /**
  214.      * <p>Validate/convert a <code>Double</code> using the
  215.      *    specified <code>Locale</code>.
  216.      *
  217.      * @param value The value validation is being performed on.
  218.      * @param locale The locale to use for the number format, system default if null.
  219.      * @return The parsed <code>Double</code> if valid or {@code null} if invalid.
  220.      */
  221.     public Double validate(final String value, final Locale locale) {
  222.         return (Double) parse(value, (String) null, locale);
  223.     }

  225.     /**
  226.      * <p>Validate/convert a <code>Double</code> using the
  227.      *    specified <i>pattern</i>.
  228.      *
  229.      * @param value The value validation is being performed on.
  230.      * @param pattern The pattern used to validate the value against.
  231.      * @return The parsed <code>BigDecimal</code> if valid or {@code null} if invalid.
  232.      */
  233.     public Double validate(final String value, final String pattern) {
  234.         return (Double) parse(value, pattern, (Locale) null);
  235.     }

  237.     /**
  238.      * <p>Validate/convert a <code>Double</code> using the
  239.      *    specified pattern and/ or <code>Locale</code>.
  240.      *
  241.      * @param value The value validation is being performed on.
  242.      * @param pattern The pattern used to validate the value against, or the
  243.      *        default for the <code>Locale</code> if {@code null}.
  244.      * @param locale The locale to use for the date format, system default if null.
  245.      * @return The parsed <code>Double</code> if valid or {@code null} if invalid.
  246.      */
  247.     public Double validate(final String value, final String pattern, final Locale locale) {
  248.         return (Double) parse(value, pattern, locale);
  249.     }
  250. }
Created with JaCoCo 0.8.12.202403310830