Clover coverage report - Ant Coverage
Coverage timestamp: Tue Apr 8 2003 20:43:55 EST
file stats: LOC: 161   Methods: 7
NCLOC: 48   Classes: 1
 
 Source file Conditionals Statements Methods TOTAL
Input.java 83.3% 87.5% 85.7% 86.2%
 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;
 56   
 
 57   
 import java.util.Vector;
 58   
 import org.apache.tools.ant.BuildException;
 59   
 import org.apache.tools.ant.Task;
 60   
 import org.apache.tools.ant.input.InputRequest;
 61   
 import org.apache.tools.ant.input.MultipleChoiceInputRequest;
 62   
 import org.apache.tools.ant.util.StringUtils;
 63   
 
 64   
 /**
 65   
  * Reads an input line from the console.
 66   
  *
 67   
  * @author <a href="mailto:usch@usch.net">Ulrich Schmidt</a>
 68   
  * @author Stefan Bodewig
 69   
  *
 70   
  * @since Ant 1.5
 71   
  *
 72   
  * @ant.task category="control"
 73   
  */
 74   
 public class Input extends Task {
 75   
     private String validargs = null;
 76   
     private String message = "";
 77   
     private String addproperty = null;
 78   
     private String defaultvalue = null;
 79   
 
 80   
     /**
 81   
      * Defines valid input parameters as comma separated strings. If set, input
 82   
      * task will reject any input not defined as accepted and requires the user
 83   
      * to reenter it. Validargs are case sensitive. If you want 'a' and 'A' to
 84   
      * be accepted you need to define both values as accepted arguments.
 85   
      *
 86   
      * @param validargs A comma separated String defining valid input args.
 87   
      */
 88  2
     public void setValidargs (String validargs) {
 89  2
         this.validargs = validargs;
 90   
     }
 91   
 
 92   
     /**
 93   
      * Defines the name of a property to be created from input. Behaviour is
 94   
      * according to property task which means that existing properties
 95   
      * cannot be overriden.
 96   
      *
 97   
      * @param addproperty Name for the property to be created from input
 98   
      */
 99  1
     public void setAddproperty (String addproperty) {
 100  1
         this.addproperty = addproperty;
 101   
     }
 102   
 
 103   
     /**
 104   
      * Sets the Message which gets displayed to the user during the build run.
 105   
      * @param message The message to be displayed.
 106   
      */
 107  4
     public void setMessage (String message) {
 108  4
         this.message = message;
 109   
     }
 110   
 
 111   
     /**
 112   
      * Defines the default value of the property to be created from input.
 113   
      * Property value will be set to default if not input is received.
 114   
      *
 115   
      * @param defaultvalue Default value for the property if no input
 116   
      * is received
 117   
      */
 118  0
     public void setDefaultvalue (String defaultvalue) {
 119  0
         this.defaultvalue = defaultvalue;
 120   
     }
 121   
 
 122   
     /**
 123   
      * Set a multiline message.
 124   
      */
 125  1
     public void addText(String msg) {
 126  1
         message += getProject().replaceProperties(msg);
 127   
     }
 128   
 
 129   
     /**
 130   
      * No arg constructor.
 131   
      */
 132  5
     public Input () {
 133   
     }
 134   
 
 135   
     /**
 136   
      * Actual method executed by jakarta-ant.
 137   
      * @exception BuildException
 138   
      */
 139  5
     public void execute () throws BuildException {
 140  5
         InputRequest request = null;
 141  5
         if (validargs != null) {
 142  2
             Vector accept = StringUtils.split(validargs, ',');
 143  2
             request = new MultipleChoiceInputRequest(message, accept);
 144   
         } else {
 145  3
             request = new InputRequest(message);
 146   
         }
 147   
 
 148  5
         getProject().getInputHandler().handleInput(request);
 149   
 
 150  4
         String value = request.getInput();
 151  4
         if ((value == null || value.trim().length() == 0) 
 152   
             && defaultvalue != null) {
 153  0
             value = defaultvalue;
 154   
         }
 155  4
         if (addproperty != null && value != null) {
 156  1
             getProject().setNewProperty(addproperty, value);
 157   
         }
 158   
     }
 159   
 
 160   
 }
 161