WaitFor (Apache Ant API)

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

Field Summary
static long	DEFAULT_CHECK_MILLIS default check time
static long	DEFAULT_MAX_WAIT_MILLIS default wait time
static long	ONE_DAY a day in milliseconds
static long	ONE_HOUR an hour in milliseconds
static long	ONE_MILLISECOND a millisecond
static long	ONE_MINUTE a minute in milliseconds
static long	ONE_SECOND a second in milliseconds
static long	ONE_WEEK a week in milliseconds

Constructor Summary
	WaitFor() Constructor, names this task "waitfor".
	WaitFor(String taskName) Constructor that takes the name of the task in the task name.

Method Summary
long	calculateCheckEveryMillis() Get the check wait time, in milliseconds.
long	calculateMaxWaitMillis() Get the maxiumum wait time, in milliseconds.
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.

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

Class WaitFor

Field Detail

DEFAULT_CHECK_MILLIS

DEFAULT_MAX_WAIT_MILLIS

ONE_DAY

ONE_HOUR

ONE_MILLISECOND

ONE_MINUTE

ONE_SECOND

ONE_WEEK

Constructor Detail

WaitFor

WaitFor

Method Detail

calculateCheckEveryMillis

calculateMaxWaitMillis

execute

processSuccess

processTimeout

setCheckEvery

setCheckEveryUnit

setMaxWait

setMaxWaitUnit

setTimeoutProperty