Clover coverage report - Ant Coverage
Coverage timestamp: Tue Apr 8 2003 20:43:55 EST
file stats: LOC: 143   Methods: 4
NCLOC: 36   Classes: 1
 
 Source file Conditionals Statements Methods TOTAL
Basename.java 100% 100% 100% 100%
 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.taskdefs;
 56   
 
 57   
 import java.io.File;
 58   
 import org.apache.tools.ant.BuildException;
 59   
 import org.apache.tools.ant.Task;
 60   
 
 61   
 /**
 62   
  * Sets a property to the base name of a specified file, optionally minus a
 63   
  * suffix.
 64   
  *
 65   
  * This task can accept the following attributes:
 66   
  * <ul>
 67   
  * <li>file
 68   
  * <li>property
 69   
  * <li>suffix
 70   
  * </ul>
 71   
  * The <b>file</b> and <b>property</b> attributes are required. The
 72   
  * <b>suffix</b> attribute can be specified either with or without
 73   
  * the &quot;.&quot;, and the result will be the same (ie., the
 74   
  * returned file name will be minus the .suffix).
 75   
  * <p>
 76   
  * When this task executes, it will set the specified property to the
 77   
  * value of the last element in the specified file. If file is a
 78   
  * directory, the basename will be the last directory element. If file
 79   
  * is a full-path filename, the basename will be the simple file name.
 80   
  * If a suffix is specified, and the specified file ends in that suffix,
 81   
  * the basename will be the simple file name without the suffix.
 82   
  *
 83   
  * @author Diane Holt <a href="mailto:holtdl@apache.org">holtdl@apache.org</a>
 84   
  *
 85   
  * @version $Revision: 1.7 $
 86   
  *
 87   
  * @since Ant 1.5
 88   
  *
 89   
  * @ant.task category="property"
 90   
  */
 91   
 
 92   
 public class Basename extends Task {
 93   
   private File file;
 94   
   private String property;
 95   
   private String suffix;
 96   
 
 97   
   /**
 98   
    * File or directory to get base name from.
 99   
    */
 100  7
   public void setFile(File file) {
 101  7
     this.file = file;
 102   
   }
 103   
 
 104   
   /**
 105   
    * Property to set base name to.
 106   
    */
 107  7
   public void setProperty(String property) {
 108  7
     this.property  = property ;
 109   
   }
 110   
 
 111   
   /**
 112   
    * Optional suffix to remove from base name.
 113   
    */
 114  5
   public void setSuffix(String suffix) {
 115  5
     this.suffix = suffix;
 116   
   }
 117   
 
 118   
 
 119   
   // The method executing the task
 120  9
   public void execute() throws BuildException {
 121  9
       if (property == null) {
 122  2
           throw new BuildException("property attribute required", getLocation());
 123   
       }
 124  7
       if (file == null) {
 125  1
           throw new BuildException("file attribute required", getLocation());
 126   
       }
 127  6
       String value = file.getName();
 128  6
       if (suffix != null && value.endsWith(suffix)) {
 129   
           // if the suffix does not starts with a '.' and the
 130   
           // char preceding the suffix is a '.', we assume the user
 131   
           // wants to remove the '.' as well (see docs)
 132  5
           int pos = value.length() - suffix.length();
 133  5
           if (pos > 0 && suffix.charAt(0) != '.' 
 134   
               && value.charAt(pos - 1) == '.') {
 135  3
               pos--;
 136   
           }
 137  5
           value = value.substring(0, pos);
 138   
       }
 139  6
       getProject().setNewProperty(property, value);
 140   
   }
 141   
 }
 142   
 
 143