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 *      http://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.util.Locale;
021
022/**
023 * <p><b>Integer Validation</b> and Conversion routines (<code>java.lang.Integer</code>).</p>
024 *
025 * <p>This validator provides a number of methods for
026 *    validating/converting a <code>String</code> value to
027 *    a <code>Integer</code> using <code>java.text.NumberFormat</code>
028 *    to parse either:</p>
029 *    <ul>
030 *       <li>using the default format for the default <code>Locale</code></li>
031 *       <li>using a specified pattern with the default <code>Locale</code></li>
032 *       <li>using the default format for a specified <code>Locale</code></li>
033 *       <li>using a specified pattern with a specified <code>Locale</code></li>
034 *    </ul>
035 *
036 * <p>Use one of the <code>isValid()</code> methods to just validate or
037 *    one of the <code>validate()</code> methods to validate and receive a
038 *    <i>converted</i> <code>Integer</code> value.</p>
039 *
040 * <p>Once a value has been successfully converted the following
041 *    methods can be used to perform minimum, maximum and range checks:</p>
042 *    <ul>
043 *       <li><code>minValue()</code> checks whether the value is greater
044 *           than or equal to a specified minimum.</li>
045 *       <li><code>maxValue()</code> checks whether the value is less
046 *           than or equal to a specified maximum.</li>
047 *       <li><code>isInRange()</code> checks whether the value is within
048 *           a specified range of values.</li>
049 *    </ul>
050 *
051 * <p>So that the same mechanism used for parsing an <i>input</i> value
052 *    for validation can be used to format <i>output</i>, corresponding
053 *    <code>format()</code> methods are also provided. That is you can
054 *    format either:</p>
055 *    <ul>
056 *       <li>using the default format for the default <code>Locale</code></li>
057 *       <li>using a specified pattern with the default <code>Locale</code></li>
058 *       <li>using the default format for a specified <code>Locale</code></li>
059 *       <li>using a specified pattern with a specified <code>Locale</code></li>
060 *    </ul>
061 *
062 * @since 1.3.0
063 */
064public class IntegerValidator extends AbstractNumberValidator {
065
066    private static final long serialVersionUID = 422081746310306596L;
067
068    private static final IntegerValidator VALIDATOR = new IntegerValidator();
069
070    /**
071     * Return a singleton instance of this validator.
072     * @return A singleton instance of the IntegerValidator.
073     */
074    public static IntegerValidator getInstance() {
075        return VALIDATOR;
076    }
077
078    /**
079     * Constructs a <i>strict</i> instance.
080     */
081    public IntegerValidator() {
082        this(true, STANDARD_FORMAT);
083    }
084
085    /**
086     * <p>Construct an instance with the specified strict setting
087     *    and format type.</p>
088     *
089     * <p>The <code>formatType</code> specified what type of
090     *    <code>NumberFormat</code> is created - valid types
091     *    are:</p>
092     *    <ul>
093     *       <li>AbstractNumberValidator.STANDARD_FORMAT -to create
094     *           <i>standard</i> number formats (the default).</li>
095     *       <li>AbstractNumberValidator.CURRENCY_FORMAT -to create
096     *           <i>currency</i> number formats.</li>
097     *       <li>AbstractNumberValidator.PERCENT_FORMAT -to create
098     *           <i>percent</i> number formats (the default).</li>
099     *    </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 IntegerValidator(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 int value, final int min, final int 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 Integer value, final int min, final int max) {
133        return isInRange(value.intValue(), 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 int value, final int 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 Integer value, final int max) {
157        return maxValue(value.intValue(), 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 int value, final int 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 Integer value, final int min) {
181        return minValue(value.intValue(), min);
182    }
183
184    /**
185     * <p>Perform further validation and convert the <code>Number</code> to
186     * an <code>Integer</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 an
191     *   <code>Integer</code> if valid or <code>null</code> 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 >= Integer.MIN_VALUE &&
200                longValue <= Integer.MAX_VALUE) {
201                return Integer.valueOf((int)longValue);
202            }
203        }
204        return null;
205    }
206
207    /**
208     * <p>Validate/convert an <code>Integer</code> using the default
209     *    <code>Locale</code>.
210     *
211     * @param value The value validation is being performed on.
212     * @return The parsed <code>Integer</code> if valid or <code>null</code>
213     *  if invalid.
214     */
215    public Integer validate(final String value) {
216        return (Integer)parse(value, (String)null, (Locale)null);
217    }
218
219    /**
220     * <p>Validate/convert an <code>Integer</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>Integer</code> if valid or <code>null</code> if invalid.
226     */
227    public Integer validate(final String value, final Locale locale) {
228        return (Integer)parse(value, (String)null, locale);
229    }
230
231    /**
232     * <p>Validate/convert an <code>Integer</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>Integer</code> if valid or <code>null</code> if invalid.
238     */
239    public Integer validate(final String value, final String pattern) {
240        return (Integer)parse(value, pattern, (Locale)null);
241    }
242
243    /**
244     * <p>Validate/convert a <code>Integer</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</code>.
250     * @param locale The locale to use for the date format, system default if null.
251     * @return The parsed <code>Integer</code> if valid or <code>null</code> if invalid.
252     */
253    public Integer validate(final String value, final String pattern, final Locale locale) {
254        return (Integer)parse(value, pattern, locale);
255    }
256}