Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
FloatValidator |
|
| 1.7857142857142858;1.786 |
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; | |
18 | ||
19 | import java.text.Format; | |
20 | import java.util.Locale; | |
21 | ||
22 | /** | |
23 | * <p><b>Float Validation</b> and Conversion routines (<code>java.lang.Float</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>Float</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>Float</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 | * @version $Revision: 1739356 $ | |
63 | * @since Validator 1.3.0 | |
64 | */ | |
65 | public class FloatValidator extends AbstractNumberValidator { | |
66 | ||
67 | private static final long serialVersionUID = -4513245432806414267L; | |
68 | ||
69 | 1 | private static final FloatValidator VALIDATOR = new FloatValidator(); |
70 | ||
71 | /** | |
72 | * Return a singleton instance of this validator. | |
73 | * @return A singleton instance of the FloatValidator. | |
74 | */ | |
75 | public static FloatValidator getInstance() { | |
76 | 20 | return VALIDATOR; |
77 | } | |
78 | ||
79 | /** | |
80 | * Construct a <i>strict</i> instance. | |
81 | */ | |
82 | public FloatValidator() { | |
83 | 14 | this(true, STANDARD_FORMAT); |
84 | 14 | } |
85 | ||
86 | /** | |
87 | * <p>Construct an instance with the specified strict setting | |
88 | * and format type.</p> | |
89 | * | |
90 | * <p>The <code>formatType</code> specified what type of | |
91 | * <code>NumberFormat</code> is created - valid types | |
92 | * are:</p> | |
93 | * <ul> | |
94 | * <li>AbstractNumberValidator.STANDARD_FORMAT -to create | |
95 | * <i>standard</i> number formats (the default).</li> | |
96 | * <li>AbstractNumberValidator.CURRENCY_FORMAT -to create | |
97 | * <i>currency</i> number formats.</li> | |
98 | * <li>AbstractNumberValidator.PERCENT_FORMAT -to create | |
99 | * <i>percent</i> number formats (the default).</li> | |
100 | * </ul> | |
101 | * | |
102 | * @param strict <code>true</code> if strict | |
103 | * <code>Format</code> parsing should be used. | |
104 | * @param formatType The <code>NumberFormat</code> type to | |
105 | * create for validation, default is STANDARD_FORMAT. | |
106 | */ | |
107 | public FloatValidator(boolean strict, int formatType) { | |
108 | 27 | super(strict, formatType, true); |
109 | 27 | } |
110 | ||
111 | /** | |
112 | * <p>Validate/convert a <code>Float</code> using the default | |
113 | * <code>Locale</code>. | |
114 | * | |
115 | * @param value The value validation is being performed on. | |
116 | * @return The parsed <code>Float</code> if valid or <code>null</code> | |
117 | * if invalid. | |
118 | */ | |
119 | public Float validate(String value) { | |
120 | 2 | return (Float)parse(value, (String)null, (Locale)null); |
121 | } | |
122 | ||
123 | /** | |
124 | * <p>Validate/convert a <code>Float</code> using the | |
125 | * specified <i>pattern</i>. | |
126 | * | |
127 | * @param value The value validation is being performed on. | |
128 | * @param pattern The pattern used to validate the value against. | |
129 | * @return The parsed <code>Float</code> if valid or <code>null</code> if invalid. | |
130 | */ | |
131 | public Float validate(String value, String pattern) { | |
132 | 10 | return (Float)parse(value, pattern, (Locale)null); |
133 | } | |
134 | ||
135 | /** | |
136 | * <p>Validate/convert a <code>Float</code> using the | |
137 | * specified <code>Locale</code>. | |
138 | * | |
139 | * @param value The value validation is being performed on. | |
140 | * @param locale The locale to use for the number format, system default if null. | |
141 | * @return The parsed <code>Float</code> if valid or <code>null</code> if invalid. | |
142 | */ | |
143 | public Float validate(String value, Locale locale) { | |
144 | 2 | return (Float)parse(value, (String)null, locale); |
145 | } | |
146 | ||
147 | /** | |
148 | * <p>Validate/convert a <code>Float</code> using the | |
149 | * specified pattern and/ or <code>Locale</code>. | |
150 | * | |
151 | * @param value The value validation is being performed on. | |
152 | * @param pattern The pattern used to validate the value against, or the | |
153 | * default for the <code>Locale</code> if <code>null</code>. | |
154 | * @param locale The locale to use for the date format, system default if null. | |
155 | * @return The parsed <code>Float</code> if valid or <code>null</code> if invalid. | |
156 | */ | |
157 | public Float validate(String value, String pattern, Locale locale) { | |
158 | 2 | return (Float)parse(value, pattern, locale); |
159 | } | |
160 | ||
161 | /** | |
162 | * Check if the value is within a specified range. | |
163 | * | |
164 | * @param value The <code>Number</code> value to check. | |
165 | * @param min The minimum value of the range. | |
166 | * @param max The maximum value of the range. | |
167 | * @return <code>true</code> if the value is within the | |
168 | * specified range. | |
169 | */ | |
170 | public boolean isInRange(float value, float min, float max) { | |
171 | 5 | return (value >= min && value <= max); |
172 | } | |
173 | ||
174 | /** | |
175 | * Check if the value is within a specified range. | |
176 | * | |
177 | * @param value The <code>Number</code> value to check. | |
178 | * @param min The minimum value of the range. | |
179 | * @param max The maximum value of the range. | |
180 | * @return <code>true</code> if the value is within the | |
181 | * specified range. | |
182 | */ | |
183 | public boolean isInRange(Float value, float min, float max) { | |
184 | 5 | return isInRange(value.floatValue(), min, max); |
185 | } | |
186 | ||
187 | /** | |
188 | * Check if the value is greater than or equal to a minimum. | |
189 | * | |
190 | * @param value The value validation is being performed on. | |
191 | * @param min The minimum value. | |
192 | * @return <code>true</code> if the value is greater than | |
193 | * or equal to the minimum. | |
194 | */ | |
195 | public boolean minValue(float value, float min) { | |
196 | 3 | return (value >= min); |
197 | } | |
198 | ||
199 | /** | |
200 | * Check if the value is greater than or equal to a minimum. | |
201 | * | |
202 | * @param value The value validation is being performed on. | |
203 | * @param min The minimum value. | |
204 | * @return <code>true</code> if the value is greater than | |
205 | * or equal to the minimum. | |
206 | */ | |
207 | public boolean minValue(Float value, float min) { | |
208 | 3 | return minValue(value.floatValue(), min); |
209 | } | |
210 | ||
211 | /** | |
212 | * Check if the value is less than or equal to a maximum. | |
213 | * | |
214 | * @param value The value validation is being performed on. | |
215 | * @param max The maximum value. | |
216 | * @return <code>true</code> if the value is less than | |
217 | * or equal to the maximum. | |
218 | */ | |
219 | public boolean maxValue(float value, float max) { | |
220 | 3 | return (value <= max); |
221 | } | |
222 | ||
223 | /** | |
224 | * Check if the value is less than or equal to a maximum. | |
225 | * | |
226 | * @param value The value validation is being performed on. | |
227 | * @param max The maximum value. | |
228 | * @return <code>true</code> if the value is less than | |
229 | * or equal to the maximum. | |
230 | */ | |
231 | public boolean maxValue(Float value, float max) { | |
232 | 3 | return maxValue(value.floatValue(), max); |
233 | } | |
234 | ||
235 | /** | |
236 | * <p>Perform further validation and convert the <code>Number</code> to | |
237 | * a <code>Float</code>.</p> | |
238 | * | |
239 | * @param value The parsed <code>Number</code> object created. | |
240 | * @param formatter The Format used to parse the value with. | |
241 | * @return The parsed <code>Number</code> converted to a | |
242 | * <code>Float</code> if valid or <code>null</code> if invalid. | |
243 | */ | |
244 | @Override | |
245 | protected Object processParsedValue(Object value, Format formatter) { | |
246 | ||
247 | 57 | double doubleValue = ((Number)value).doubleValue(); |
248 | ||
249 | 57 | if (doubleValue > 0) { |
250 | 45 | if (doubleValue < Float.MIN_VALUE) { |
251 | 1 | return null; |
252 | } | |
253 | 44 | if (doubleValue > Float.MAX_VALUE) { |
254 | 1 | return null; |
255 | } | |
256 | 12 | } else if (doubleValue < 0){ |
257 | 4 | double posDouble = doubleValue * -1; |
258 | 4 | if (posDouble < Float.MIN_VALUE) { |
259 | 1 | return null; |
260 | } | |
261 | 3 | if (posDouble > Float.MAX_VALUE) { |
262 | 1 | return null; |
263 | } | |
264 | } | |
265 | ||
266 | 53 | return new Float((float)doubleValue); |
267 | ||
268 | } | |
269 | ||
270 | } |