java.lang.Cloneable
BlockFor
public class WaitFor extends ConditionBase
parallel
task to
synchronize the execution of tests with server startup.
The following attributes can be specified on a waitfor task:
processSuccess
and processTimeout
Modifier and Type | Class | Description |
---|---|---|
static class |
WaitFor.Unit |
The enumeration of units:
millisecond, second, minute, hour, day, week
|
Modifier and Type | Field | Description |
---|---|---|
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
|
description, location, project
Constructor | Description |
---|---|
WaitFor() |
Constructor, names this task "waitfor".
|
WaitFor(java.lang.String taskName) |
Constructor that takes the name of the task in the task name.
|
Modifier and Type | Method | Description |
---|---|---|
long |
calculateCheckEveryMillis() |
Get the check wait time, in milliseconds.
|
long |
calculateMaxWaitMillis() |
Get the maximum 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(java.lang.String p) |
Name the property to set after a timeout.
|
add, addAnd, addAvailable, addChecksum, addContains, addEquals, addFilesMatch, addHttp, addIsFalse, addIsFileSelected, addIsReference, addIsSet, addIsTrue, addNot, addOr, addOs, addSocket, addUptodate, countConditions, getConditions, getTaskName, setTaskName
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
public static final long ONE_MILLISECOND
public static final long ONE_SECOND
public static final long ONE_MINUTE
public static final long ONE_HOUR
public static final long ONE_DAY
public static final long ONE_WEEK
public static final long DEFAULT_MAX_WAIT_MILLIS
public static final long DEFAULT_CHECK_MILLIS
public WaitFor()
public WaitFor(java.lang.String taskName)
taskName
- the name of the task.public void setMaxWait(long time)
time
- a long
valuepublic void setMaxWaitUnit(WaitFor.Unit unit)
unit
- an enumerated Unit
valuepublic void setCheckEvery(long time)
time
- a long
valuepublic void setCheckEveryUnit(WaitFor.Unit unit)
unit
- an enumerated Unit
valuepublic void setTimeoutProperty(java.lang.String p)
p
- the property namepublic void execute() throws BuildException
BuildException
- on errorpublic long calculateCheckEveryMillis()
public long calculateMaxWaitMillis()
protected void processSuccess()
protected void processTimeout()