org.apache.tools.ant.taskdefs

Class Sleep

public class Sleep extends Task

Sleep, or pause, for a period of time. A task for sleeping a short period of time, useful when a build or deployment process requires an interval between tasks.

A negative value can be supplied to any of attributes provided the total sleep time is positive, pending fundamental changes in physics and JVM execution times

Note that sleep times are always hints to be interpreted by the OS how it feels small times may either be ignored or rounded up to a minimum timeslice. Note also that the system clocks often have a fairly low granularity too, which complicates measuring how long a sleep actually took.

Since: Ant 1.4

UNKNOWN: category="utility"

Constructor Summary
Sleep()
Creates new instance
Method Summary
voiddoSleep(long millis)
sleep for a period of time
voidexecute()
Executes this build task.
voidsetFailOnError(boolean failOnError)
flag controlling whether to break the build on an error.
voidsetHours(int hours)
hours to add to the sleep time.
voidsetMilliseconds(int milliseconds)
milliseconds to add to the sleep time
voidsetMinutes(int minutes)
minutes to add to the sleep time
voidsetSeconds(int seconds)
seconds to add to the sleep time
voidvalidate()
verify parameters

Constructor Detail

Sleep

public Sleep()
Creates new instance

Method Detail

doSleep

public void doSleep(long millis)
sleep for a period of time

Parameters: millis time to sleep

execute

public void execute()
Executes this build task. Throws org.apache.tools.ant.BuildException if there is an error during task execution.

Throws: BuildException Description of Exception

setFailOnError

public void setFailOnError(boolean failOnError)
flag controlling whether to break the build on an error.

Parameters: failOnError The new FailOnError value

setHours

public void setHours(int hours)
hours to add to the sleep time.

Parameters: hours The new Hours value

setMilliseconds

public void setMilliseconds(int milliseconds)
milliseconds to add to the sleep time

Parameters: milliseconds The new Milliseconds value

setMinutes

public void setMinutes(int minutes)
minutes to add to the sleep time

Parameters: minutes The new Minutes value

setSeconds

public void setSeconds(int seconds)
seconds to add to the sleep time

Parameters: seconds The new Seconds value

validate

public void validate()
verify parameters

Throws: BuildException if something is invalid