Package org.apache.tools.ant
Class Target
java.lang.Object
org.apache.tools.ant.Target
- All Implemented Interfaces:
- TaskContainer
- Direct Known Subclasses:
- ExtensionPoint
Class to implement a target object with required parameters.
 
If you are creating Targets programmatically, make sure you set the Location to a useful value. In particular all targets should have different location values.
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionvoidAdds the wrapper for a data type element to this target.voidaddDependency(String dependency) Adds a dependency to this target.voidAdds a task to this target.booleanDoes this target depend on the named target?voidexecute()Executes the target if the "if" and "unless" conditions are satisfied.Returns an enumeration of the dependencies of this target.Returns the description of this target.getIf()Returns the "if" property condition of this target.Get the location of this target's definition.getName()Returns the name of this target.Returns the project this target belongs to.Task[]getTasks()Returns the current set of tasks to be executed by this target.Returns the "unless" property condition of this target.parseDepends(String depends, String targetName, String attributeName) final voidPerforms the tasks within this target (if the conditions are met), firing target started/target finished messages around a call to execute.voidsetDepends(String depS) Sets the list of targets this target is dependent on.voidsetDescription(String description) Sets the description of this target.voidSets the "if" condition to test on execution.voidSame assetIf(String)but requires aConditioninstancevoidsetLocation(Location location) Sets the location of this target's definition.voidSets the name of this target.voidsetProject(Project project) Sets the project this target belongs to.voidSets the "unless" condition to test on execution.voidSame assetUnless(String)but requires aConditioninstancetoString()Returns the name of this target.
- 
Constructor Details- 
Targetpublic Target()Default constructor.
- 
TargetCloning constructor.- Parameters:
- other- the Target to clone.
 
 
- 
- 
Method Details- 
setProjectSets the project this target belongs to.- Parameters:
- project- The project this target belongs to. Must not be- null.
 
- 
getProjectReturns the project this target belongs to.- Returns:
- The project this target belongs to, or nullif the project has not been set yet.
 
- 
setLocationSets the location of this target's definition.- Parameters:
- location-- Location
- Since:
- 1.6.2
 
- 
getLocationGet the location of this target's definition.- Returns:
- Location
- Since:
- 1.6.2
 
- 
setDependsSets the list of targets this target is dependent on. The targets themselves are not resolved at this time.- Parameters:
- depS- A comma-separated list of targets this target depends on. Must not be- null.
 
- 
parseDepends
- 
setNameSets the name of this target.- Parameters:
- name- The name of this target. Should not be- null.
 
- 
getNameReturns the name of this target.- Returns:
- the name of this target, or nullif the name has not been set yet.
 
- 
addTaskAdds a task to this target.- Specified by:
- addTaskin interface- TaskContainer
- Parameters:
- task- The task to be added. Must not be- null.
 
- 
addDataTypeAdds the wrapper for a data type element to this target.- Parameters:
- r- The wrapper for the data type element to be added. Must not be- null.
 
- 
getTasksReturns the current set of tasks to be executed by this target.- Returns:
- an array of the tasks currently within this target
 
- 
addDependencyAdds a dependency to this target.- Parameters:
- dependency- The name of a target this target is dependent on. Must not be- null.
 
- 
getDependenciesReturns an enumeration of the dependencies of this target.- Returns:
- an enumeration of the dependencies of this target (enumeration of String)
 
- 
dependsOnDoes this target depend on the named target?- Parameters:
- other- the other named target.
- Returns:
- true if the target does depend on the named target
- Since:
- Ant 1.6
 
- 
setIfSets the "if" condition to test on execution. This is the name of a property to test for existence - if the property is not set, the task will not execute. The property goes through property substitution once before testing, so if propertyfoohas valuebar, setting the "if" condition to${foo}_xwill mean that the task will only execute if propertybar_xis set.- Parameters:
- property- The property condition to test on execution. May be- null, in which case no "if" test is performed.
 
- 
getIfReturns the "if" property condition of this target.- Returns:
- the "if" property condition or nullif no "if" condition had been defined.
- Since:
- 1.6.2
 
- 
setIfSame assetIf(String)but requires aConditioninstance- Parameters:
- condition- Condition
- Since:
- 1.9
 
- 
setUnlessSets the "unless" condition to test on execution. This is the name of a property to test for existence - if the property is set, the task will not execute. The property goes through property substitution once before testing, so if propertyfoohas valuebar, setting the "unless" condition to${foo}_xwill mean that the task will only execute if propertybar_xisn't set.- Parameters:
- property- The property condition to test on execution. May be- null, in which case no "unless" test is performed.
 
- 
getUnlessReturns the "unless" property condition of this target.- Returns:
- the "unless" property condition or nullif no "unless" condition had been defined.
- Since:
- 1.6.2
 
- 
setUnlessSame assetUnless(String)but requires aConditioninstance- Parameters:
- condition- Condition
- Since:
- 1.9
 
- 
setDescriptionSets the description of this target.- Parameters:
- description- The description for this target. May be- null, indicating that no description is available.
 
- 
getDescriptionReturns the description of this target.- Returns:
- the description of this target, or nullif no description is available.
 
- 
toStringReturns the name of this target.
- 
executeExecutes the target if the "if" and "unless" conditions are satisfied. Dependency checking should be done before calling this method, as it does no checking of its own. If either the "if" or "unless" test prevents this target from being executed, a verbose message is logged giving the reason. It is recommended that clients of this class call performTasks rather than this method so that appropriate build events are fired.- Throws:
- BuildException- if any of the tasks fail or if a data type configuration fails.
- See Also:
 
- 
performTaskspublic final void performTasks()Performs the tasks within this target (if the conditions are met), firing target started/target finished messages around a call to execute.- See Also:
 
 
-