001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.commons.validator.routines;
018
019import java.text.Format;
020import java.util.Locale;
021
022/**
023 * <p><b>Double Validation</b> and Conversion routines (<code>java.lang.Double</code>).</p>
024 *
025 * <p>This validator provides a number of methods for
026 *    validating/converting a <code>String</code> value to
027 *    a <code>Double</code> using <code>java.text.NumberFormat</code>
028 *    to parse either:</p>
029 *    <ul>
030 *       <li>using the default format for the default <code>Locale</code></li>
031 *       <li>using a specified pattern with the default <code>Locale</code></li>
032 *       <li>using the default format for a specified <code>Locale</code></li>
033 *       <li>using a specified pattern with a specified <code>Locale</code></li>
034 *    </ul>
035 *
036 * <p>Use one of the <code>isValid()</code> methods to just validate or
037 *    one of the <code>validate()</code> methods to validate and receive a
038 *    <i>converted</i> <code>Double</code> value.</p>
039 *
040 * <p>Once a value has been successfully converted the following
041 *    methods can be used to perform minimum, maximum and range checks:</p>
042 *    <ul>
043 *       <li><code>minValue()</code> checks whether the value is greater
044 *           than or equal to a specified minimum.</li>
045 *       <li><code>maxValue()</code> checks whether the value is less
046 *           than or equal to a specified maximum.</li>
047 *       <li><code>isInRange()</code> checks whether the value is within
048 *           a specified range of values.</li>
049 *    </ul>
050 *
051 * <p>So that the same mechanism used for parsing an <i>input</i> value
052 *    for validation can be used to format <i>output</i>, corresponding
053 *    <code>format()</code> methods are also provided. That is you can
054 *    format either:</p>
055 *    <ul>
056 *       <li>using the default format for the default <code>Locale</code></li>
057 *       <li>using a specified pattern with the default <code>Locale</code></li>
058 *       <li>using the default format for a specified <code>Locale</code></li>
059 *       <li>using a specified pattern with a specified <code>Locale</code></li>
060 *    </ul>
061 *
062 * @since 1.3.0
063 */
064public class DoubleValidator extends AbstractNumberValidator {
065
066    private static final long serialVersionUID = 5867946581318211330L;
067
068    private static final DoubleValidator VALIDATOR = new DoubleValidator();
069
070    /**
071     * Gets the singleton instance of this validator.
072     * @return A singleton instance of the DoubleValidator.
073     */
074    public static DoubleValidator getInstance() {
075        return VALIDATOR;
076    }
077
078    /**
079     * Constructs a <i>strict</i> instance.
080     */
081    public DoubleValidator() {
082        this(true, STANDARD_FORMAT);
083    }
084
085    /**
086     * <p>Construct an instance with the specified strict setting
087     *    and format type.</p>
088     *
089     * <p>The <code>formatType</code> specified what type of
090     *    <code>NumberFormat</code> is created - valid types
091     *    are:</p>
092     *    <ul>
093     *       <li>AbstractNumberValidator.STANDARD_FORMAT -to create
094     *           <i>standard</i> number formats (the default).</li>
095     *       <li>AbstractNumberValidator.CURRENCY_FORMAT -to create
096     *           <i>currency</i> number formats.</li>
097     *       <li>AbstractNumberValidator.PERCENT_FORMAT -to create
098     *           <i>percent</i> number formats (the default).</li>
099     *    </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    }
109
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    }
122
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    }
135
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    }
147
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    }
159
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    }
171
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    }
183
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());
198
199    }
200
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    }
212
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    }
224
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    }
236
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}