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 overridden, processSuccess and processTimeout

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	WaitFor.Unit The enumeration of units: millisecond, second, minute, hour, day, week

Field Summary

Modifier and Type	Field and Description
private long	checkEvery check time in the current unit
private long	checkEveryMultiplier
public static final long	DEFAULT_CHECK_MILLIS default check time
public static final long	DEFAULT_MAX_WAIT_MILLIS default wait time
private long	maxWait default max wait time in the current unit
private long	maxWaitMultiplier
public static final long	ONE_DAY a day in milliseconds
public static final long	ONE_HOUR an hour in milliseconds
public static final long	ONE_MILLISECOND a millisecond
public static final long	ONE_MINUTE a minute in milliseconds
public static final long	ONE_SECOND a second in milliseconds
public static final long	ONE_WEEK a week in milliseconds
private String	timeoutProperty

Constructor Summary

Access	Constructor and Description
public	WaitFor() Constructor, names this task "waitfor".
public	WaitFor(String the name of the task. taskName) Constructor that takes the name of the task in the task name.

Method Summary

Modifier and Type	Method and Description
public long	Returns: how long to wait between checks calculateCheckEveryMillis() Get the check wait time, in milliseconds.
public long	Returns: how long to wait before timing out calculateMaxWaitMillis() Get the maximum wait time, in milliseconds.
public 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.
public void	setCheckEvery(long a `long` value time) Set the time between each check
public void	setCheckEveryUnit(WaitFor.Unit an enumerated `Unit` value unit) Set the check every time unit
public void	setMaxWait(long a `long` value time) Set the maximum length of time to wait.
public void	setMaxWaitUnit(WaitFor.Unit an enumerated `Unit` value unit) Set the max wait time unit
public void	setTimeoutProperty(String the property name p) Name the property to set after a timeout.

Field Detail

checkEvery	back to summary
private long checkEvery check time in the current unit

checkEveryMultiplier	back to summary
private long checkEveryMultiplier

DEFAULT_CHECK_MILLIS	back to summary
public static final long DEFAULT_CHECK_MILLIS default check time

DEFAULT_MAX_WAIT_MILLIS	back to summary
public static final long DEFAULT_MAX_WAIT_MILLIS default wait time

maxWait	back to summary
private long maxWait default max wait time in the current unit

maxWaitMultiplier	back to summary
private long maxWaitMultiplier

ONE_DAY	back to summary
public static final long ONE_DAY a day in milliseconds

ONE_HOUR	back to summary
public static final long ONE_HOUR an hour in milliseconds

ONE_MILLISECOND	back to summary
public static final long ONE_MILLISECOND a millisecond

ONE_MINUTE	back to summary
public static final long ONE_MINUTE a minute in milliseconds

ONE_SECOND	back to summary
public static final long ONE_SECOND a second in milliseconds

ONE_WEEK	back to summary
public static final long ONE_WEEK a week in milliseconds

timeoutProperty	back to summary
private String timeoutProperty

Constructor Detail

WaitFor	back to summary
public WaitFor() Constructor, names this task "waitfor".

WaitFor	back to summary
public WaitFor(String taskName) Constructor that takes the name of the task in the task name. Parameters taskName:String the name of the task. Since Ant 1.8

WaitFor

back to summary

public WaitFor(String taskName)

Constructor that takes the name of the task in the task name.

Parameters

taskName:String: the name of the task.

Since

Ant 1.8

Method Detail

calculateCheckEveryMillis	back to summary
public long calculateCheckEveryMillis() Get the check wait time, in milliseconds. Returns:long how long to wait between checks Since Ant 1.8

calculateCheckEveryMillis

back to summary

public long calculateCheckEveryMillis()

Get the check wait time, in milliseconds.

Returns:long: how long to wait between checks
Since: Ant 1.8

calculateMaxWaitMillis	back to summary
public long calculateMaxWaitMillis() Get the maximum wait time, in milliseconds. Returns:long how long to wait before timing out Since Ant 1.8

calculateMaxWaitMillis

back to summary

public long calculateMaxWaitMillis()

Get the maximum wait time, in milliseconds.

Returns:long: how long to wait before timing out
Since: Ant 1.8

execute	back to summary
public void execute() throws BuildException Check repeatedly for the specified conditions until they become true or the timeout expires. Exceptions BuildException: on error

execute

back to summary

public void execute() throws BuildException

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

Exceptions

BuildException:: on error

processSuccess	back to summary
protected void processSuccess() Actions to be taken on a successful waitfor. This is an override point. The base implementation does nothing. Since Ant1.7

processSuccess

back to summary

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	back to summary
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

processTimeout

back to summary

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

setCheckEvery back to summary

setCheckEvery	back to summary
public void setCheckEvery(long time) Set the time between each check Parameters time:long a `long` value

public void setCheckEvery(long time)

Set the time between each check

Parameters

time:long: a long value

setCheckEveryUnit back to summary

setCheckEveryUnit	back to summary
public void setCheckEveryUnit(WaitFor.Unit unit) Set the check every time unit Parameters unit:WaitFor.Unit an enumerated `Unit` value

public void setCheckEveryUnit(WaitFor.Unit unit)

Set the check every time unit

Parameters

unit:WaitFor.Unit: an enumerated Unit value

setMaxWait back to summary

setMaxWait	back to summary
public void setMaxWait(long time) Set the maximum length of time to wait. Parameters time:long a `long` value

public void setMaxWait(long time)

Set the maximum length of time to wait.

Parameters

time:long: a long value

setMaxWaitUnit back to summary

setMaxWaitUnit	back to summary
public void setMaxWaitUnit(WaitFor.Unit unit) Set the max wait time unit Parameters unit:WaitFor.Unit an enumerated `Unit` value

public void setMaxWaitUnit(WaitFor.Unit unit)

Set the max wait time unit

Parameters

unit:WaitFor.Unit: an enumerated Unit value

setTimeoutProperty	back to summary
public void setTimeoutProperty(String p) Name the property to set after a timeout. Parameters p:String the property name

setTimeoutProperty

back to summary

public void setTimeoutProperty(String p)

Name the property to set after a timeout.

Parameters

p:String: the property name

org.apache.tools.ant.taskdefs back to summary

public Class WaitFor.Unit

Class Inheritance

extends EnumeratedAttribute

java.lang.Object
org.apache.tools.ant.types.EnumeratedAttribute
org.apache.tools.ant.taskdefs.WaitFor.Unit

The enumeration of units: millisecond, second, minute, hour, day, week

Field Summary

Modifier and Type	Field and Description
public static final String	DAY day string
public static final String	HOUR hour string
public static final String	MILLISECOND millisecond string
public static final String	MINUTE minute string
public static final String	SECOND second string
private Map<String, Long>	timeTable
private static final String[]	UNITS
public static final String	WEEK week string

Inherited from org.apache.tools.ant.types.EnumeratedAttribute:: value

Constructor Summary

Access	Constructor and Description
public	Unit() Constructor the Unit enumerated type.

Method Summary

Modifier and Type	Method and Description
public long	Returns: a multiplier (a long value) getMultiplier() Convert the value to a multiplier (millisecond to unit).
public String[]	getValues() Implements abstract org.apache.tools.ant.types.EnumeratedAttribute.getValues. This is the only method a subclass needs to implement.

Inherited from org.apache.tools.ant.types.EnumeratedAttribute:: containsValue getIndex getInstance getValue indexOfValue setValue toString

Field Detail

DAY	back to summary
public static final String DAY day string

HOUR	back to summary
public static final String HOUR hour string

MILLISECOND	back to summary
public static final String MILLISECOND millisecond string

MINUTE	back to summary
public static final String MINUTE minute string

SECOND	back to summary
public static final String SECOND second string

timeTable	back to summary
private Map<String, Long> timeTable

UNITS	back to summary
private static final String[] UNITS

WEEK	back to summary
public static final String WEEK week string

Constructor Detail

Unit	back to summary
public Unit() Constructor the Unit enumerated type.

Method Detail

getMultiplier	back to summary
public long getMultiplier() Convert the value to a multiplier (millisecond to unit). Returns:long a multiplier (a long value)

getMultiplier

back to summary

public long getMultiplier()

Convert the value to a multiplier (millisecond to unit).

Returns:long: a multiplier (a long value)

getValues back to summary

getValues	back to summary
public String[] getValues() Implements abstract org.apache.tools.ant.types.EnumeratedAttribute.getValues. Doc from org.apache.tools.ant.types.EnumeratedAttribute.getValues. This is the only method a subclass needs to implement. Returns:String[] an array holding all possible values of the enumeration. The order of elements must be fixed so that `indexOfValue(String)` always return the same index for the same value. Annotations @Override See Also `EnumeratedAttribute#getValues()`

public String[] getValues()

Implements abstract org.apache.tools.ant.types.EnumeratedAttribute.getValues.

Doc from org.apache.tools.ant.types.EnumeratedAttribute.getValues.

This is the only method a subclass needs to implement.

Returns:String[]

an array holding all possible values of the enumeration. The order of elements must be fixed so that indexOfValue(String) always return the same index for the same value.

Annotations

@Override

See Also

EnumeratedAttribute#getValues()