org.apache.tools.ant.taskdefs

Class WaitFor

public class WaitFor extends ConditionBase

Wait for an external event to occur. Wait for an external process to start or to complete some task. This is useful with the parallel task to synchronize the execution of tests with server startup. The following attributes can be specified on a waitfor task:

maxwait - maximum length of time to wait before giving up
maxwaitunit - The unit to be used to interpret maxwait attribute
checkevery - amount of time to sleep between each check
checkeveryunit - The unit to be used to interpret checkevery attribute
timeoutproperty - name of a property to set if maxwait has been exceeded.

The maxwaitunit and checkeveryunit are allowed to have the following values: millisecond, second, minute, hour, day and week. The default is millisecond. For programmatic use/subclassing, there are two methods that may be overrridden, processSuccess and processTimeout

Since: Ant 1.5

UNKNOWN: category="control"

Nested Class Summary
static class	WaitFor.Unit The enumeration of units: millisecond, second, minute, hour, day, week

Constructor Summary
	WaitFor() Constructor, names this task "waitfor".

Method Summary
void	execute() Check repeatedly for the specified conditions until they become true or the timeout expires.
protected void	processSuccess() Actions to be taken on a successful waitfor.
protected void	processTimeout() Actions to be taken on an unsuccessful wait.
void	setCheckEvery(long time) Set the time between each check
void	setCheckEveryUnit(WaitFor.Unit unit) Set the check every time unit
void	setMaxWait(long time) Set the maximum length of time to wait.
void	setMaxWaitUnit(WaitFor.Unit unit) Set the max wait time unit
void	setTimeoutProperty(String p) Name the property to set after a timeout.

Constructor Detail

WaitFor

public WaitFor()

Constructor, names this task "waitfor".

Method Detail

execute

public void execute()

Check repeatedly for the specified conditions until they become true or the timeout expires.

Throws: BuildException on error

processSuccess

protected void processSuccess()

Actions to be taken on a successful waitfor. This is an override point. The base implementation does nothing.

Since: Ant1.7

processTimeout

protected void processTimeout()

Actions to be taken on an unsuccessful wait. This is an override point. It is where the timeout processing takes place. The base implementation sets the timeoutproperty if there was a timeout and the property was defined.

Since: Ant1.7