    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 *      https://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.text.NumberFormat;
    021import java.util.Locale;
    022
    023/**
    024 * <p><strong>Long Validation</strong> and Conversion routines ({@code java.lang.Long}).</p>
    025 *
    026 * <p>This validator provides a number of methods for
    027 *    validating/converting a {@link String} value to
    028 *    a {@code Long} using {@link NumberFormat}
    029 *    to parse either:</p>
    030 *    <ul>
    031 *       <li>using the default format for the default {@link Locale}</li>
    032 *       <li>using a specified pattern with the default {@link Locale}</li>
    033 *       <li>using the default format for a specified {@link Locale}</li>
    034 *       <li>using a specified pattern with a specified {@link Locale}</li>
    035 *    </ul>
    036 *
    037 * <p>Use one of the {@code isValid()} methods to just validate or
    038 *    one of the {@code validate()} methods to validate and receive a
    039 *    <em>converted</em> {@code Long} value.</p>
    040 *
    041 * <p>Once a value has been successfully converted the following
    042 *    methods can be used to perform minimum, maximum and range checks:</p>
    043 *    <ul>
    044 *       <li>{@code minValue()} checks whether the value is greater
    045 *           than or equal to a specified minimum.</li>
    046 *       <li>{@code maxValue()} checks whether the value is less
    047 *           than or equal to a specified maximum.</li>
    048 *       <li>{@code isInRange()} checks whether the value is within
    049 *           a specified range of values.</li>
    050 *    </ul>
    051 *
    052 * <p>So that the same mechanism used for parsing an <em>input</em> value
    053 *    for validation can be used to format <em>output</em>, corresponding
    054 *    {@code format()} methods are also provided. That is you can
    055 *    format either:</p>
    056 *    <ul>
    057 *       <li>using a specified pattern</li>
    058 *       <li>using the format for a specified {@link Locale}</li>
    059 *       <li>using the format for the <em>default</em> {@link Locale}</li>
    060 *    </ul>
    061 *
    062 * @since 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     * Gets the 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     * Constructs a <em>strict</em> 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} specified what type of
    090     *    {@code NumberFormat} is created - valid types
    091     *    are:</p>
    092     *    <ul>
    093     *       <li>AbstractNumberValidator.STANDARD_FORMAT -to create
    094     *           <em>standard</em> number formats (the default).</li>
    095     *       <li>AbstractNumberValidator.CURRENCY_FORMAT -to create
    096     *           <em>currency</em> number formats.</li>
    097     *       <li>AbstractNumberValidator.PERCENT_FORMAT -to create
    098     *           <em>percent</em> number formats (the default).</li>
    099     *    </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}