Clover coverage report - Ant Coverage
Coverage timestamp: Tue Apr 8 2003 20:43:55 EST
file stats: LOC: 156   Methods: 4
NCLOC: 51   Classes: 1
 
 Source file Conditionals Statements Methods TOTAL
SourceFileScanner.java 100% 100% 100% 100%
 1   
 /*
 2   
  * The Apache Software License, Version 1.1
 3   
  *
 4   
  * Copyright (c) 2000-2003 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.util;
 56   
 
 57   
 import java.io.File;
 58   
 import java.util.Vector;
 59   
 import org.apache.tools.ant.Project;
 60   
 import org.apache.tools.ant.Task;
 61   
 import org.apache.tools.ant.types.ResourceFactory;
 62   
 import org.apache.tools.ant.types.Resource;
 63   
 import org.apache.tools.ant.taskdefs.condition.Os;
 64   
 
 65   
 /**
 66   
  * Utility class that collects the functionality of the various
 67   
  * scanDir methods that have been scattered in several tasks before.
 68   
  *
 69   
  * <p>The only method returns an array of source files. The array is a
 70   
  * subset of the files given as a parameter and holds only those that
 71   
  * are newer than their corresponding target files.</p>
 72   
  *
 73   
  * @author Stefan Bodewig
 74   
  * @author <a href="mailto:levylambert@tiscali-dsl.de">Antoine Levy-Lambert</a>
 75   
  */
 76   
 public class SourceFileScanner implements ResourceFactory {
 77   
 
 78   
     protected Task task;
 79   
 
 80   
     private FileUtils fileUtils;
 81   
     private File destDir;     // base directory of the fileset
 82   
 
 83   
     /**
 84   
      * @param task The task we should log messages through
 85   
      */
 86  77
     public SourceFileScanner(Task task) {
 87  77
         this.task = task;
 88  77
         fileUtils = FileUtils.newFileUtils();
 89   
     }
 90   
 
 91   
     /**
 92   
      * Restrict the given set of files to those that are newer than
 93   
      * their corresponding target files.
 94   
      *
 95   
      * @param files   the original set of files
 96   
      * @param srcDir  all files are relative to this directory
 97   
      * @param destDir target files live here. if null file names
 98   
      *                returned by the mapper are assumed to be absolute.
 99   
      * @param mapper  knows how to construct a target file names from
 100   
      *                source file names.
 101   
      */
 102  77
     public String[] restrict(String[] files, File srcDir, File destDir,
 103   
                              FileNameMapper mapper) {
 104   
         // record destdir for later use in getResource
 105  77
         this.destDir = destDir;
 106  77
         Vector v = new Vector();
 107  77
         for (int i = 0; i < files.length; i++) {
 108  1376
             File src = fileUtils.resolveFile(srcDir, files[i]);
 109  1376
             v.addElement(new Resource(files[i], src.exists(),
 110   
                                       src.lastModified(), src.isDirectory()));
 111   
         }
 112  77
         Resource[] sourceresources= new Resource[v.size()];
 113  77
         v.copyInto(sourceresources);
 114   
 
 115   
         // build the list of sources which are out of date with
 116   
         // respect to the target
 117  77
         Resource[] outofdate = 
 118   
             ResourceUtils.selectOutOfDateSources(task, sourceresources,
 119   
                                                  mapper, this);
 120  77
         String[] result = new String[outofdate.length];
 121  77
         for (int counter=0; counter < outofdate.length; counter++) {
 122  300
             result[counter] = outofdate[counter].getName();
 123   
         }
 124  77
         return result;
 125   
     }
 126   
 
 127   
     /**
 128   
      * Convinience layer on top of restrict that returns the source
 129   
      * files as File objects (containing absolute paths if srcDir is
 130   
      * absolute).
 131   
      */
 132  19
     public File[] restrictAsFiles(String[] files, File srcDir, File destDir,
 133   
                                   FileNameMapper mapper) {
 134  19
         String[] res = restrict(files, srcDir, destDir, mapper);
 135  19
         File[] result = new File[res.length];
 136  19
         for (int i = 0; i < res.length; i++) {
 137  60
             result[i] = new File(srcDir, res[i]);
 138   
         }
 139  19
         return result;
 140   
     }
 141   
 
 142   
     /**
 143   
      * returns resource information for a file at destination
 144   
      * @param name relative path of file at destination
 145   
      * @return data concerning a file whose relative path to destDir is name
 146   
      *
 147   
      * @since Ant 1.5.2
 148   
      */
 149  1343
     public Resource getResource(String name) {
 150  1343
         File src = fileUtils.resolveFile(destDir, name);
 151  1343
         return new Resource(name, src.exists(), src.lastModified(),
 152   
                             src.isDirectory());
 153   
     }
 154   
 }
 155   
 
 156