org.apache.tools.ant.taskdefs

Class Input


public class Input
extends Task

Reads an input line from the console.
Since:
Ant 1.5

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(String msg)
Set a multiline message.
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.

Methods inherited from class org.apache.tools.ant.Task

execute, getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, maybeConfigure, perform, reconfigure, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

getProject, log, log, setProject

Constructor Details

Input

public Input()
No arg constructor.

Method Details

addText

public void addText(String msg)
Set a multiline message.
Parameters:
msg - The message to be displayed.

execute

public void execute()
            throws BuildException
Actual method executed by ant.
Overrides:
execute in interface Task
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.

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