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.math.BigInteger;
020import java.text.Format;
021import java.text.NumberFormat;
022import java.util.Locale;
023
024/**
025 * <p><strong>BigInteger Validation</strong> and Conversion routines ({@code java.math.BigInteger}).</p>
026 *
027 * <p>This validator provides a number of methods for
028 *    validating/converting a {@link String} value to
029 *    a {@code BigInteger} using {@link NumberFormat}
030 *    to parse either:</p>
031 *    <ul>
032 *       <li>using the default format for the default {@link Locale}</li>
033 *       <li>using a specified pattern with the default {@link Locale}</li>
034 *       <li>using the default format for a specified {@link Locale}</li>
035 *       <li>using a specified pattern with a specified {@link Locale}</li>
036 *    </ul>
037 *
038 * <p>Use one of the {@code isValid()} methods to just validate or
039 *    one of the {@code validate()} methods to validate and receive a
040 *    <em>converted</em> {@code BigInteger} value.</p>
041 *
042 * <p>Once a value has been successfully converted the following
043 *    methods can be used to perform minimum, maximum and range checks:</p>
044 *    <ul>
045 *       <li>{@code minValue()} checks whether the value is greater
046 *           than or equal to a specified minimum.</li>
047 *       <li>{@code maxValue()} checks whether the value is less
048 *           than or equal to a specified maximum.</li>
049 *       <li>{@code isInRange()} checks whether the value is within
050 *           a specified range of values.</li>
051 *    </ul>
052 *
053 * <p>So that the same mechanism used for parsing an <em>input</em> value
054 *    for validation can be used to format <em>output</em>, corresponding
055 *    {@code format()} methods are also provided. That is you can
056 *    format either:</p>
057 *    <ul>
058 *       <li>using the default format for the default {@link Locale}</li>
059 *       <li>using a specified pattern with the default {@link Locale}</li>
060 *       <li>using the default format for a specified {@link Locale}</li>
061 *       <li>using a specified pattern with a specified {@link Locale}</li>
062 *    </ul>
063 *
064 * @since 1.3.0
065 */
066public class BigIntegerValidator extends AbstractNumberValidator {
067
068    private static final long serialVersionUID = 6713144356347139988L;
069
070    private static final BigIntegerValidator VALIDATOR = new BigIntegerValidator();
071
072    /**
073     * Gets the singleton instance of this validator.
074     *
075     * @return A singleton instance of the BigIntegerValidator.
076     */
077    public static BigIntegerValidator getInstance() {
078        return VALIDATOR;
079    }
080
081    /**
082     * Constructs a <em>strict</em> instance.
083     */
084    public BigIntegerValidator() {
085        this(true, STANDARD_FORMAT);
086    }
087
088    /**
089     * <p>Construct an instance with the specified strict setting
090     *    and format type.</p>
091     *
092     * <p>The {@code formatType} specified what type of
093     *    {@code NumberFormat} is created - valid types
094     *    are:</p>
095     *    <ul>
096     *       <li>AbstractNumberValidator.STANDARD_FORMAT -to create
097     *           <em>standard</em> number formats (the default).</li>
098     *       <li>AbstractNumberValidator.CURRENCY_FORMAT -to create
099     *           <em>currency</em> number formats.</li>
100     *       <li>AbstractNumberValidator.PERCENT_FORMAT -to create
101     *           <em>percent</em> number formats (the default).</li>
102     *    </ul>
103     *
104     * @param strict {@code true} if strict
105     *        {@code Format} parsing should be used.
106     * @param formatType The {@code NumberFormat} type to
107     *        create for validation, default is STANDARD_FORMAT.
108     */
109    public BigIntegerValidator(final boolean strict, final int formatType) {
110        super(strict, formatType, false);
111    }
112
113    /**
114     * Check if the value is within a specified range.
115     *
116     * @param value The {@code Number} value to check.
117     * @param min The minimum value of the range.
118     * @param max The maximum value of the range.
119     * @return {@code true} if the value is within the
120     *         specified range.
121     */
122    public boolean isInRange(final BigInteger value, final long min, final long max) {
123        return value.longValue() >= min && value.longValue() <= max;
124    }
125
126    /**
127     * Check if the value is less than or equal to a maximum.
128     *
129     * @param value The value validation is being performed on.
130     * @param max The maximum value.
131     * @return {@code true} if the value is less than
132     *         or equal to the maximum.
133     */
134    public boolean maxValue(final BigInteger value, final long max) {
135        return value.longValue() <= max;
136    }
137
138    /**
139     * Check if the value is greater than or equal to a minimum.
140     *
141     * @param value The value validation is being performed on.
142     * @param min The minimum value.
143     * @return {@code true} if the value is greater than
144     *         or equal to the minimum.
145     */
146    public boolean minValue(final BigInteger value, final long min) {
147        return value.longValue() >= min;
148    }
149
150    /**
151     * Convert the parsed value to a {@code BigInteger}.
152     *
153     * @param value The parsed {@code Number} object created.
154     * @param formatter The Format used to parse the value with.
155     * @return The parsed {@code Number} converted to a
156     *         {@code BigInteger}.
157     */
158    @Override
159    protected Object processParsedValue(final Object value, final Format formatter) {
160        return BigInteger.valueOf(((Number) value).longValue());
161    }
162
163    /**
164     * <p>Validate/convert a {@code BigInteger} using the default
165     *    {@link Locale}.
166     *
167     * @param value The value validation is being performed on.
168     * @return The parsed {@code BigInteger} if valid or {@code null}
169     *  if invalid.
170     */
171    public BigInteger validate(final String value) {
172        return (BigInteger) parse(value, (String) null, (Locale) null);
173    }
174
175    /**
176     * <p>Validate/convert a {@code BigInteger} using the
177     *    specified {@link Locale}.
178     *
179     * @param value The value validation is being performed on.
180     * @param locale The locale to use for the number format, system default if null.
181     * @return The parsed {@code BigInteger} if valid or {@code null} if invalid.
182     */
183    public BigInteger validate(final String value, final Locale locale) {
184        return (BigInteger) parse(value, (String) null, locale);
185    }
186
187    /**
188     * <p>Validate/convert a {@code BigInteger} using the
189     *    specified <em>pattern</em>.
190     *
191     * @param value The value validation is being performed on.
192     * @param pattern The pattern used to validate the value against.
193     * @return The parsed {@code BigInteger} if valid or {@code null} if invalid.
194     */
195    public BigInteger validate(final String value, final String pattern) {
196        return (BigInteger) parse(value, pattern, (Locale) null);
197    }
198
199    /**
200     * <p>Validate/convert a {@code BigInteger} using the
201     *    specified pattern and/ or {@link Locale}.
202     *
203     * @param value The value validation is being performed on.
204     * @param pattern The pattern used to validate the value against, or the
205     *        default for the {@link Locale} if {@code null}.
206     * @param locale The locale to use for the date format, system default if null.
207     * @return The parsed {@code BigInteger} if valid or {@code null} if invalid.
208     */
209    public BigInteger validate(final String value, final String pattern, final Locale locale) {
210        return (BigInteger) parse(value, pattern, locale);
211    }
212}