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

Field Summary

Fields inherited from class org.apache.tools.ant.Task

description, location, target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

project

Constructor Summary

Sleep()
Creates new instance

Method Summary

void
doSleep(long millis)
sleep for a period of time
void
execute()
Executes this build task.
void
setFailOnError(boolean failOnError)
flag controlling whether to break the build on an error.
void
setHours(int hours)
hours to add to the sleep time.
void
setMilliseconds(int milliseconds)
milliseconds to add to the sleep time
void
setMinutes(int minutes)
minutes to add to the sleep time
void
setSeconds(int seconds)
seconds to add to the sleep time
void
validate()
verify parameters

Methods inherited from class org.apache.tools.ant.Task

execute, getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, maybeConfigure, perform, reconfigure, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

getProject, log, log, setProject

Constructor Details

Sleep

public Sleep()
Creates new instance

Method Details

doSleep

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

Parameters:
millis - time to sleep


execute

public void execute()
            throws BuildException
Executes this build task. Throws org.apache.tools.ant.BuildException if there is an error during task execution.
Overrides:
execute in interface Task

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()
            throws BuildException
verify parameters

Throws:
BuildException - if something is invalid


Copyright B) 2000-2005 Apache Software Foundation. All Rights Reserved.