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 *      https://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.text.NumberFormat;
021import java.util.Locale;
022
023/**
024 * <p><strong>Float Validation</strong> and Conversion routines ({@code java.lang.Float}).</p>
025 *
026 * <p>This validator provides a number of methods for
027 *    validating/converting a {@link String} value to
028 *    a {@code Float} using {@link NumberFormat}
029 *    to parse either:</p>
030 *    <ul>
031 *       <li>using the default format for the default {@link Locale}</li>
032 *       <li>using a specified pattern with the default {@link Locale}</li>
033 *       <li>using the default format for a specified {@link Locale}</li>
034 *       <li>using a specified pattern with a specified {@link Locale}</li>
035 *    </ul>
036 *
037 * <p>Use one of the {@code isValid()} methods to just validate or
038 *    one of the {@code validate()} methods to validate and receive a
039 *    <em>converted</em> {@code Float} value.</p>
040 *
041 * <p>Once a value has been successfully converted the following
042 *    methods can be used to perform minimum, maximum and range checks:</p>
043 *    <ul>
044 *       <li>{@code minValue()} checks whether the value is greater
045 *           than or equal to a specified minimum.</li>
046 *       <li>{@code maxValue()} checks whether the value is less
047 *           than or equal to a specified maximum.</li>
048 *       <li>{@code isInRange()} checks whether the value is within
049 *           a specified range of values.</li>
050 *    </ul>
051 *
052 * <p>So that the same mechanism used for parsing an <em>input</em> value
053 *    for validation can be used to format <em>output</em>, corresponding
054 *    {@code format()} methods are also provided. That is you can
055 *    format either:</p>
056 *    <ul>
057 *       <li>using the default format for the default {@link Locale}</li>
058 *       <li>using a specified pattern with the default {@link Locale}</li>
059 *       <li>using the default format for a specified {@link Locale}</li>
060 *       <li>using a specified pattern with a specified {@link Locale}</li>
061 *    </ul>
062 *
063 * @since 1.3.0
064 */
065public class FloatValidator extends AbstractNumberValidator {
066
067    private static final long serialVersionUID = -4513245432806414267L;
068
069    private static final FloatValidator VALIDATOR = new FloatValidator();
070
071    /**
072     * Gets the singleton instance of this validator.
073     * @return A singleton instance of the FloatValidator.
074     */
075    public static FloatValidator getInstance() {
076        return VALIDATOR;
077    }
078
079    /**
080     * Constructs a <em>strict</em> instance.
081     */
082    public FloatValidator() {
083        this(true, STANDARD_FORMAT);
084    }
085
086    /**
087     * <p>Construct an instance with the specified strict setting
088     *    and format type.</p>
089     *
090     * <p>The {@code formatType} specified what type of
091     *    {@code NumberFormat} is created - valid types
092     *    are:</p>
093     *    <ul>
094     *       <li>AbstractNumberValidator.STANDARD_FORMAT -to create
095     *           <em>standard</em> number formats (the default).</li>
096     *       <li>AbstractNumberValidator.CURRENCY_FORMAT -to create
097     *           <em>currency</em> number formats.</li>
098     *       <li>AbstractNumberValidator.PERCENT_FORMAT -to create
099     *           <em>percent</em> number formats (the default).</li>
100     *    </ul>
101     *
102     * @param strict {@code true} if strict
103     *        {@code Format} parsing should be used.
104     * @param formatType The {@code NumberFormat} type to
105     *        create for validation, default is STANDARD_FORMAT.
106     */
107    public FloatValidator(final boolean strict, final int formatType) {
108        super(strict, formatType, true);
109    }
110
111    /**
112     * Check if the value is within a specified range.
113     *
114     * @param value The {@code Number} value to check.
115     * @param min The minimum value of the range.
116     * @param max The maximum value of the range.
117     * @return {@code true} if the value is within the
118     *         specified range.
119     */
120    public boolean isInRange(final float value, final float min, final float max) {
121        return value >= min && value <= max;
122    }
123
124    /**
125     * Check if the value is within a specified range.
126     *
127     * @param value The {@code Number} value to check.
128     * @param min The minimum value of the range.
129     * @param max The maximum value of the range.
130     * @return {@code true} if the value is within the
131     *         specified range.
132     */
133    public boolean isInRange(final Float value, final float min, final float max) {
134        return isInRange(value.floatValue(), min, max);
135    }
136
137    /**
138     * Check if the value is less than or equal to a maximum.
139     *
140     * @param value The value validation is being performed on.
141     * @param max The maximum value.
142     * @return {@code true} if the value is less than
143     *         or equal to the maximum.
144     */
145    public boolean maxValue(final float value, final float max) {
146        return value <= max;
147    }
148
149    /**
150     * Check if the value is less than or equal to a maximum.
151     *
152     * @param value The value validation is being performed on.
153     * @param max The maximum value.
154     * @return {@code true} if the value is less than
155     *         or equal to the maximum.
156     */
157    public boolean maxValue(final Float value, final float max) {
158        return maxValue(value.floatValue(), max);
159    }
160
161    /**
162     * Check if the value is greater than or equal to a minimum.
163     *
164     * @param value The value validation is being performed on.
165     * @param min The minimum value.
166     * @return {@code true} if the value is greater than
167     *         or equal to the minimum.
168     */
169    public boolean minValue(final float value, final float min) {
170        return value >= min;
171    }
172
173    /**
174     * Check if the value is greater than or equal to a minimum.
175     *
176     * @param value The value validation is being performed on.
177     * @param min The minimum value.
178     * @return {@code true} if the value is greater than
179     *         or equal to the minimum.
180     */
181    public boolean minValue(final Float value, final float min) {
182        return minValue(value.floatValue(), min);
183    }
184
185    /**
186     * <p>Perform further validation and convert the {@code Number} to
187     * a {@code Float}.</p>
188     *
189     * @param value The parsed {@code Number} object created.
190     * @param formatter The Format used to parse the value with.
191     * @return The parsed {@code Number} converted to a
192     *   {@code Float} if valid or {@code null} if invalid.
193     */
194    @Override
195    protected Object processParsedValue(final Object value, final Format formatter) {
196
197        final double doubleValue = ((Number) value).doubleValue();
198
199        if (doubleValue > 0) {
200            if (doubleValue < Float.MIN_VALUE || doubleValue > Float.MAX_VALUE) {
201                return null;
202            }
203        } else if (doubleValue < 0) {
204            final double posDouble = doubleValue * -1;
205            if (posDouble < Float.MIN_VALUE || posDouble > Float.MAX_VALUE) {
206                return null;
207            }
208        }
209
210        return Float.valueOf((float) doubleValue);
211
212    }
213
214    /**
215     * <p>Validate/convert a {@code Float} using the default
216     *    {@link Locale}.
217     *
218     * @param value The value validation is being performed on.
219     * @return The parsed {@code Float} if valid or {@code null}
220     *  if invalid.
221     */
222    public Float validate(final String value) {
223        return (Float) parse(value, (String) null, (Locale) null);
224    }
225
226    /**
227     * <p>Validate/convert a {@code Float} using the
228     *    specified {@link Locale}.
229     *
230     * @param value The value validation is being performed on.
231     * @param locale The locale to use for the number format, system default if null.
232     * @return The parsed {@code Float} if valid or {@code null} if invalid.
233     */
234    public Float validate(final String value, final Locale locale) {
235        return (Float) parse(value, (String) null, locale);
236    }
237
238    /**
239     * <p>Validate/convert a {@code Float} using the
240     *    specified <em>pattern</em>.
241     *
242     * @param value The value validation is being performed on.
243     * @param pattern The pattern used to validate the value against.
244     * @return The parsed {@code Float} if valid or {@code null} if invalid.
245     */
246    public Float validate(final String value, final String pattern) {
247        return (Float) parse(value, pattern, (Locale) null);
248    }
249
250    /**
251     * <p>Validate/convert a {@code Float} using the
252     *    specified pattern and/ or {@link Locale}.
253     *
254     * @param value The value validation is being performed on.
255     * @param pattern The pattern used to validate the value against, or the
256     *        default for the {@link Locale} if {@code null}.
257     * @param locale The locale to use for the date format, system default if null.
258     * @return The parsed {@code Float} if valid or {@code null} if invalid.
259     */
260    public Float validate(final String value, final String pattern, final Locale locale) {
261        return (Float) parse(value, pattern, locale);
262    }
263
264}