View Javadoc
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    *      http://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.math.BigInteger;
20  import java.text.Format;
21  import java.util.Locale;
22  
23  /**
24   * <p><b>BigInteger Validation</b> and Conversion routines (<code>java.math.BigInteger</code>).</p>
25   *
26   * <p>This validator provides a number of methods for
27   *    validating/converting a <code>String</code> value to
28   *    a <code>BigInteger</code> using <code>java.text.NumberFormat</code>
29   *    to parse either:</p>
30   *    <ul>
31   *       <li>using the default format for the default <code>Locale</code></li>
32   *       <li>using a specified pattern with the default <code>Locale</code></li>
33   *       <li>using the default format for a specified <code>Locale</code></li>
34   *       <li>using a specified pattern with a specified <code>Locale</code></li>
35   *    </ul>
36   *
37   * <p>Use one of the <code>isValid()</code> methods to just validate or
38   *    one of the <code>validate()</code> methods to validate and receive a
39   *    <i>converted</i> <code>BigInteger</code> 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()</code> checks whether the value is greater
45   *           than or equal to a specified minimum.</li>
46   *       <li><code>maxValue()</code> checks whether the value is less
47   *           than or equal to a specified maximum.</li>
48   *       <li><code>isInRange()</code> 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 <i>input</i> value
53   *    for validation can be used to format <i>output</i>, corresponding
54   *    <code>format()</code> methods are also provided. That is you can
55   *    format either:</p>
56   *    <ul>
57   *       <li>using the default format for the default <code>Locale</code></li>
58   *       <li>using a specified pattern with the default <code>Locale</code></li>
59   *       <li>using the default format for a specified <code>Locale</code></li>
60   *       <li>using a specified pattern with a specified <code>Locale</code></li>
61   *    </ul>
62   *
63   * @since 1.3.0
64   */
65  public class BigIntegerValidator extends AbstractNumberValidator {
66  
67      private static final long serialVersionUID = 6713144356347139988L;
68  
69      private static final BigIntegerValidator VALIDATOR = new BigIntegerValidator();
70  
71      /**
72       * Return a singleton instance of this validator.
73       * @return A singleton instance of the BigIntegerValidator.
74       */
75      public static BigIntegerValidator getInstance() {
76          return VALIDATOR;
77      }
78  
79      /**
80       * Constructs a <i>strict</i> instance.
81       */
82      public BigIntegerValidator() {
83          this(true, STANDARD_FORMAT);
84      }
85  
86      /**
87       * <p>Construct an instance with the specified strict setting
88       *    and format type.</p>
89       *
90       * <p>The <code>formatType</code> specified what type of
91       *    <code>NumberFormat</code> is created - valid types
92       *    are:</p>
93       *    <ul>
94       *       <li>AbstractNumberValidator.STANDARD_FORMAT -to create
95       *           <i>standard</i> number formats (the default).</li>
96       *       <li>AbstractNumberValidator.CURRENCY_FORMAT -to create
97       *           <i>currency</i> number formats.</li>
98       *       <li>AbstractNumberValidator.PERCENT_FORMAT -to create
99       *           <i>percent</i> number formats (the default).</li>
100      *    </ul>
101      *
102      * @param strict {@code true} if strict
103      *        <code>Format</code> parsing should be used.
104      * @param formatType The <code>NumberFormat</code> type to
105      *        create for validation, default is STANDARD_FORMAT.
106      */
107     public BigIntegerValidator(final boolean strict, final int formatType) {
108         super(strict, formatType, false);
109     }
110 
111     /**
112      * Check if the value is within a specified range.
113      *
114      * @param value The <code>Number</code> value to check.
115      * @param min The minimum value of the range.
116      * @param max The maximum value of the range.
117      * @return {@code true} if the value is within the
118      *         specified range.
119      */
120     public boolean isInRange(final BigInteger value, final long min, final long max) {
121         return value.longValue() >= min && value.longValue() <= max;
122     }
123 
124     /**
125      * Check if the value is less than or equal to a maximum.
126      *
127      * @param value The value validation is being performed on.
128      * @param max The maximum value.
129      * @return {@code true} if the value is less than
130      *         or equal to the maximum.
131      */
132     public boolean maxValue(final BigInteger value, final long max) {
133         return value.longValue() <= max;
134     }
135 
136     /**
137      * Check if the value is greater than or equal to a minimum.
138      *
139      * @param value The value validation is being performed on.
140      * @param min The minimum value.
141      * @return {@code true} if the value is greater than
142      *         or equal to the minimum.
143      */
144     public boolean minValue(final BigInteger value, final long min) {
145         return value.longValue() >= min;
146     }
147 
148     /**
149      * Convert the parsed value to a <code>BigInteger</code>.
150      *
151      * @param value The parsed <code>Number</code> object created.
152      * @param formatter The Format used to parse the value with.
153      * @return The parsed <code>Number</code> converted to a
154      *         <code>BigInteger</code>.
155      */
156     @Override
157     protected Object processParsedValue(final Object value, final Format formatter) {
158         return BigInteger.valueOf(((Number)value).longValue());
159     }
160 
161     /**
162      * <p>Validate/convert a <code>BigInteger</code> using the default
163      *    <code>Locale</code>.
164      *
165      * @param value The value validation is being performed on.
166      * @return The parsed <code>BigInteger</code> if valid or <code>null</code>
167      *  if invalid.
168      */
169     public BigInteger validate(final String value) {
170         return (BigInteger)parse(value, (String)null, (Locale)null);
171     }
172 
173     /**
174      * <p>Validate/convert a <code>BigInteger</code> using the
175      *    specified <code>Locale</code>.
176      *
177      * @param value The value validation is being performed on.
178      * @param locale The locale to use for the number format, system default if null.
179      * @return The parsed <code>BigInteger</code> if valid or <code>null</code> if invalid.
180      */
181     public BigInteger validate(final String value, final Locale locale) {
182         return (BigInteger)parse(value, (String)null, locale);
183     }
184 
185     /**
186      * <p>Validate/convert a <code>BigInteger</code> using the
187      *    specified <i>pattern</i>.
188      *
189      * @param value The value validation is being performed on.
190      * @param pattern The pattern used to validate the value against.
191      * @return The parsed <code>BigInteger</code> if valid or <code>null</code> if invalid.
192      */
193     public BigInteger validate(final String value, final String pattern) {
194         return (BigInteger)parse(value, pattern, (Locale)null);
195     }
196 
197     /**
198      * <p>Validate/convert a <code>BigInteger</code> using the
199      *    specified pattern and/ or <code>Locale</code>.
200      *
201      * @param value The value validation is being performed on.
202      * @param pattern The pattern used to validate the value against, or the
203      *        default for the <code>Locale</code> if <code>null</code>.
204      * @param locale The locale to use for the date format, system default if null.
205      * @return The parsed <code>BigInteger</code> if valid or <code>null</code> if invalid.
206      */
207     public BigInteger validate(final String value, final String pattern, final Locale locale) {
208         return (BigInteger)parse(value, pattern, locale);
209     }
210 }