Modifier and Type	Class and Description
public class	Input.Handler Represents an InputHandler.
public static class	Input.HandlerType EnumeratedAttribute representing the built-in input handler types: "default", "propertyfile", "greedy", "secure" (since Ant 1.8).

Modifier and Type	Field and Description
private String	addproperty
private String	defaultvalue
private Input.Handler	handler
private String	message
private boolean	messageAttribute
private String	validargs

Access	Constructor and Description
public	Input()

Method Summary

Modifier and Type	Method and Description
public void	addText(final String The message to be displayed. msg) Set a multiline message.
public Input.Handler	Returns: a Handler for this Input task. createHandler() Create a nested handler element.
public void	execute() Overrides org.apache.tools.ant.Task.execute. Actual method executed by ant.
public void	setAddproperty(final String Name for the property to be created from input addproperty) Defines the name of a property to be created from input.
public void	setDefaultvalue(final String Default value for the property if no input is received defaultvalue) Defines the default value of the property to be created from input.
public void	setMessage(final String The message to be displayed. message) Sets the Message which gets displayed to the user during the build run.
public void	setValidargs(final String A comma separated String defining valid input args. validargs) Defines valid input parameters as comma separated strings.

addproperty	back to summary
private String addproperty

defaultvalue	back to summary
private String defaultvalue

handler	back to summary
private Input.Handler handler

message	back to summary
private String message

messageAttribute	back to summary
private boolean messageAttribute

validargs	back to summary
private String validargs

Constructor Detail

Input	back to summary
public Input()

Method Detail

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

addText

back to summary

public void addText(final String msg)

Set a multiline message.

Parameters

msg:String: The message to be displayed.

createHandler	back to summary
public Input.Handler createHandler() Create a nested handler element. Returns:Input.Handler a Handler for this Input task.

createHandler

back to summary

public Input.Handler createHandler()

Create a nested handler element.

Returns:Input.Handler: a Handler for this Input task.

execute	back to summary
public void execute() throws BuildException Overrides org.apache.tools.ant.Task.execute. Actual method executed by ant. Annotations @Override Exceptions BuildException: on error

execute

back to summary

public void execute() throws BuildException

Overrides org.apache.tools.ant.Task.execute.

Actual method executed by ant.

Annotations

@Override

Exceptions

BuildException:: on error

setAddproperty	back to summary
public void setAddproperty(final 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:String Name for the property to be created from input

setAddproperty

back to summary

public void setAddproperty(final 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:String: Name for the property to be created from input

setDefaultvalue	back to summary
public void setDefaultvalue(final 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:String Default value for the property if no input is received

setDefaultvalue

back to summary

public void setDefaultvalue(final 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:String: Default value for the property if no input is received

setMessage	back to summary
public void setMessage(final String message) Sets the Message which gets displayed to the user during the build run. Parameters message:String The message to be displayed.

setMessage

back to summary

public void setMessage(final String message)

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

Parameters

message:String: The message to be displayed.

setValidargs	back to summary
public void setValidargs(final 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:String A comma separated String defining valid input args.

setValidargs

back to summary

public void setValidargs(final 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:String: A comma separated String defining valid input args.

org.apache.tools.ant.taskdefs back to summary

public Class Input.Handler

Class Inheritance

extends DefBase

java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
org.apache.tools.ant.taskdefs.AntlibDefinition
org.apache.tools.ant.taskdefs.DefBase
org.apache.tools.ant.taskdefs.Input.Handler

Represents an InputHandler.

Field Summary

Modifier and Type	Field and Description
private String	classname
private String	refid
private Input.HandlerType	type

Constructor Summary

Access	Constructor and Description
public	Handler()

Method Summary

Modifier and Type	Method and Description
public String	Returns: String classname. getClassname() Get the classname of the InputHandler.
private InputHandler	getInputHandler()
public String	Returns: String refid. getRefid() Get the refid of this Handler.
public Input.HandlerType	Returns: a HandlerType object. getType() Get the handler type.
public void	setClassname(final String the String classname. classname) Set the InputHandler classname.
public void	setRefid(final String the String refid. refid) Specify that the handler is a reference on the project; this allows the use of a custom inputhandler.
public void	setType(final Input.HandlerType a HandlerType. type) Set the handler type.

Inherited from org.apache.tools.ant.taskdefs.DefBase:: createClasspath createLoader getClasspath getClasspathId getLoaderId hasCpDelegate init isReverseLoader setClasspath setClasspathRef setLoaderRef setReverseLoader

Field Detail

classname	back to summary
private String classname

refid	back to summary
private String refid

type	back to summary
private Input.HandlerType type

Constructor Detail

Handler	back to summary
public Handler()

Method Detail

getClassname	back to summary
public String getClassname() Get the classname of the InputHandler. Returns:String String classname.

getClassname

back to summary

public String getClassname()

Get the classname of the InputHandler.

Returns:String: String classname.

getInputHandler	back to summary
private InputHandler getInputHandler()

getRefid	back to summary
public String getRefid() Get the refid of this Handler. Returns:String String refid.

getRefid

back to summary

public String getRefid()

Get the refid of this Handler.

Returns:String: String refid.

getType	back to summary
public Input.HandlerType getType() Get the handler type. Returns:Input.HandlerType a HandlerType object.

getType

back to summary

public Input.HandlerType getType()

Get the handler type.

Returns:Input.HandlerType: a HandlerType object.

setClassname	back to summary
public void setClassname(final String classname) Set the InputHandler classname. Parameters classname:String the String classname.

setClassname

back to summary

public void setClassname(final String classname)

Set the InputHandler classname.

Parameters

classname:String: the String classname.

setRefid	back to summary
public void setRefid(final String refid) Specify that the handler is a reference on the project; this allows the use of a custom inputhandler. Parameters refid:String the String refid.

setRefid

back to summary

public void setRefid(final String refid)

Specify that the handler is a reference on the project; this allows the use of a custom inputhandler.

Parameters

refid:String: the String refid.

setType	back to summary
public void setType(final Input.HandlerType type) Set the handler type. Parameters type:Input.HandlerType a HandlerType.

setType

back to summary

public void setType(final Input.HandlerType type)

Set the handler type.

Parameters

type:Input.HandlerType: a HandlerType.

org.apache.tools.ant.taskdefs back to summary

public Class Input.HandlerType

Class Inheritance

extends EnumeratedAttribute

java.lang.Object
org.apache.tools.ant.types.EnumeratedAttribute
org.apache.tools.ant.taskdefs.Input.HandlerType

EnumeratedAttribute representing the built-in input handler types: "default", "propertyfile", "greedy", "secure" (since Ant 1.8).

Field Summary

Modifier and Type	Field and Description
private static final InputHandler[]	HANDLERS
private static final String[]	VALUES

Inherited from org.apache.tools.ant.types.EnumeratedAttribute:: value

Constructor Summary

Access	Constructor and Description
public	HandlerType()

Method Summary

Modifier and Type	Method and Description
private InputHandler	getInputHandler()
public String[]	getValues() Implements abstract org.apache.tools.ant.types.EnumeratedAttribute.getValues. This is the only method a subclass needs to implement.

Inherited from org.apache.tools.ant.types.EnumeratedAttribute:: containsValue getIndex getInstance getValue indexOfValue setValue toString

Field Detail

HANDLERS	back to summary
private static final InputHandler[] HANDLERS

VALUES	back to summary
private static final String[] VALUES

Constructor Detail

HandlerType	back to summary
public HandlerType()

Method Detail

getInputHandler	back to summary
private InputHandler getInputHandler()

getValues back to summary

getValues	back to summary
public String[] getValues() Implements abstract org.apache.tools.ant.types.EnumeratedAttribute.getValues. Doc from org.apache.tools.ant.types.EnumeratedAttribute.getValues. This is the only method a subclass needs to implement. Returns:String[] an array holding all possible values of the enumeration. The order of elements must be fixed so that `indexOfValue(String)` always return the same index for the same value. Annotations @Override

public String[] getValues()

Implements abstract org.apache.tools.ant.types.EnumeratedAttribute.getValues.

Doc from org.apache.tools.ant.types.EnumeratedAttribute.getValues.

This is the only method a subclass needs to implement.

Returns:String[]

an array holding all possible values of the enumeration. The order of elements must be fixed so that indexOfValue(String) always return the same index for the same value.

Annotations

@Override

public Class Input

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class Input.Handler

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class Input.HandlerType

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail