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 * @return A singleton instance of the BigIntegerValidator. 075 */ 076 public static BigIntegerValidator getInstance() { 077 return VALIDATOR; 078 } 079 080 /** 081 * Constructs a <em>strict</em> 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} specified what type of 092 * {@code NumberFormat} is created - valid types 093 * are:</p> 094 * <ul> 095 * <li>AbstractNumberValidator.STANDARD_FORMAT -to create 096 * <em>standard</em> number formats (the default).</li> 097 * <li>AbstractNumberValidator.CURRENCY_FORMAT -to create 098 * <em>currency</em> number formats.</li> 099 * <li>AbstractNumberValidator.PERCENT_FORMAT -to create 100 * <em>percent</em> number formats (the default).</li> 101 * </ul> 102 * 103 * @param strict {@code true} if strict 104 * {@code Format} parsing should be used. 105 * @param formatType The {@code NumberFormat} type to 106 * create for validation, default is STANDARD_FORMAT. 107 */ 108 public BigIntegerValidator(final boolean strict, final int formatType) { 109 super(strict, formatType, false); 110 } 111 112 /** 113 * Check if the value is within a specified range. 114 * 115 * @param value The {@code Number} value to check. 116 * @param min The minimum value of the range. 117 * @param max The maximum value of the range. 118 * @return {@code true} if the value is within the 119 * specified range. 120 */ 121 public boolean isInRange(final BigInteger value, final long min, final long max) { 122 return value.longValue() >= min && value.longValue() <= max; 123 } 124 125 /** 126 * Check if the value is less than or equal to a maximum. 127 * 128 * @param value The value validation is being performed on. 129 * @param max The maximum value. 130 * @return {@code true} if the value is less than 131 * or equal to the maximum. 132 */ 133 public boolean maxValue(final BigInteger value, final long max) { 134 return value.longValue() <= max; 135 } 136 137 /** 138 * Check if the value is greater than or equal to a minimum. 139 * 140 * @param value The value validation is being performed on. 141 * @param min The minimum value. 142 * @return {@code true} if the value is greater than 143 * or equal to the minimum. 144 */ 145 public boolean minValue(final BigInteger value, final long min) { 146 return value.longValue() >= min; 147 } 148 149 /** 150 * Convert the parsed value to a {@code BigInteger}. 151 * 152 * @param value The parsed {@code Number} object created. 153 * @param formatter The Format used to parse the value with. 154 * @return The parsed {@code Number} converted to a 155 * {@code BigInteger}. 156 */ 157 @Override 158 protected Object processParsedValue(final Object value, final Format formatter) { 159 return BigInteger.valueOf(((Number) value).longValue()); 160 } 161 162 /** 163 * <p>Validate/convert a {@code BigInteger} using the default 164 * {@link Locale}. 165 * 166 * @param value The value validation is being performed on. 167 * @return The parsed {@code BigInteger} if valid or {@code null} 168 * if invalid. 169 */ 170 public BigInteger validate(final String value) { 171 return (BigInteger) parse(value, (String) null, (Locale) null); 172 } 173 174 /** 175 * <p>Validate/convert a {@code BigInteger} using the 176 * specified {@link Locale}. 177 * 178 * @param value The value validation is being performed on. 179 * @param locale The locale to use for the number format, system default if null. 180 * @return The parsed {@code BigInteger} if valid or {@code null} if invalid. 181 */ 182 public BigInteger validate(final String value, final Locale locale) { 183 return (BigInteger) parse(value, (String) null, locale); 184 } 185 186 /** 187 * <p>Validate/convert a {@code BigInteger} using the 188 * specified <em>pattern</em>. 189 * 190 * @param value The value validation is being performed on. 191 * @param pattern The pattern used to validate the value against. 192 * @return The parsed {@code BigInteger} if valid or {@code null} if invalid. 193 */ 194 public BigInteger validate(final String value, final String pattern) { 195 return (BigInteger) parse(value, pattern, (Locale) null); 196 } 197 198 /** 199 * <p>Validate/convert a {@code BigInteger} using the 200 * specified pattern and/ or {@link Locale}. 201 * 202 * @param value The value validation is being performed on. 203 * @param pattern The pattern used to validate the value against, or the 204 * default for the {@link Locale} if {@code null}. 205 * @param locale The locale to use for the date format, system default if null. 206 * @return The parsed {@code BigInteger} if valid or {@code null} if invalid. 207 */ 208 public BigInteger validate(final String value, final String pattern, final Locale locale) { 209 return (BigInteger) parse(value, pattern, locale); 210 } 211}