Clover coverage report - Ant Coverage
Coverage timestamp: Tue Apr 8 2003 20:43:55 EST
file stats: LOC: 134   Methods: 5
NCLOC: 40   Classes: 1
 
 Source file Conditionals Statements Methods TOTAL
Filter.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.taskdefs;
 56   
 
 57   
 import java.io.File;
 58   
 import org.apache.tools.ant.BuildException;
 59   
 import org.apache.tools.ant.Project;
 60   
 import org.apache.tools.ant.Task;
 61   
 
 62   
 /**
 63   
  * Sets a token filter that is used by the file copy tasks
 64   
  * to do token substitution. Sets mutiple tokens by
 65   
  * reading these from a file.
 66   
  *
 67   
  * @author Stefano Mazzocchi
 68   
  *         <a href="mailto:stefano@apache.org">stefano@apache.org</a>
 69   
  * @author Gero Vermaas <a href="mailto:gero@xs4all.nl">gero@xs4all.nl</a>
 70   
  * @author <A href="gholam@xtra.co.nz">Michael McCallum</A>
 71   
  *
 72   
  * @since Ant 1.1
 73   
  *
 74   
  * @ant.task category="filesystem"
 75   
  */
 76   
 public class Filter extends Task {
 77   
 
 78   
     private String token;
 79   
     private String value;
 80   
     private File filtersFile;
 81   
 
 82   
     /**
 83   
      * The token string without @ delimiters.
 84   
      * @param token token to set
 85   
      */
 86  6
     public void setToken(String token) {
 87  6
         this.token = token;
 88   
     }
 89   
 
 90   
     /**
 91   
      * The string that should replace the token during filtered copies.
 92   
      * @param value token replace value
 93   
      */
 94  6
     public void setValue(String value) {
 95  6
         this.value = value;
 96   
     }
 97   
 
 98   
     /**
 99   
      * The file from which the filters must be read.
 100   
      * This file must be a formatted as a property file.
 101   
      *
 102   
      * @param filtersFile filter file
 103   
      */
 104  1
     public void setFiltersfile(File filtersFile) {
 105  1
         this.filtersFile = filtersFile;
 106   
     }
 107   
 
 108  9
     public void execute() throws BuildException {
 109  9
         boolean isFiltersFromFile =
 110   
             filtersFile != null && token == null && value == null;
 111  9
         boolean isSingleFilter =
 112   
             filtersFile == null && token != null && value != null;
 113   
 
 114  9
         if (!isFiltersFromFile && !isSingleFilter) {
 115  3
             throw new BuildException("both token and value parameters, or "
 116   
                                      + "only a filtersFile parameter is "
 117   
                                      + "required", getLocation());
 118   
         }
 119   
 
 120  6
         if (isSingleFilter) {
 121  5
             getProject().getGlobalFilterSet().addFilter(token, value);
 122   
         }
 123   
 
 124  6
         if (isFiltersFromFile) {
 125  1
             readFilters();
 126   
         }
 127   
     }
 128   
 
 129  1
     protected void readFilters() throws BuildException {
 130  1
         log("Reading filters from " + filtersFile, Project.MSG_VERBOSE);
 131  1
         getProject().getGlobalFilterSet().readFiltersFromFile(filtersFile);
 132   
     }
 133   
 }
 134