    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>Long Validation</b> and Conversion routines (<code>java.lang.Long</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>Long</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>Long</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 a specified pattern</li>
    057 *       <li>using the format for a specified <code>Locale</code></li>
    058 *       <li>using the format for the <i>default</i> <code>Locale</code></li>
    059 *    </ul>
    060 *
    061 * @version $Revision$
    062 * @since Validator 1.3.0
    063 */
    064public class LongValidator extends AbstractNumberValidator {
    065
    066    private static final long serialVersionUID = -5117231731027866098L;
    067
    068    private static final LongValidator VALIDATOR = new LongValidator();
    069
    070    /**
    071     * Return a singleton instance of this validator.
    072     * @return A singleton instance of the LongValidator.
    073     */
    074    public static LongValidator getInstance() {
    075        return VALIDATOR;
    076    }
    077
    078    /**
    079     * Construct a <i>strict</i> instance.
    080     */
    081    public LongValidator() {
    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</code> 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 LongValidator(boolean strict, int formatType) {
    107        super(strict, formatType, false);
    108    }
    109
    110    /**
    111     * <p>Validate/convert a <code>Long</code> using the default
    112     *    <code>Locale</code>.
    113     *
    114     * @param value The value validation is being performed on.
    115     * @return The parsed <code>Long</code> if valid or <code>null</code>
    116     *  if invalid.
    117     */
    118    public Long validate(String value) {
    119        return (Long)parse(value, (String)null, (Locale)null);
    120    }
    121
    122    /**
    123     * <p>Validate/convert a <code>Long</code> using the
    124     *    specified <i>pattern</i>.
    125     *
    126     * @param value The value validation is being performed on.
    127     * @param pattern The pattern used to validate the value against.
    128     * @return The parsed <code>Long</code> if valid or <code>null</code> if invalid.
    129     */
    130    public Long validate(String value, String pattern) {
    131        return (Long)parse(value, pattern, (Locale)null);
    132    }
    133
    134    /**
    135     * <p>Validate/convert a <code>Long</code> using the
    136     *    specified <code>Locale</code>.
    137     *
    138     * @param value The value validation is being performed on.
    139     * @param locale The locale to use for the number format, system default if null.
    140     * @return The parsed <code>Long</code> if valid or <code>null</code> if invalid.
    141     */
    142    public Long validate(String value, Locale locale) {
    143        return (Long)parse(value, (String)null, locale);
    144    }
    145
    146    /**
    147     * <p>Validate/convert a <code>Long</code> using the
    148     *    specified pattern and/ or <code>Locale</code>.
    149     *
    150     * @param value The value validation is being performed on.
    151     * @param pattern The pattern used to validate the value against, or the
    152     *        default for the <code>Locale</code> if <code>null</code>.
    153     * @param locale The locale to use for the date format, system default if null.
    154     * @return The parsed <code>Long</code> if valid or <code>null</code> if invalid.
    155     */
    156    public Long validate(String value, String pattern, Locale locale) {
    157        return (Long)parse(value, pattern, locale);
    158    }
    159
    160    /**
    161     * Check if the value is within a specified range.
    162     *
    163     * @param value The <code>Number</code> value to check.
    164     * @param min The minimum value of the range.
    165     * @param max The maximum value of the range.
    166     * @return <code>true</code> if the value is within the
    167     *         specified range.
    168     */
    169    public boolean isInRange(long value, long min, long max) {
    170        return (value >= min && value <= max);
    171    }
    172
    173    /**
    174     * Check if the value is within a specified range.
    175     *
    176     * @param value The <code>Number</code> value to check.
    177     * @param min The minimum value of the range.
    178     * @param max The maximum value of the range.
    179     * @return <code>true</code> if the value is within the
    180     *         specified range.
    181     */
    182    public boolean isInRange(Long value, long min, long max) {
    183        return isInRange(value.longValue(), min, max);
    184    }
    185
    186    /**
    187     * Check if the value is greater than or equal to a minimum.
    188     *
    189     * @param value The value validation is being performed on.
    190     * @param min The minimum value.
    191     * @return <code>true</code> if the value is greater than
    192     *         or equal to the minimum.
    193     */
    194    public boolean minValue(long value, long min) {
    195        return (value >= min);
    196    }
    197
    198    /**
    199     * Check if the value is greater than or equal to a minimum.
    200     *
    201     * @param value The value validation is being performed on.
    202     * @param min The minimum value.
    203     * @return <code>true</code> if the value is greater than
    204     *         or equal to the minimum.
    205     */
    206    public boolean minValue(Long value, long min) {
    207        return minValue(value.longValue(), min);
    208    }
    209
    210    /**
    211     * Check if the value is less than or equal to a maximum.
    212     *
    213     * @param value The value validation is being performed on.
    214     * @param max The maximum value.
    215     * @return <code>true</code> if the value is less than
    216     *         or equal to the maximum.
    217     */
    218    public boolean maxValue(long value, long max) {
    219        return (value <= max);
    220    }
    221
    222    /**
    223     * Check if the value is less than or equal to a maximum.
    224     *
    225     * @param value The value validation is being performed on.
    226     * @param max The maximum value.
    227     * @return <code>true</code> if the value is less than
    228     *         or equal to the maximum.
    229     */
    230    public boolean maxValue(Long value, long max) {
    231        return maxValue(value.longValue(), max);
    232    }
    233
    234    /**
    235     * Convert the parsed value to a <code>Long</code>.
    236     *
    237     * @param value The parsed <code>Number</code> object created.
    238     * @param formatter The Format used to parse the value with.
    239     * @return The parsed <code>Number</code> converted to a
    240     *         <code>Long</code>.
    241     */
    242    @Override
    243    protected Object processParsedValue(Object value, Format formatter) {
    244
    245        // Parsed value will be Long if it fits in a long and is not fractional
    246        if (value instanceof Long) {
    247            return value;
    248        }
    249        return null;
    250
    251    }
    252}