Coverage Report - org.apache.commons.validator.routines.BigIntegerValidator
 
Classes in this File Line Coverage Branch Coverage Complexity
BigIntegerValidator
100%
14/14
100%
8/8
1.091
 
 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   
  * @version $Revision: 1739356 $
 64   
  * @since Validator 1.3.0
 65   
  */
 66   
 public class BigIntegerValidator extends AbstractNumberValidator {
 67   
 
 68   
     private static final long serialVersionUID = 6713144356347139988L;
 69   
 
 70  1 
     private static final BigIntegerValidator VALIDATOR = new BigIntegerValidator();
 71   
 
 72   
     /**
 73   
      * Return a singleton instance of this validator.
 74   
      * @return A singleton instance of the BigIntegerValidator.
 75   
      */
 76   
     public static BigIntegerValidator getInstance() {
 77  16 
         return VALIDATOR;
 78   
     }
 79   
 
 80   
     /**
 81   
      * Construct a <i>strict</i> instance.
 82   
      */
 83   
     public BigIntegerValidator() {
 84  13 
         this(true, STANDARD_FORMAT);
 85  13 
     }
 86   
 
 87   
     /**
 88   
      * <p>Construct an instance with the specified strict setting
 89   
      *    and format type.</p>
 90   
      *
 91   
      * <p>The <code>formatType</code> specified what type of
 92   
      *    <code>NumberFormat</code> is created - valid types
 93   
      *    are:</p>
 94   
      *    <ul>
 95   
      *       <li>AbstractNumberValidator.STANDARD_FORMAT -to create
 96   
      *           <i>standard</i> number formats (the default).</li>
 97   
      *       <li>AbstractNumberValidator.CURRENCY_FORMAT -to create
 98   
      *           <i>currency</i> number formats.</li>
 99   
      *       <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  25 
         super(strict, formatType, false);
 110  25 
     }
 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  2 
         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  8 
         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  2 
         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  2 
         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  5 
         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  3 
         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  3 
         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  49 
         return BigInteger.valueOf(((Number)value).longValue());
 210   
     }
 211   
 }
Report generated by Cobertura 2.1.1 on 16/02/17 15:43.