Input (Apache Ant API)

org.apache.tools.ant.taskdefs
Class Input


java.lang.Object

  |

  +--org.apache.tools.ant.ProjectComponent

        |

        +--org.apache.tools.ant.Task

              |

              +--org.apache.tools.ant.taskdefs.Input


public class Input
extends Task

Reads an input line from the console.

Since:
Ant 1.5
Author:
Ulrich Schmidt
, Stefan Bodewig

Field Summary
 
Fields inherited from class org.apache.tools.ant.Task
description, location, target, taskName, taskType, wrapper
 
Fields inherited from class org.apache.tools.ant.ProjectComponent
project
 
Constructor Summary
Input()
          No arg constructor.
 
Method Summary
 void addText(java.lang.String msg)
          Set a multiline message.
 void execute()
          Actual test method executed by jakarta-ant.
 void setAddproperty(java.lang.String addproperty)
          Defines the name of a property to be created from input.
 void setMessage(java.lang.String message)
          Sets the Message which gets displayed to the user during the build run.
 void setValidargs(java.lang.String validargs)
          Defines valid input parameters as comma separated strings.
 
Methods inherited from class org.apache.tools.ant.Task
getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, handleErrorOutput, handleOutput, init, isInvalid, log, log, maybeConfigure, perform, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName
 
Methods inherited from class org.apache.tools.ant.ProjectComponent
getProject, setProject
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Input


public Input()
No arg constructor.

Method Detail

setValidargs


public void setValidargs(java.lang.String validargs)
Defines valid input parameters as comma separated strings. If set, input task will reject any input not defined as accepted and requires the user to reenter it. Validargs are case sensitive. If you want 'a' and 'A' to be accepted you need to define both values as accepted arguments.

Parameters:
validargs - A comma separated String defining valid input args.

setAddproperty


public void setAddproperty(java.lang.String addproperty)
Defines the name of a property to be created from input. Behaviour is according to property task which means that existing properties cannot be overriden.

Parameters:
addproperty - Name for the property to be created from input

setMessage


public void setMessage(java.lang.String message)
Sets the Message which gets displayed to the user during the build run.

Parameters:
message - The message to be displayed.

addText


public void addText(java.lang.String msg)
Set a multiline message.


execute


public void execute()
             throws BuildException
Actual test method executed by jakarta-ant.

Overrides:
execute in class Task
Throws:
BuildException


Copyright © 2000-2002 Apache Software Foundation. All Rights Reserved.