Clover coverage report - Ant Coverage
Coverage timestamp: Tue Apr 8 2003 20:43:55 EST
file stats: LOC: 165   Methods: 5
NCLOC: 45   Classes: 1
 
 Source file Conditionals Statements Methods TOTAL
ClearCase.java 0% 0% 0% 0%
 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.optional.clearcase;
 56   
 
 57   
 import org.apache.tools.ant.BuildException;
 58   
 import org.apache.tools.ant.Project;
 59   
 import org.apache.tools.ant.Task;
 60   
 import org.apache.tools.ant.taskdefs.Execute;
 61   
 import org.apache.tools.ant.taskdefs.LogStreamHandler;
 62   
 import org.apache.tools.ant.types.Commandline;
 63   
 
 64   
 
 65   
 
 66   
 /**
 67   
  * A base class for creating tasks for executing commands on ClearCase.
 68   
  * <p>
 69   
  * The class extends the 'exec' task as it operates by executing the cleartool program
 70   
  * supplied with ClearCase. By default the task expects the cleartool executable to be
 71   
  * in the path, * you can override this be specifying the cleartooldir attribute.
 72   
  * </p>
 73   
  * <p>
 74   
  * This class provides set and get methods for the 'viewpath' attribute. It
 75   
  * also contains constants for the flags that can be passed to cleartool.
 76   
  * </p>
 77   
  *
 78   
  * @author Curtis White
 79   
  */
 80   
 public abstract class ClearCase extends Task {
 81   
     private String m_ClearToolDir = "";
 82   
     private String m_viewPath = null;
 83   
 
 84   
     /**
 85   
      * Set the directory where the cleartool executable is located.
 86   
      *
 87   
      * @param dir the directory containing the cleartool executable
 88   
      */
 89  0
     public final void setClearToolDir(String dir) {
 90  0
         m_ClearToolDir = getProject().translatePath(dir);
 91   
     }
 92   
 
 93   
     /**
 94   
      * Builds and returns the command string to execute cleartool
 95   
      *
 96   
      * @return String containing path to the executable
 97   
      */
 98  0
     protected final String getClearToolCommand() {
 99  0
         String toReturn = m_ClearToolDir;
 100  0
         if (!toReturn.equals("") && !toReturn.endsWith("/")) {
 101  0
             toReturn += "/";
 102   
         }
 103   
 
 104  0
         toReturn += CLEARTOOL_EXE;
 105   
 
 106  0
         return toReturn;
 107   
     }
 108   
 
 109   
     /**
 110   
      * Set the path to the item in a ClearCase view to operate on.
 111   
      *
 112   
      * @param viewPath Path to the view directory or file
 113   
      */
 114  0
     public final void setViewPath(String viewPath) {
 115  0
         m_viewPath = viewPath;
 116   
     }
 117   
 
 118   
     /**
 119   
      * Get the path to the item in a clearcase view
 120   
      *
 121   
      * @return m_viewPath
 122   
      */
 123  0
     public String getViewPath() {
 124  0
         return m_viewPath;
 125   
     }
 126   
 
 127   
 
 128  0
     protected int run(Commandline cmd) {
 129  0
         try {
 130  0
             Project aProj = getProject();
 131  0
             Execute exe = new Execute(new LogStreamHandler(this, Project.MSG_INFO, Project.MSG_WARN));
 132  0
             exe.setAntRun(aProj);
 133  0
             exe.setWorkingDirectory(aProj.getBaseDir());
 134  0
             exe.setCommandline(cmd.getCommandline());
 135  0
             return exe.execute();
 136   
         } catch (java.io.IOException e) {
 137  0
             throw new BuildException(e, getLocation());
 138   
         }
 139   
     }
 140   
 
 141   
     /**
 142   
      * Constant for the thing to execute
 143   
      */
 144   
     private static final String CLEARTOOL_EXE = "cleartool";
 145   
 
 146   
     /**
 147   
      * The 'Update' command
 148   
      */
 149   
     public static final String COMMAND_UPDATE = "update";
 150   
     /**
 151   
      * The 'Checkout' command
 152   
      */
 153   
     public static final String COMMAND_CHECKOUT = "checkout";
 154   
     /**
 155   
      * The 'Checkin' command
 156   
      */
 157   
     public static final String COMMAND_CHECKIN = "checkin";
 158   
     /**
 159   
      * The 'UndoCheckout' command
 160   
      */
 161   
     public static final String COMMAND_UNCHECKOUT = "uncheckout";
 162   
 
 163   
 }
 164   
 
 165