Clover coverage report - Ant Coverage
Coverage timestamp: Tue Apr 8 2003 20:43:55 EST
file stats: LOC: 191   Methods: 5
NCLOC: 36   Classes: 1
 
 Source file Conditionals Statements Methods TOTAL
MSVSSLABEL.java 0% 0% 0% 0%
 1   
 /*
 2   
  * The Apache Software License, Version 1.1
 3   
  *
 4   
  * Copyright (c) 2001-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.taskdefs.optional.vss;
 56   
 
 57   
 import org.apache.tools.ant.BuildException;
 58   
 import org.apache.tools.ant.types.Commandline;
 59   
 
 60   
 /**
 61   
  * Performs Label commands to Microsoft Visual SourceSafe.
 62   
  *
 63   
  * <p>
 64   
  * The following attributes are interpreted:
 65   
  * <table border="1">
 66   
  *   <tr>
 67   
  *     <th>Attribute</th>
 68   
  *     <th>Values</th>
 69   
  *     <th>Required</th>
 70   
  *   </tr>
 71   
  *   <tr>
 72   
  *      <td>login</td>
 73   
  *      <td>username,password</td>
 74   
  *      <td>No</td>
 75   
  *   </tr>
 76   
  *   <tr>
 77   
  *      <td>vsspath</td>
 78   
  *      <td>SourceSafe path</td>
 79   
  *      <td>Yes</td>
 80   
  *   </tr>
 81   
  *   <tr>
 82   
  *      <td>ssdir</td>
 83   
  *      <td>directory where <code>ss.exe</code> resides. By default the task
 84   
  *      expects it to be in the PATH.</td>
 85   
  *      <td>No</td>
 86   
  *   </tr>
 87   
  *   <tr>
 88   
  *      <td>label</td>
 89   
  *      <td>A label to apply to the hierarchy</td>
 90   
  *      <td>Yes</td>
 91   
  *   </tr>
 92   
  *   <tr>
 93   
  *      <td>version</td>
 94   
  *      <td>An existing file or project version to label</td>
 95   
  *      <td>No</td>
 96   
  *   </tr>
 97   
  *   <tr>
 98   
  *      <td>autoresponse</td>
 99   
  *      <td>What to respond with (sets the -I option). By default, -I- is
 100   
  *      used; values of Y or N will be appended to this.</td>
 101   
  *      <td>No</td>
 102   
  *   </tr>
 103   
  *   <tr>
 104   
  *      <td>comment</td>
 105   
  *      <td>The comment to use for this label. Empty or '-' for no comment.</td>
 106   
  *      <td>No</td>
 107   
  *   </tr>
 108   
  *
 109   
  * </table>
 110   
  *
 111   
  * @author Phillip Wells
 112   
  * @author Jesse Stockall
 113   
  *
 114   
  * @ant.task name="vsslabel" category="scm"
 115   
  */
 116   
 public class MSVSSLABEL extends MSVSS {
 117   
 
 118   
     /**
 119   
      * Builds a command line to execute ss.
 120   
      * @return     The constructed commandline.
 121   
      */
 122  0
     Commandline buildCmdLine() {
 123  0
         Commandline commandLine = new Commandline();
 124   
 
 125   
         // first off, make sure that we've got a command and a vssdir and a label ...
 126  0
         if (getVsspath() == null) {
 127  0
             throw new BuildException("vsspath attribute must be set!", getLocation());
 128   
         }
 129  0
         if (getLabel() == "") {
 130  0
             String msg = "label attribute must be set!";
 131  0
             throw new BuildException(msg, getLocation());
 132   
         }
 133   
 
 134   
         // build the command line from what we got the format is
 135   
         // ss Label VSS items [-C] [-H] [-I-] [-Llabel] [-N] [-O] [-V] [-Y] [-?]
 136   
         // as specified in the SS.EXE help
 137  0
         commandLine.setExecutable(getSSCommand());
 138  0
         commandLine.createArgument().setValue(COMMAND_LABEL);
 139   
 
 140   
         // VSS items
 141  0
         commandLine.createArgument().setValue(getVsspath());
 142   
         // -C
 143  0
         commandLine.createArgument().setValue(getComment());
 144   
         // -I- or -I-Y or -I-N
 145  0
         commandLine.createArgument().setValue(getAutoresponse());
 146   
         // -L Specify the new label on the command line (instead of being prompted)
 147  0
         commandLine.createArgument().setValue(getLabel());
 148   
         // -V Label an existing file or project version
 149  0
         commandLine.createArgument().setValue(getVersion());
 150   
         // -Y
 151  0
         commandLine.createArgument().setValue(getLogin());
 152   
 
 153  0
         return commandLine;
 154   
     }
 155   
 
 156   
     /**
 157   
      * Set the label to apply in SourceSafe.; required.
 158   
      * @param  label The label to apply.
 159   
      */
 160  0
     public void setLabel(String label) {
 161  0
         super.setInternalLabel(label);
 162   
     }
 163   
 
 164   
     /**
 165   
      * Set the stored version string.; optional.
 166   
      * @param  version The version to label.
 167   
      */
 168  0
     public void setVersion(String version) {
 169  0
         super.setInternalVersion(version);
 170   
     }
 171   
 
 172   
     /**
 173   
      * The comment to use for this label.; optional.
 174   
      * Empty or '-' for no comment.
 175   
      * @param comment The comment to apply in SourceSafe
 176   
      */
 177  0
     public void setComment(String comment) {
 178  0
         super.setInternalComment(comment);
 179   
     }
 180   
 
 181   
     /**
 182   
      * Sets the autoresponce behaviour.; optional.
 183   
      * <p>
 184   
      * Valid options are Y and N.
 185   
      * @param response The auto response value.
 186   
      */
 187  0
     public void setAutoresponse(String response){
 188  0
         super.setInternalAutoResponse(response);
 189   
     }
 190   
 }
 191