org.apache.tools.ant.taskdefs

Class Input

public class Input extends Task

Reads an input line from the console.

Since: Ant 1.5

UNKNOWN: category="control"

Nested Class Summary
class	Input.Handler Represents an InputHandler.
static class	Input.HandlerType EnumeratedAttribute representing the built-in input handler types: "default", "propertyfile", "greedy".

Constructor Summary
	Input() No arg constructor.

Method Summary
void	addText(String msg) Set a multiline message.
Input.Handler	createHandler() Create a nested handler element.
void	execute() Actual method executed by ant.
void	setAddproperty(String addproperty) Defines the name of a property to be created from input.
void	setDefaultvalue(String defaultvalue) Defines the default value of the property to be created from input.
void	setMessage(String message) Sets the Message which gets displayed to the user during the build run.
void	setValidargs(String validargs) Defines valid input parameters as comma separated strings.

Method Detail

addText

public void addText(String msg)

Set a multiline message.

Parameters: msg The message to be displayed.

createHandler

public Input.Handler createHandler()

Create a nested handler element.

Returns: a Handler for this Input task.

execute

public void execute()

Actual method executed by ant.

Throws: BuildException on error

setAddproperty

public void setAddproperty(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 overridden.

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

setDefaultvalue

public void setDefaultvalue(String defaultvalue)

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

setMessage

public void setMessage(String message)

Sets the Message which gets displayed to the user during the build run.

Parameters: message The message to be displayed.

setValidargs

public void setValidargs(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.