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>Byte Validation</b> and Conversion routines (<code>java.lang.Byte</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>Byte</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>Byte</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 ByteValidator extends AbstractNumberValidator {
65
66 private static final long serialVersionUID = 7001640945881854649L;
67
68 private static final ByteValidator VALIDATOR = new ByteValidator();
69
70 /**
71 * Gets the singleton instance of this validator.
72 * @return A singleton instance of the ByteValidator.
73 */
74 public static ByteValidator getInstance() {
75 return VALIDATOR;
76 }
77
78 /**
79 * Constructs a <i>strict</i> instance.
80 */
81 public ByteValidator() {
82 this(true, STANDARD_FORMAT);
83 }
84
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 ByteValidator(final boolean strict, final int formatType) {
107 super(strict, formatType, false);
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 byte value, final byte min, final byte 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 Byte value, final byte min, final byte max) {
133 return isInRange(value.byteValue(), 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 byte value, final byte 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 Byte value, final byte max) {
157 return maxValue(value.byteValue(), 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 byte value, final byte 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 Byte value, final byte min) {
181 return minValue(value.byteValue(), min);
182 }
183
184 /**
185 * <p>Perform further validation and convert the <code>Number</code> to
186 * a <code>Byte</code>.</p>
187 *
188 * @param value The parsed <code>Number</code> object created.
189 * @param formatter The Format used to parse the value with.
190 * @return The parsed <code>Number</code> converted to a
191 * <code>Byte</code> if valid or {@code null} if invalid.
192 */
193 @Override
194 protected Object processParsedValue(final Object value, final Format formatter) {
195
196 // Parsed value will be Long if it fits in a long and is not fractional
197 if (value instanceof Long) {
198 final long longValue = ((Long) value).longValue();
199 if (longValue >= Byte.MIN_VALUE &&
200 longValue <= Byte.MAX_VALUE) {
201 return Byte.valueOf((byte) longValue);
202 }
203 }
204 return null;
205 }
206
207 /**
208 * <p>Validate/convert a <code>Byte</code> using the default
209 * <code>Locale</code>.
210 *
211 * @param value The value validation is being performed on.
212 * @return The parsed <code>Byte</code> if valid or {@code null}
213 * if invalid.
214 */
215 public Byte validate(final String value) {
216 return (Byte) parse(value, (String) null, (Locale) null);
217 }
218
219 /**
220 * <p>Validate/convert a <code>Byte</code> using the
221 * specified <code>Locale</code>.
222 *
223 * @param value The value validation is being performed on.
224 * @param locale The locale to use for the number format, system default if null.
225 * @return The parsed <code>Byte</code> if valid or {@code null} if invalid.
226 */
227 public Byte validate(final String value, final Locale locale) {
228 return (Byte) parse(value, (String) null, locale);
229 }
230
231 /**
232 * <p>Validate/convert a <code>Byte</code> using the
233 * specified <i>pattern</i>.
234 *
235 * @param value The value validation is being performed on.
236 * @param pattern The pattern used to validate the value against.
237 * @return The parsed <code>Byte</code> if valid or {@code null} if invalid.
238 */
239 public Byte validate(final String value, final String pattern) {
240 return (Byte) parse(value, pattern, (Locale) null);
241 }
242
243 /**
244 * <p>Validate/convert a <code>Byte</code> using the
245 * specified pattern and/ or <code>Locale</code>.
246 *
247 * @param value The value validation is being performed on.
248 * @param pattern The pattern used to validate the value against, or the
249 * default for the <code>Locale</code> if {@code null}.
250 * @param locale The locale to use for the date format, system default if null.
251 * @return The parsed <code>Byte</code> if valid or {@code null} if invalid.
252 */
253 public Byte validate(final String value, final String pattern, final Locale locale) {
254 return (Byte) parse(value, pattern, locale);
255 }
256
257 }