tasks/system/PropertyPromptTask.php
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.
- Author
- Hans Lellelid
(Phing) - Author
- Anthony J. Young-Garner
(Ant) - Deprecated
- - in favor of the more capable InputTask
- Package
- phing.tasks.system
- Version
- $Id$
\PropertyPromptTask
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.
- Parent(s)
- \Task < \ProjectComponent
- Author
- Hans Lellelid
(Phing) - Author
- Anthony J. Young-Garner
(Ant) - Copyright
- 2001,2002 THYRELL. All rights reserved
- Deprecated
- - in favor of the more capable InputTask
- Version
- $Id$
Properties


\Project
$project= 'null'
Holds a reference to the project that a project component (a task, a target, etc.) belongs to
A reference to the current project instanceInherited from: \ProjectComponent::$$project\Task::$$projectnull
Details- Type
- \Project
- Inherited_from
- \ProjectComponent::$$project
- Inherited_from
- \Task::$$project
Methods


addText(
string $prompt
)
:
void
Sets the prompt text that will be presented to the user.
Name | Type | Description |
---|---|---|
$prompt | string |


getDefaultMessage(
)
:
void
Returns a string to be inserted in the log message indicating whether a default response was specified in the build file.


getDefaultValue(
)
:
string
Returns defaultValue specified in this task for the Property being set.
Type | Description |
---|---|
string |


getLocation(
)
:
\Location
Returns the location within the buildfile this task occurs. Used by {@link BuildException} to give detailed error messages.
Inherited from: \Task::getLocation()Type | Description |
---|---|
\Location | The location object describing the position of this task within the buildfile. |


getProject(
)
:
\Project
Returns a reference to current project
Inherited from: \ProjectComponent::getProject()\Task::getProject()Type | Description |
---|---|
\Project | Reference to current porject object |


getPromptCharacter(
)
:
string
Returns the terminating character used to punctuate the prompt text.
Type | Description |
---|---|
string |


getPromptText(
)
:
\java.lang.String
Returns text of the prompt.
Type | Description |
---|---|
\java.lang.String |


getPropertyName(
)
:
string
Returns name of the Ant Project Property being set by this task.
Type | Description |
---|---|
string |


getRuntimeConfigurableWrapper(
)
:
\RuntimeConfigurable
Returns the wrapper object for runtime configuration
Inherited from: \Task::getRuntimeConfigurableWrapper()Type | Description |
---|---|
\RuntimeConfigurable | The wrapper object used by this task |


getTaskType(
)
:
string
Returns the name of the task under which it was invoked, usually the XML tagname
Inherited from: \Task::getTaskType()Type | Description |
---|---|
string | The type of this task (XML Tag) |


init(
)
:
void
Initializes this task.
Should throw a BuildException if something goes wrong with the build
This is abstract here, but may not be overloaded by subclasses.
Exception | Description |
---|---|
\BuildException |


isUseExistingValue(
)
:
boolean
Insert the method's description here.
Creation date: (12/10/2001 8:16:16 AM)
Type | Description |
---|---|
boolean |


log(
string $msg, integer $level
=
Project::MSG_INFO
)
:
void
Name | Type | Description |
---|---|---|
$msg | string | The message to log |
$level | integer | The priority of the message |
- See
- \BuildEvent
- See
- \BuildListener


main(
)
:
void
Run the PropertyPrompt task.
Should throw a BuildException if someting goes wrong with the build
This is abstract here. Must be overloaded by real tasks.
Exception | Description |
---|---|
\BuildException |


maybeConfigure(
)
:
void
Configure this task if it hasn't been done already.
Inherited from: \Task::maybeConfigure()

setDefaultvalue(
string $newDefaultvalue
)
:
void
Sets defaultValue for the Property being set by this task.
Name | Type | Description |
---|---|---|
$newDefaultvalue | string |


setDescription(
string $desc
)
:
void
Name | Type | Description |
---|---|---|
$desc | string | The text describing the task |


setLocation(
\Location $location
)
:
void
Sets the location within the buildfile this task occurs. Called by the parser to set location information.
Inherited from: \Task::setLocation()Name | Type | Description |
---|---|---|
$location | \Location | The location object describing the position of this task within the buildfile. |


setOwningTarget(
\Target $target
)
:
void
Name | Type | Description |
---|---|---|
$target | \Target | Reference to owning target |


setProject(
\Project $project
)
:
void
References the project to the current component.
Inherited from: \ProjectComponent::setProject()\Task::setProject()Name | Type | Description |
---|---|---|
$project | \Project | The reference to the current project |


setPromptCharacter(
string $newPromptcharacter
)
:
void
Sets the terminating character used to punctuate the prompt text (default is "?").
Name | Type | Description |
---|---|---|
$newPromptcharacter | string |


setPromptText(
string $newPrompttext
)
:
void
Sets text of the prompt.
Name | Type | Description |
---|---|---|
$newPrompttext | string |


setPropertyName(
\newPropertyname $newPropertyname
)
:
void
Specifies the Phing Project Property being set by this task.
Name | Type | Description |
---|---|---|
$newPropertyname | \newPropertyname | java.lang.String |


setRuntimeConfigurableWrapper(
\RuntimeConfigurable $wrapper
)
:
void
Sets the wrapper object this task should use for runtime configurable elements.
Inherited from: \Task::setRuntimeConfigurableWrapper()Name | Type | Description |
---|---|---|
$wrapper | \RuntimeConfigurable | The wrapper object this task should use |


setTaskName(
string $name
)
:
string
Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
string | A string representing the name of this task for log |


setTaskType(
string $name
)
:
void
Sets the type of the task. Usually this is the name of the XML tag
Inherited from: \Task::setTaskType()Name | Type | Description |
---|---|---|
$name | string | The type of this task (XML Tag) |