Clover coverage report - Ant Coverage
Coverage timestamp: Tue Apr 8 2003 20:43:55 EST
file stats: LOC: 158   Methods: 7
NCLOC: 41   Classes: 1
 
 Source file Conditionals Statements Methods TOTAL
EnumeratedAttribute.java 100% 100% 100% 100%
 1   
 /*
 2   
  * The Apache Software License, Version 1.1
 3   
  *
 4   
  * Copyright (c) 2000-2002 The Apache Software Foundation.  All rights
 5   
  * reserved.
 6   
  *
 7   
  * Redistribution and use in source and binary forms, with or without
 8   
  * modification, are permitted provided that the following conditions
 9   
  * are met:
 10   
  *
 11   
  * 1. Redistributions of source code must retain the above copyright
 12   
  *    notice, this list of conditions and the following disclaimer.
 13   
  *
 14   
  * 2. Redistributions in binary form must reproduce the above copyright
 15   
  *    notice, this list of conditions and the following disclaimer in
 16   
  *    the documentation and/or other materials provided with the
 17   
  *    distribution.
 18   
  *
 19   
  * 3. The end-user documentation included with the redistribution, if
 20   
  *    any, must include the following acknowlegement:
 21   
  *       "This product includes software developed by the
 22   
  *        Apache Software Foundation (http://www.apache.org/)."
 23   
  *    Alternately, this acknowlegement may appear in the software itself,
 24   
  *    if and wherever such third-party acknowlegements normally appear.
 25   
  *
 26   
  * 4. The names "Ant" and "Apache Software
 27   
  *    Foundation" must not be used to endorse or promote products derived
 28   
  *    from this software without prior written permission. For written
 29   
  *    permission, please contact apache@apache.org.
 30   
  *
 31   
  * 5. Products derived from this software may not be called "Apache"
 32   
  *    nor may "Apache" appear in their names without prior written
 33   
  *    permission of the Apache Group.
 34   
  *
 35   
  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 36   
  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 37   
  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 38   
  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
 39   
  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 40   
  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 41   
  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 42   
  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 43   
  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 44   
  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 45   
  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 46   
  * SUCH DAMAGE.
 47   
  * ====================================================================
 48   
  *
 49   
  * This software consists of voluntary contributions made by many
 50   
  * individuals on behalf of the Apache Software Foundation.  For more
 51   
  * information on the Apache Software Foundation, please see
 52   
  * <http://www.apache.org/>.
 53   
  */
 54   
 
 55   
 package org.apache.tools.ant.types;
 56   
 
 57   
 import org.apache.tools.ant.BuildException;
 58   
 
 59   
 /**
 60   
  * Helper class for attributes that can only take one of a fixed list
 61   
  * of values.
 62   
  *
 63   
  * <p>See {@link org.apache.tools.ant.taskdefs.FixCRLF FixCRLF} for an
 64   
  * example.
 65   
  *
 66   
  * @author Stefan Bodewig 
 67   
  */
 68   
 public abstract class EnumeratedAttribute {
 69   
 
 70   
     /**
 71   
      * The selected value in this enumeration.
 72   
      */
 73   
     protected String value;
 74   
 
 75   
     /**
 76   
      * the index of the selected value in the array.
 77   
      */
 78   
     private int index = -1;
 79   
 
 80   
     /**
 81   
      * This is the only method a subclass needs to implement.
 82   
      *
 83   
      * @return an array holding all possible values of the enumeration.
 84   
      * The order of elements must be fixed so that <tt>indexOfValue(String)</tt>
 85   
      * always return the same index for the same value.
 86   
      */
 87   
     public abstract String[] getValues();
 88   
 
 89   
     /** bean constructor */
 90  196
     protected EnumeratedAttribute(){
 91   
     }
 92   
 
 93   
     /**
 94   
      * Invoked by {@link org.apache.tools.ant.IntrospectionHelper IntrospectionHelper}.
 95   
      */
 96  213
     public final void setValue(String value) throws BuildException {
 97  213
         int index = indexOfValue(value);
 98  213
         if (index == -1) {
 99  7
             throw new BuildException(value + " is not a legal value for this attribute");
 100   
         }
 101  206
         this.index = index;
 102  206
         this.value = value;
 103   
     }
 104   
 
 105   
     /**
 106   
      * Is this value included in the enumeration?
 107   
      */
 108  8
     public final boolean containsValue(String value) {
 109  8
         return (indexOfValue(value) != -1);
 110   
     }
 111   
 
 112   
     /**
 113   
      * get the index of a value in this enumeration.
 114   
      * @param value the string value to look for.
 115   
      * @return the index of the value in the array of strings
 116   
      * or -1 if it cannot be found.
 117   
      * @see #getValues()
 118   
      */
 119  221
     public final int indexOfValue(String value){
 120  221
         String[] values = getValues();
 121  221
         if (values == null || value == null) {
 122  2
             return -1;
 123   
         }
 124  219
         for (int i = 0; i < values.length; i++){
 125  498
             if (value.equals(values[i])){
 126  209
                 return i;
 127   
             }
 128   
         }
 129  10
         return -1;
 130   
     }
 131   
 
 132   
     /**
 133   
      * @return the selected value.
 134   
      */
 135  302
     public final String getValue() {
 136  302
         return value;
 137   
     }
 138   
 
 139   
     /**
 140   
      * @return the index of the selected value in the array.
 141   
      * @see #getValues()
 142   
      */
 143  21
     public final int getIndex() {
 144  21
         return index;
 145   
     }
 146   
 
 147   
 
 148   
     /**
 149   
      * Convert the value to its string form.
 150   
      *
 151   
      * @return the string form of the value.
 152   
      */        
 153  2
     public String toString() {
 154  2
         return getValue();
 155   
     }
 156   
 
 157   
 }
 158