@@ -1,7 +1,7 @@
/*
* The Apache Software License, Version 1.1
*
* Copyright (c) 2000-2001 The Apache Software Foundation. All rights
* Copyright (c) 2000-2002 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
@@ -59,29 +59,58 @@ import java.util.Vector;
import java.util.StringTokenizer;
/**
* This class implements a target object with required parameters.
* Class to implement a target object with required parameters.
*
* @author James Davidson <a href="mailto:duncan@x180.com">duncan@x180.com</a>
*/
public class Target implements TaskContainer {
/** Name of this target. */
private String name;
/** The "if" condition to test on execution. */
private String ifCondition = "";
/** The "unless" condition to test on execution. */
private String unlessCondition = "";
/** List of targets this target is dependent on. */
private Vector dependencies = new Vector(2);
/** Children of this target (tasks and data types). */
private Vector children = new Vector(5);
/** Project this target belongs to. */
private Project project;
/** Description of this target, if any. */
private String description = null;
/** Sole constructor. */
public Target() {
}
/**
* Sets the project this target belongs to.
*
* @param project The project this target belongs to.
* Must not be <code>null</code>.
*/
public void setProject(Project project) {
this.project = project;
}
/**
* Returns the project this target belongs to.
*
* @return The project this target belongs to, or <code>null</code> if
* the project has not been set yet.
*/
public Project getProject() {
return project;
}
/**
* Sets the list of targets this target is dependent on.
* The targets themselves are not resolved at this time.
*
* @param depS A comma-separated list of targets this target
* depends on. Must not be <code>null</code>.
*/
public void setDepends(String depS) {
if (depS.length() > 0) {
StringTokenizer tok =
@@ -89,7 +118,7 @@ public class Target implements TaskContainer {
while (tok.hasMoreTokens()) {
String token = tok.nextToken().trim();
//Make sure the dependency is not empty string
// Make sure the dependency is not empty string
if (token.equals("") || token.equals(",")) {
throw new BuildException( "Syntax Error: Depend attribute " +
"for target \"" + getName() +
@@ -98,8 +127,8 @@ public class Target implements TaskContainer {
addDependency(token);
//Make sure that depends attribute does not
//end in a ,
// Make sure that depends attribute does not
// end in a ,
if (tok.hasMoreTokens()) {
token = tok.nextToken();
if (!tok.hasMoreTokens() || !token.equals(",")) {
@@ -112,26 +141,48 @@ public class Target implements TaskContainer {
}
}
/**
* Sets the name of this target.
*
* @param name The name of this target. Should not be <code>null</code>.
*/
public void setName(String name) {
this.name = name;
}
/**
* Returns the name of this target.
*
* @return the name of this target, or <code>null</code> if the
* name has not been set yet.
*/
public String getName() {
return name;
}
/**
* Adds a task to this target.
*
* @param task The task to be added. Must not be <code>null</code>.
*/
public void addTask(Task task) {
children.addElement(task);
}
/**
* Adds the wrapper for a data type element to this target.
*
* @param r The wrapper for the data type element to be added.
* Must not be <code>null</code>.
*/
public void addDataType(RuntimeConfigurable r) {
children.addElement(r);
}
/**
* Get the current set of tasks to be executed by this target.
* Returns the current set of tasks to be executed by this target.
*
* @return The current set of tasks.
* @return an array of the tasks currently within this target
*/
public Task[] getTasks() {
Vector tasks = new Vector(children.size());
@@ -148,34 +199,106 @@ public class Target implements TaskContainer {
return retval;
}
/**
* Adds a dependency to this target.
*
* @param dependency The name of a target this target is dependent on.
* Must not be <code>null</code>.
*/
public void addDependency(String dependency) {
dependencies.addElement(dependency);
}
/**
* Returns an enumeration of the dependencies of this target.
*
* @return an enumeration of the dependencies of this target
*/
public Enumeration getDependencies() {
return dependencies.elements();
}
/**
* Sets 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
* property <code>foo</code> has value <code>bar</code>, setting
* the "if" condition to <code>${foo}_x</code> will mean that the
* task will only execute if property <code>bar_x</code> is set.
*
* @param property The property condition to test on execution.
* May be <code>null</code>, in which case
* no "if" test is performed.
*/
public void setIf(String property) {
this.ifCondition = (property == null) ? "" : property;
}
/**
* Sets 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
* property <code>foo</code> has value <code>bar</code>, setting
* the "unless" condition to <code>${foo}_x</code> will mean that the
* task will only execute if property <code>bar_x</code> isn't set.
*
* @param property The property condition to test on execution.
* May be <code>null</code>, in which case
* no "unless" test is performed.
*/
public void setUnless(String property) {
this.unlessCondition = (property == null) ? "" : property;
}
/**
* Sets the description of this target.
*
* @param description The description for this target.
* May be <code>null</code>, indicating that no
* description is available.
*/
public void setDescription(String description) {
this.description = description;
}
/**
* Returns the description of this target.
*
* @return the description of this target, or <code>null</code> if no
* description is available.
*/
public String getDescription() {
return description;
}
/**
* Returns the name of this target.
*
* @return the name of this target, or <code>null</code> if the
* name has not been set yet.
*/
public String toString() {
return name;
}
/**
* Executes 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.
*
* @exception BuildException if any of the tasks fail or if a data type
* configuration fails.
*
* @see #performTasks()
* @see #setIf(String)
* @see #setUnless(String)
*/
public void execute() throws BuildException {
if (testIfCondition() && testUnlessCondition()) {
Enumeration enum = children.elements();
@@ -198,6 +321,13 @@ public class Target implements TaskContainer {
}
}
/**
* Performs the tasks within this target (if the conditions are met),
* firing target started/target finished messages around a call to
* execute.
*
* @see #execute()
*/
public final void performTasks() {
try {
project.fireTargetStarted(this);
@@ -210,13 +340,45 @@ public class Target implements TaskContainer {
}
}
void replaceChild(Task el, Object o) {
int index = -1;
/**
* Replaces all occurrences of the given task in the list
* of children with the replacement data type wrapper.
*
* @param el The task to replace.
* Must not be <code>null</code>.
* @param o The data type wrapper to replace <code>el</code> with.
*/
void replaceChild(Task el, RuntimeConfigurable o) {
int index;
while ((index = children.indexOf(el)) >= 0) {
children.setElementAt(o, index);
}
}
/**
* Replaces all occurrences of the given task in the list
* of children with the replacement task.
*
* @param el The task to replace.
* Must not be <code>null</code>.
* @param o The task to replace <code>el</code> with.
*/
void replaceChild(Task el, Task o) {
int index;
while ((index = children.indexOf(el)) >= 0) {
children.setElementAt(o, index);
}
}
/**
* Tests whether or not the "if" condition is satisfied.
*
* @return whether or not the "if" condition is satisfied. If no
* condition (or an empty condition) has been set,
* <code>true</code> is returned.
*
* @see #setIf(String)
*/
private boolean testIfCondition() {
if ("".equals(ifCondition)) {
return true;
@@ -226,6 +388,15 @@ public class Target implements TaskContainer {
return project.getProperty(test) != null;
}
/**
* Tests whether or not the "unless" condition is satisfied.
*
* @return whether or not the "unless" condition is satisfied. If no
* condition (or an empty condition) has been set,
* <code>true</code> is returned.
*
* @see #setUnless(String)
*/
private boolean testUnlessCondition() {
if ("".equals(unlessCondition)) {
return true;
@@ -233,5 +404,4 @@ public class Target implements TaskContainer {
String test = project.replaceProperties(unlessCondition);
return project.getProperty(test) == null;
}
}
Jon Skeet