Clover coverage report - Ant Coverage
Coverage timestamp: Tue Apr 8 2003 20:43:55 EST
file stats: LOC: 145   Methods: 5
NCLOC: 29   Classes: 1
 
 Source file Conditionals Statements Methods TOTAL
BaseSelector.java 83.3% 100% 100% 94.4%
 1   
 /*
 2   
  * The Apache Software License, Version 1.1
 3   
  *
 4   
  * Copyright (c) 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.selectors;
 56   
 
 57   
 import java.io.File;
 58   
 import org.apache.tools.ant.BuildException;
 59   
 import org.apache.tools.ant.types.DataType;
 60   
 
 61   
 /**
 62   
  * A convenience base class that you can subclass Selectors from. It
 63   
  * provides some helpful common behaviour. Note that there is no need
 64   
  * for Selectors to inherit from this class, it is only necessary that
 65   
  * they implement FileSelector.
 66   
  *
 67   
  * @author <a href="mailto:bruce@callenish.com">Bruce Atherton</a>
 68   
  * @since 1.5
 69   
  */
 70   
 public abstract class BaseSelector extends DataType implements FileSelector {
 71   
 
 72   
     private String errmsg = null;
 73   
 
 74   
 
 75   
     /**
 76   
      * Do nothing constructor.
 77   
      */
 78  231
     public BaseSelector() {
 79   
     }
 80   
 
 81   
     /**
 82   
      * Allows all selectors to indicate a setup error. Note that only
 83   
      * the first error message is recorded.
 84   
      *
 85   
      * @param msg The error message any BuildException should throw.
 86   
      */
 87  28
     public void setError(String msg) {
 88  28
         if (errmsg == null) {
 89  28
             errmsg = msg;
 90   
         }
 91   
     }
 92   
 
 93   
     /**
 94   
      * Returns any error messages that have been set.
 95   
      *
 96   
      * @return the error condition
 97   
      */
 98  902361
     public String getError() {
 99  902361
         return errmsg;
 100   
     }
 101   
 
 102   
 
 103   
     /**
 104   
      * <p>Subclasses can override this method to provide checking of their
 105   
      * state. So long as they call validate() from isSelected(), this will
 106   
      * be called automatically (unless they override validate()).</p>
 107   
      * <p>Implementations should check for incorrect settings and call
 108   
      * setError() as necessary.</p>
 109   
      */
 110  69627
     public void verifySettings() {
 111   
     }
 112   
 
 113   
 
 114   
 
 115   
     /**
 116   
      * Subclasses can use this to throw the requisite exception
 117   
      * in isSelected() in the case of an error condition.
 118   
      */
 119  330591
     public void validate() {
 120  330591
         if (getError() == null) {
 121  330572
             verifySettings();
 122   
         }
 123  330591
         if (getError() != null) {
 124  28
             throw new BuildException(errmsg);
 125   
         }
 126   
     }
 127   
 
 128   
     /**
 129   
      * Method that each selector will implement to create their
 130   
      * selection behaviour. If there is a problem with the setup
 131   
      * of a selector, it can throw a BuildException to indicate
 132   
      * the problem.
 133   
      *
 134   
      * @param basedir A java.io.File object for the base directory
 135   
      * @param filename The name of the file to check
 136   
      * @param file A File object for this filename
 137   
      * @return whether the file should be selected or not
 138   
      */
 139   
     public abstract boolean isSelected(File basedir, String filename,
 140   
             File file);
 141   
 
 142   
 }
 143   
 
 144   
 
 145