Coverage Report - org.apache.commons.validator.routines.LongValidator
 
Classes in this File Line Coverage Branch Coverage Complexity
LongValidator
100%
19/19
100%
10/10
1.214
 
 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.text.Format;
 20   
 import java.util.Locale;
 21   
 
 22   
 /**
 23   
  * <p><b>Long Validation</b> and Conversion routines (<code>java.lang.Long</code>).</p>
 24   
  *
 25   
  * <p>This validator provides a number of methods for
 26   
  *    validating/converting a <code>String</code> value to
 27   
  *    a <code>Long</code> using <code>java.text.NumberFormat</code>
 28   
  *    to parse either:</p>
 29   
  *    <ul>
 30   
  *       <li>using the default format for the default <code>Locale</code></li>
 31   
  *       <li>using a specified pattern with the default <code>Locale</code></li>
 32   
  *       <li>using the default format for a specified <code>Locale</code></li>
 33   
  *       <li>using a specified pattern with a specified <code>Locale</code></li>
 34   
  *    </ul>
 35   
  *
 36   
  * <p>Use one of the <code>isValid()</code> methods to just validate or
 37   
  *    one of the <code>validate()</code> methods to validate and receive a
 38   
  *    <i>converted</i> <code>Long</code> value.</p>
 39   
  *
 40   
  * <p>Once a value has been successfully converted the following
 41   
  *    methods can be used to perform minimum, maximum and range checks:</p>
 42   
  *    <ul>
 43   
  *       <li><code>minValue()</code> checks whether the value is greater
 44   
  *           than or equal to a specified minimum.</li>
 45   
  *       <li><code>maxValue()</code> checks whether the value is less
 46   
  *           than or equal to a specified maximum.</li>
 47   
  *       <li><code>isInRange()</code> checks whether the value is within
 48   
  *           a specified range of values.</li>
 49   
  *    </ul>
 50   
  *
 51   
  * <p>So that the same mechanism used for parsing an <i>input</i> value
 52   
  *    for validation can be used to format <i>output</i>, corresponding
 53   
  *    <code>format()</code> methods are also provided. That is you can
 54   
  *    format either:</p>
 55   
  *    <ul>
 56   
  *       <li>using a specified pattern</li>
 57   
  *       <li>using the format for a specified <code>Locale</code></li>
 58   
  *       <li>using the format for the <i>default</i> <code>Locale</code></li>
 59   
  *    </ul>
 60   
  *
 61   
  * @version $Revision: 1739356 $
 62   
  * @since Validator 1.3.0
 63   
  */
 64   
 public class LongValidator extends AbstractNumberValidator {
 65   
 
 66   
     private static final long serialVersionUID = -5117231731027866098L;
 67   
 
 68  1 
     private static final LongValidator VALIDATOR = new LongValidator();
 69   
 
 70   
     /**
 71   
      * Return a singleton instance of this validator.
 72   
      * @return A singleton instance of the LongValidator.
 73   
      */
 74   
     public static LongValidator getInstance() {
 75  16 
         return VALIDATOR;
 76   
     }
 77   
 
 78   
     /**
 79   
      * Construct a <i>strict</i> instance.
 80   
      */
 81   
     public LongValidator() {
 82  13 
         this(true, STANDARD_FORMAT);
 83  13 
     }
 84   
 
 85   
     /**
 86   
      * <p>Construct an instance with the specified strict setting
 87   
      *    and format type.</p>
 88   
      *
 89   
      * <p>The <code>formatType</code> specified what type of
 90   
      *    <code>NumberFormat</code> is created - valid types
 91   
      *    are:</p>
 92   
      *    <ul>
 93   
      *       <li>AbstractNumberValidator.STANDARD_FORMAT -to create
 94   
      *           <i>standard</i> number formats (the default).</li>
 95   
      *       <li>AbstractNumberValidator.CURRENCY_FORMAT -to create
 96   
      *           <i>currency</i> number formats.</li>
 97   
      *       <li>AbstractNumberValidator.PERCENT_FORMAT -to create
 98   
      *           <i>percent</i> number formats (the default).</li>
 99   
      *    </ul>
 100   
      *
 101   
      * @param strict <code>true</code> if strict
 102   
      *        <code>Format</code> parsing should be used.
 103   
      * @param formatType The <code>NumberFormat</code> type to
 104   
      *        create for validation, default is STANDARD_FORMAT.
 105   
      */
 106   
     public LongValidator(boolean strict, int formatType) {
 107  25 
         super(strict, formatType, false);
 108  25 
     }
 109   
 
 110   
     /**
 111   
      * <p>Validate/convert a <code>Long</code> using the default
 112   
      *    <code>Locale</code>.
 113   
      *
 114   
      * @param value The value validation is being performed on.
 115   
      * @return The parsed <code>Long</code> if valid or <code>null</code>
 116   
      *  if invalid.
 117   
      */
 118   
     public Long validate(String value) {
 119  2 
         return (Long)parse(value, (String)null, (Locale)null);
 120   
     }
 121   
 
 122   
     /**
 123   
      * <p>Validate/convert a <code>Long</code> using the
 124   
      *    specified <i>pattern</i>.
 125   
      *
 126   
      * @param value The value validation is being performed on.
 127   
      * @param pattern The pattern used to validate the value against.
 128   
      * @return The parsed <code>Long</code> if valid or <code>null</code> if invalid.
 129   
      */
 130   
     public Long validate(String value, String pattern) {
 131  8 
         return (Long)parse(value, pattern, (Locale)null);
 132   
     }
 133   
 
 134   
     /**
 135   
      * <p>Validate/convert a <code>Long</code> using the
 136   
      *    specified <code>Locale</code>.
 137   
      *
 138   
      * @param value The value validation is being performed on.
 139   
      * @param locale The locale to use for the number format, system default if null.
 140   
      * @return The parsed <code>Long</code> if valid or <code>null</code> if invalid.
 141   
      */
 142   
     public Long validate(String value, Locale locale) {
 143  2 
         return (Long)parse(value, (String)null, locale);
 144   
     }
 145   
 
 146   
     /**
 147   
      * <p>Validate/convert a <code>Long</code> using the
 148   
      *    specified pattern and/ or <code>Locale</code>.
 149   
      *
 150   
      * @param value The value validation is being performed on.
 151   
      * @param pattern The pattern used to validate the value against, or the
 152   
      *        default for the <code>Locale</code> if <code>null</code>.
 153   
      * @param locale The locale to use for the date format, system default if null.
 154   
      * @return The parsed <code>Long</code> if valid or <code>null</code> if invalid.
 155   
      */
 156   
     public Long validate(String value, String pattern, Locale locale) {
 157  2 
         return (Long)parse(value, pattern, locale);
 158   
     }
 159   
 
 160   
     /**
 161   
      * Check if the value is within a specified range.
 162   
      *
 163   
      * @param value The <code>Number</code> value to check.
 164   
      * @param min The minimum value of the range.
 165   
      * @param max The maximum value of the range.
 166   
      * @return <code>true</code> if the value is within the
 167   
      *         specified range.
 168   
      */
 169   
     public boolean isInRange(long value, long min, long max) {
 170  5 
         return (value >= min && value <= max);
 171   
     }
 172   
 
 173   
     /**
 174   
      * Check if the value is within a specified range.
 175   
      *
 176   
      * @param value The <code>Number</code> value to check.
 177   
      * @param min The minimum value of the range.
 178   
      * @param max The maximum value of the range.
 179   
      * @return <code>true</code> if the value is within the
 180   
      *         specified range.
 181   
      */
 182   
     public boolean isInRange(Long value, long min, long max) {
 183  5 
         return isInRange(value.longValue(), min, max);
 184   
     }
 185   
 
 186   
     /**
 187   
      * Check if the value is greater than or equal to a minimum.
 188   
      *
 189   
      * @param value The value validation is being performed on.
 190   
      * @param min The minimum value.
 191   
      * @return <code>true</code> if the value is greater than
 192   
      *         or equal to the minimum.
 193   
      */
 194   
     public boolean minValue(long value, long min) {
 195  3 
         return (value >= min);
 196   
     }
 197   
 
 198   
     /**
 199   
      * Check if the value is greater than or equal to a minimum.
 200   
      *
 201   
      * @param value The value validation is being performed on.
 202   
      * @param min The minimum value.
 203   
      * @return <code>true</code> if the value is greater than
 204   
      *         or equal to the minimum.
 205   
      */
 206   
     public boolean minValue(Long value, long min) {
 207  3 
         return minValue(value.longValue(), min);
 208   
     }
 209   
 
 210   
     /**
 211   
      * Check if the value is less than or equal to a maximum.
 212   
      *
 213   
      * @param value The value validation is being performed on.
 214   
      * @param max The maximum value.
 215   
      * @return <code>true</code> if the value is less than
 216   
      *         or equal to the maximum.
 217   
      */
 218   
     public boolean maxValue(long value, long max) {
 219  3 
         return (value <= max);
 220   
     }
 221   
 
 222   
     /**
 223   
      * Check if the value is less than or equal to a maximum.
 224   
      *
 225   
      * @param value The value validation is being performed on.
 226   
      * @param max The maximum value.
 227   
      * @return <code>true</code> if the value is less than
 228   
      *         or equal to the maximum.
 229   
      */
 230   
     public boolean maxValue(Long value, long max) {
 231  3 
         return maxValue(value.longValue(), max);
 232   
     }
 233   
 
 234   
     /**
 235   
      * Convert the parsed value to a <code>Long</code>.
 236   
      *
 237   
      * @param value The parsed <code>Number</code> object created.
 238   
      * @param formatter The Format used to parse the value with.
 239   
      * @return The parsed <code>Number</code> converted to a
 240   
      *         <code>Long</code>.
 241   
      */
 242   
     @Override
 243   
     protected Object processParsedValue(Object value, Format formatter) {
 244   
 
 245  49 
         if (value instanceof Long) {
 246  45 
             return value;
 247   
         }
 248  4 
         return Long.valueOf(((Number)value).longValue());
 249   
 
 250   
     }
 251   
 }
Report generated by Cobertura 2.1.1 on 16/02/17 15:43.