Package org.apache.tools.ant.taskdefs
Class WaitFor
java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.taskdefs.condition.ConditionBase
org.apache.tools.ant.taskdefs.WaitFor
- All Implemented Interfaces:
- Cloneable
- Direct Known Subclasses:
- BlockFor
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.
processSuccess and processTimeout- Since:
- Ant 1.5
- 
Nested Class SummaryNested ClassesModifier and TypeClassDescriptionstatic classThe enumeration of units: millisecond, second, minute, hour, day, week
- 
Field SummaryFieldsModifier and TypeFieldDescriptionstatic final longdefault check timestatic final longdefault wait timestatic final longa day in millisecondsstatic final longan hour in millisecondsstatic final longa millisecondstatic final longa minute in millisecondsstatic final longa second in millisecondsstatic final longa week in millisecondsFields inherited from class org.apache.tools.ant.ProjectComponentdescription, location, project
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionlongGet the check wait time, in milliseconds.longGet the maximum wait time, in milliseconds.voidexecute()Check repeatedly for the specified conditions until they become true or the timeout expires.protected voidActions to be taken on a successful waitfor.protected voidActions to be taken on an unsuccessful wait.voidsetCheckEvery(long time) Set the time between each checkvoidSet the check every time unitvoidsetMaxWait(long time) Set the maximum length of time to wait.voidsetMaxWaitUnit(WaitFor.Unit unit) Set the max wait time unitvoidName the property to set after a timeout.Methods inherited from class org.apache.tools.ant.taskdefs.condition.ConditionBaseadd, addAnd, addAvailable, addChecksum, addContains, addEquals, addFilesMatch, addHttp, addIsFalse, addIsFileSelected, addIsReference, addIsSet, addIsTrue, addNot, addOr, addOs, addSocket, addUptodate, countConditions, getConditions, getTaskName, setTaskNameMethods inherited from class org.apache.tools.ant.ProjectComponentclone, getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
- 
Field Details- 
ONE_MILLISECONDpublic static final long ONE_MILLISECONDa millisecond- See Also:
 
- 
ONE_SECONDpublic static final long ONE_SECONDa second in milliseconds- See Also:
 
- 
ONE_MINUTEpublic static final long ONE_MINUTEa minute in milliseconds- See Also:
 
- 
ONE_HOURpublic static final long ONE_HOURan hour in milliseconds- See Also:
 
- 
ONE_DAYpublic static final long ONE_DAYa day in milliseconds- See Also:
 
- 
ONE_WEEKpublic static final long ONE_WEEKa week in milliseconds- See Also:
 
- 
DEFAULT_MAX_WAIT_MILLISpublic static final long DEFAULT_MAX_WAIT_MILLISdefault wait time- See Also:
 
- 
DEFAULT_CHECK_MILLISpublic static final long DEFAULT_CHECK_MILLISdefault check time- See Also:
 
 
- 
- 
Constructor Details- 
WaitForpublic WaitFor()Constructor, names this task "waitfor".
- 
WaitForConstructor that takes the name of the task in the task name.- Parameters:
- taskName- the name of the task.
- Since:
- Ant 1.8
 
 
- 
- 
Method Details- 
setMaxWaitpublic void setMaxWait(long time) Set the maximum length of time to wait.- Parameters:
- time- a- longvalue
 
- 
setMaxWaitUnitSet the max wait time unit- Parameters:
- unit- an enumerated- Unitvalue
 
- 
setCheckEverypublic void setCheckEvery(long time) Set the time between each check- Parameters:
- time- a- longvalue
 
- 
setCheckEveryUnitSet the check every time unit- Parameters:
- unit- an enumerated- Unitvalue
 
- 
setTimeoutPropertyName the property to set after a timeout.- Parameters:
- p- the property name
 
- 
executeCheck repeatedly for the specified conditions until they become true or the timeout expires.- Throws:
- BuildException- on error
 
- 
calculateCheckEveryMillispublic long calculateCheckEveryMillis()Get the check wait time, in milliseconds.- Returns:
- how long to wait between checks
- Since:
- Ant 1.8
 
- 
calculateMaxWaitMillispublic long calculateMaxWaitMillis()Get the maximum wait time, in milliseconds.- Returns:
- how long to wait before timing out
- Since:
- Ant 1.8
 
- 
processSuccessprotected void processSuccess()Actions to be taken on a successful waitfor. This is an override point. The base implementation does nothing.- Since:
- Ant1.7
 
- 
processTimeoutprotected 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
 
 
-