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>Long Validation</strong> and Conversion routines ({@code java.lang.Long}).</p>
25 *
26 * <p>This validator provides a number of methods for
27 * validating/converting a {@link String} value to
28 * a {@code Long} 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 Long} 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 a specified pattern</li>
58 * <li>using the format for a specified {@link Locale}</li>
59 * <li>using the format for the <em>default</em> {@link Locale}</li>
60 * </ul>
61 *
62 * @since 1.3.0
63 */
64 public class LongValidator extends AbstractNumberValidator {
65
66 private static final long serialVersionUID = -5117231731027866098L;
67
68 private static final LongValidator VALIDATOR = new LongValidator();
69
70 /**
71 * Gets the singleton instance of this validator.
72 * @return A singleton instance of the LongValidator.
73 */
74 public static LongValidator getInstance() {
75 return VALIDATOR;
76 }
77
78 /**
79 * Constructs a <em>strict</em> instance.
80 */
81 public LongValidator() {
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} specified what type of
90 * {@code NumberFormat} is created - valid types
91 * are:</p>
92 * <ul>
93 * <li>AbstractNumberValidator.STANDARD_FORMAT -to create
94 * <em>standard</em> number formats (the default).</li>
95 * <li>AbstractNumberValidator.CURRENCY_FORMAT -to create
96 * <em>currency</em> number formats.</li>
97 * <li>AbstractNumberValidator.PERCENT_FORMAT -to create
98 * <em>percent</em> number formats (the default).</li>
99 * </ul>
100 *
101 * @param strict {@code true} if strict
102 * {@code Format} parsing should be used.
103 * @param formatType The {@code NumberFormat} type to
104 * create for validation, default is STANDARD_FORMAT.
105 */
106 public LongValidator(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} 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 long value, final long min, final long 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} 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 Long value, final long min, final long max) {
133 return isInRange(value.longValue(), 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 long value, final long 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 Long value, final long max) {
157 return maxValue(value.longValue(), 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 long value, final long 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 Long value, final long min) {
181 return minValue(value.longValue(), min);
182 }
183
184 /**
185 * Convert the parsed value to a {@code Long}.
186 *
187 * @param value The parsed {@code Number} object created.
188 * @param formatter The Format used to parse the value with.
189 * @return The parsed {@code Number} converted to a
190 * {@code Long}.
191 */
192 @Override
193 protected Object processParsedValue(final Object value, final Format formatter) {
194
195 // Parsed value will be Long if it fits in a long and is not fractional
196 if (value instanceof Long) {
197 return value;
198 }
199 return null;
200
201 }
202
203 /**
204 * <p>Validate/convert a {@code Long} using the default
205 * {@link Locale}.
206 *
207 * @param value The value validation is being performed on.
208 * @return The parsed {@code Long} if valid or {@code null}
209 * if invalid.
210 */
211 public Long validate(final String value) {
212 return (Long) parse(value, (String) null, (Locale) null);
213 }
214
215 /**
216 * <p>Validate/convert a {@code Long} using the
217 * specified {@link Locale}.
218 *
219 * @param value The value validation is being performed on.
220 * @param locale The locale to use for the number format, system default if null.
221 * @return The parsed {@code Long} if valid or {@code null} if invalid.
222 */
223 public Long validate(final String value, final Locale locale) {
224 return (Long) parse(value, (String) null, locale);
225 }
226
227 /**
228 * <p>Validate/convert a {@code Long} using the
229 * specified <em>pattern</em>.
230 *
231 * @param value The value validation is being performed on.
232 * @param pattern The pattern used to validate the value against.
233 * @return The parsed {@code Long} if valid or {@code null} if invalid.
234 */
235 public Long validate(final String value, final String pattern) {
236 return (Long) parse(value, pattern, (Locale) null);
237 }
238
239 /**
240 * <p>Validate/convert a {@code Long} using the
241 * specified pattern and/ or {@link Locale}.
242 *
243 * @param value The value validation is being performed on.
244 * @param pattern The pattern used to validate the value against, or the
245 * default for the {@link Locale} if {@code null}.
246 * @param locale The locale to use for the date format, system default if null.
247 * @return The parsed {@code Long} if valid or {@code null} if invalid.
248 */
249 public Long validate(final String value, final String pattern, final Locale locale) {
250 return (Long) parse(value, pattern, locale);
251 }
252 }