Package 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
- All Implemented Interfaces:
Cloneable
Reads an input line from the console.
- Since:
- Ant 1.5
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionclassRepresents an InputHandler.static classEnumeratedAttribute representing the built-in input handler types: "default", "propertyfile", "greedy", "secure" (since Ant 1.8). -
Field Summary
Fields inherited from class org.apache.tools.ant.ProjectComponent
description, location, project -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidSet a multiline message.Create a nested handler element.voidexecute()Actual method executed by ant.voidsetAddproperty(String addproperty) Defines the name of a property to be created from input.voidsetDefaultvalue(String defaultvalue) Defines the default value of the property to be created from input.voidsetMessage(String message) Sets the Message which gets displayed to the user during the build run.voidsetValidargs(String validargs) Defines valid input parameters as comma separated strings.Methods inherited from class org.apache.tools.ant.Task
bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskTypeMethods inherited from class org.apache.tools.ant.ProjectComponent
clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
-
Constructor Details
-
Input
public Input()
-
-
Method Details
-
setValidargs
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
Defines the name of a property to be created from input. Behaviour is according to property task which means that existing properties cannot be overridden.- Parameters:
addproperty- Name for the property to be created from input
-
setMessage
Sets the Message which gets displayed to the user during the build run.- Parameters:
message- The message to be displayed.
-
setDefaultvalue
Defines the default value of the property to be created from input. Property value will be set to default if not input is received.- Parameters:
defaultvalue- Default value for the property if no input is received
-
addText
Set a multiline message.- Parameters:
msg- The message to be displayed.
-
execute
Actual method executed by ant.- Overrides:
executein classTask- Throws:
BuildException- on error
-
createHandler
Create a nested handler element.- Returns:
- a Handler for this Input task.
-