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 * https://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;
18
19 import java.text.Format;
20 import java.text.NumberFormat;
21 import java.util.Locale;
22
23 /**
24 * <p><strong>Double Validation</strong> and Conversion routines ({@code java.lang.Double}).</p>
25 *
26 * <p>This validator provides a number of methods for
27 * validating/converting a {@link String} value to
28 * a {@code Double} using {@link NumberFormat}
29 * to parse either:</p>
30 * <ul>
31 * <li>using the default format for the default {@link Locale}</li>
32 * <li>using a specified pattern with the default {@link Locale}</li>
33 * <li>using the default format for a specified {@link Locale}</li>
34 * <li>using a specified pattern with a specified {@link Locale}</li>
35 * </ul>
36 *
37 * <p>Use one of the {@code isValid()} methods to just validate or
38 * one of the {@code validate()} methods to validate and receive a
39 * <em>converted</em> {@code Double} value.</p>
40 *
41 * <p>Once a value has been successfully converted the following
42 * methods can be used to perform minimum, maximum and range checks:</p>
43 * <ul>
44 * <li>{@code minValue()} checks whether the value is greater
45 * than or equal to a specified minimum.</li>
46 * <li>{@code maxValue()} checks whether the value is less
47 * than or equal to a specified maximum.</li>
48 * <li>{@code isInRange()} checks whether the value is within
49 * a specified range of values.</li>
50 * </ul>
51 *
52 * <p>So that the same mechanism used for parsing an <em>input</em> value
53 * for validation can be used to format <em>output</em>, corresponding
54 * {@code format()} methods are also provided. That is you can
55 * format either:</p>
56 * <ul>
57 * <li>using the default format for the default {@link Locale}</li>
58 * <li>using a specified pattern with the default {@link Locale}</li>
59 * <li>using the default format for a specified {@link Locale}</li>
60 * <li>using a specified pattern with a specified {@link Locale}</li>
61 * </ul>
62 *
63 * @since 1.3.0
64 */
65 public class DoubleValidator extends AbstractNumberValidator {
66
67 private static final long serialVersionUID = 5867946581318211330L;
68
69 private static final DoubleValidator VALIDATOR = new DoubleValidator();
70
71 /**
72 * Gets the singleton instance of this validator.
73 * @return A singleton instance of the DoubleValidator.
74 */
75 public static DoubleValidator getInstance() {
76 return VALIDATOR;
77 }
78
79 /**
80 * Constructs a <em>strict</em> instance.
81 */
82 public DoubleValidator() {
83 this(true, STANDARD_FORMAT);
84 }
85
86 /**
87 * <p>Construct an instance with the specified strict setting
88 * and format type.</p>
89 *
90 * <p>The {@code formatType} specified what type of
91 * {@code NumberFormat} is created - valid types
92 * are:</p>
93 * <ul>
94 * <li>AbstractNumberValidator.STANDARD_FORMAT -to create
95 * <em>standard</em> number formats (the default).</li>
96 * <li>AbstractNumberValidator.CURRENCY_FORMAT -to create
97 * <em>currency</em> number formats.</li>
98 * <li>AbstractNumberValidator.PERCENT_FORMAT -to create
99 * <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 DoubleValidator(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 double value, final double min, final double 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 Double value, final double min, final double max) {
134 return isInRange(value.doubleValue(), 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 double value, final double 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 Double value, final double max) {
158 return maxValue(value.doubleValue(), 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 double value, final double 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 Double value, final double min) {
182 return minValue(value.doubleValue(), min);
183 }
184
185 /**
186 * Convert the parsed value to a {@code Double}.
187 *
188 * @param value The parsed {@code Number} object created.
189 * @param formatter The Format used to parse the value with.
190 * @return The validated/converted {@code Double} value if valid
191 * or {@code null} if invalid.
192 */
193 @Override
194 protected Object processParsedValue(final Object value, final Format formatter) {
195 if (value instanceof Double) {
196 return value;
197 }
198 return Double.valueOf(((Number) value).doubleValue());
199
200 }
201
202 /**
203 * <p>Validate/convert a {@code Double} using the default
204 * {@link Locale}.
205 *
206 * @param value The value validation is being performed on.
207 * @return The parsed {@code Double} if valid or {@code null}
208 * if invalid.
209 */
210 public Double validate(final String value) {
211 return (Double) parse(value, (String) null, (Locale) null);
212 }
213
214 /**
215 * <p>Validate/convert a {@code Double} using the
216 * specified {@link Locale}.
217 *
218 * @param value The value validation is being performed on.
219 * @param locale The locale to use for the number format, system default if null.
220 * @return The parsed {@code Double} if valid or {@code null} if invalid.
221 */
222 public Double validate(final String value, final Locale locale) {
223 return (Double) parse(value, (String) null, locale);
224 }
225
226 /**
227 * <p>Validate/convert a {@code Double} using the
228 * specified <em>pattern</em>.
229 *
230 * @param value The value validation is being performed on.
231 * @param pattern The pattern used to validate the value against.
232 * @return The parsed {@code BigDecimal} if valid or {@code null} if invalid.
233 */
234 public Double validate(final String value, final String pattern) {
235 return (Double) parse(value, pattern, (Locale) null);
236 }
237
238 /**
239 * <p>Validate/convert a {@code Double} using the
240 * specified pattern and/ or {@link Locale}.
241 *
242 * @param value The value validation is being performed on.
243 * @param pattern The pattern used to validate the value against, or the
244 * default for the {@link Locale} if {@code null}.
245 * @param locale The locale to use for the date format, system default if null.
246 * @return The parsed {@code Double} if valid or {@code null} if invalid.
247 */
248 public Double validate(final String value, final String pattern, final Locale locale) {
249 return (Double) parse(value, pattern, locale);
250 }
251 }