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