Deprecated task that uses console to prompt user for property values.
This class is very slightly simpler than the InputTask, but lacks the ability
to use a non-console input handler. You should, therefore, use InputTask. This
class can serve as a reference, but will be removed in the future.
Methods
Sets the prompt text that will be presented to the user.
addText(string $prompt) : void
Parameters
$prompt
string
Returns defaultValue specified
in this task for the Property
being set.
getDefaultValue() : string
Returns the textual description of the task
getDescription() : string
Inherited
inherited_from |
\Task::getDescription() |
Returns
string
The text description of the task
Returns the location within the buildfile this task occurs.
getLocation() : \Location
Inherited
inherited_from |
\Task::getLocation() |
Returns
\Location
The location object describing the position of this
task within the buildfile.
Returns the owning target of this task.
getOwningTarget() : \Target
Inherited
inherited_from |
\Task::getOwningTarget() |
Returns
\Target
The target object that owns this task
Returns a reference to current project
getProject() : \Project
Inherited
inherited_from |
\ProjectComponent::getProject() |
inherited_from |
\Task::getProject() |
Returns
\Project
Reference to current porject object
Returns the terminating character used to
punctuate the prompt text.
getPromptCharacter() : string
Returns text of the prompt.
getPromptText() : \java.lang.String
Returns
\java.lang.String
Returns name of the Ant Project Property
being set by this task.
getPropertyName() : string
Returns the wrapper object for runtime configuration
getRuntimeConfigurableWrapper() : \RuntimeConfigurable
Inherited
inherited_from |
\Task::getRuntimeConfigurableWrapper() |
Returns
Returns the name of task, used only for log messages
getTaskName() : string
Inherited
inherited_from |
\Task::getTaskName() |
Returns
string
Name of this task
Returns the name of the task under which it was invoked,
usually the XML tagname
getTaskType() : string
Inherited
inherited_from |
\Task::getTaskType() |
Returns
string
The type of this task (XML Tag)
Initializes this task.
init()
Should throw a BuildException if something goes wrong with the build
This is abstract here, but may not be overloaded by subclasses.
Exceptions
Insert the method's description here.
isUseExistingValue() : boolean
Creation date: (12/10/2001 8:16:16 AM)
Returns
boolean
Provides a project level log event to the task.
log(string $msg, integer $level)
Inherited
Parameters
$msg
string
The message to log
$level
integer
The priority of the message
Run the PropertyPrompt task.
main()
This method may be
called more than once, if the task is invoked more than once. For
example, if target1 and target2 both depend on target3, then running
phing target1 target2 will run all tasks in target3 twice.
Should throw a BuildException if someting goes wrong with the build
This is abstract here. Must be overloaded by real tasks.
Exceptions
Sets defaultValue for the Property
being set by this task.
setDefaultvalue(string $newDefaultvalue)
Parameters
$newDefaultvalue
string
Sets a textual description of the task
setDescription(string $desc)
Inherited
inherited_from |
\Task::setDescription() |
Parameters
$desc
string
The text describing the task
Sets the location within the buildfile this task occurs.
setLocation(\Location $location)
Inherited
Called by
the parser to set location information.
inherited_from |
\Task::setLocation() |
Parameters
$location
\Location
The location object describing the position of this task within the buildfile.
Sets the owning target this task belongs to.
setOwningTarget(\Target $target)
Inherited
inherited_from |
\Task::setOwningTarget() |
Parameters
$target
\Target
Reference to owning target
References the project to the current component.
setProject(\Project $project)
Inherited
inherited_from |
\ProjectComponent::setProject() |
inherited_from |
\Task::setProject() |
Parameters
$project
\Project
The reference to the current project
Sets the terminating character used to
punctuate the prompt text (default is "?").
setPromptCharacter(string $newPromptcharacter)
Parameters
$newPromptcharacter
string
Sets text of the prompt.
setPromptText(string $newPrompttext)
Parameters
$newPrompttext
string
Specifies the Phing Project Property
being set by this task.
setPropertyName(\newPropertyname $newPropertyname)
Parameters
$newPropertyname
\newPropertyname
java.lang.String
Sets the wrapper object this task should use for runtime
configurable elements.
setRuntimeConfigurableWrapper(\RuntimeConfigurable $wrapper)
Inherited
inherited_from |
\Task::setRuntimeConfigurableWrapper() |
Parameters
Sets the name of this task for log messages
setTaskName(string $name) : string
Inherited
inherited_from |
\Task::setTaskName() |
Parameters
$name
string
Returns
string
A string representing the name of this task for log
Sets the type of the task.
setTaskType(string $name)
Inherited
Usually this is the name of the XML tag
inherited_from |
\Task::setTaskType() |
Parameters
$name
string
The type of this task (XML Tag)
setUseExistingValue()
setUseExistingValue(boolean $newUseExistingValue)
Parameters
$newUseExistingValue
boolean
Returns a name
getRegisterSlot(string $slotName)
Inherited
inherited_from |
\Task::getRegisterSlot() |
Parameters
$slotName
string
Returns a string to be inserted in the log message
indicating whether a default response was specified
in the build file.
getDefaultMessage()
Properties
$description : string
Inherited
inherited_from |
\Task::$$description |
$location : \Location
Inherited
inherited_from |
\Task::$$location |
$project : \Project
Inherited
inherited_from |
\ProjectComponent::$$project |
inherited_from |
\Task::$$project |
$target : \Target
Inherited
inherited_from |
\Task::$$target |
$taskName : string
Inherited
inherited_from |
\Task::$$taskName |
$taskType : string
Inherited
inherited_from |
\Task::$$taskType |
$promptCharacter : string