ise.antelope.tasks
Class Repeat

java.lang.Object
  org.apache.tools.ant.ProjectComponent
      org.apache.tools.ant.Task
          ise.antelope.tasks.Repeat

All Implemented Interfaces:

java.lang.Cloneable, org.apache.tools.ant.TaskContainer

public class Repeat
extends org.apache.tools.ant.Task
implements org.apache.tools.ant.TaskContainer

Repeatedly executes a set of tasks. Borrowed most of the code from the Limit task.

Since:

Ant 1.5

Version:

$Revision: 150 $

Field Summary

protected ise.antelope.tasks.typedefs.TimeUnit

unit

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

target, taskName, taskType, wrapper

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

description, location, project

Constructor Summary

Repeat()

Method Summary

void	addTask(org.apache.tools.ant.Task task) Add a task to repeat.
void	addUntil(BooleanConditionTask c) "until" is the same as a "bool" as used in assert and if.
void	execute() Execute all nested tasks, repeating.
void	setCount(int count) Sets the number of times to repeat, default is 1.
void	setDays(int value) Set a number of days between repeats.
void	setFailonerror(boolean fail) Determines whether the build should fail if the time limit has expired on this task.
void	setHours(int value) Set a number of hours between repeats.
void	setInterval(int wait) How long to wait between repeating the nested tasks, default is 10 sec.
void	setMilliseconds(int value) Set a number of milliseconds between repeats.
void	setMinutes(int value) Set a number of minutes between repeats.
void	setProperty(java.lang.String p) Name the property to set after all repeats are complete.
void	setRepeatunit(ise.antelope.tasks.typedefs.TimeUnit unit) Set the max wait time unit, default is minutes.
void	setSeconds(int value) Set a number of seconds between repeats.
void	setUnit(java.lang.String unit) Sets the unit for the time between repeats.
void	setValue(java.lang.String v) The value for the property to set after all repeats are complete, defaults to true.
void	setWeeks(int value) Set a number of weeks between repeats.

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

bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

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

clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

unit

protected ise.antelope.tasks.typedefs.TimeUnit unit

Constructor Detail

Repeat

public Repeat()

Method Detail

addTask

public void addTask(org.apache.tools.ant.Task task)
             throws org.apache.tools.ant.BuildException

Add a task to repeat.

Specified by:

addTask in interface org.apache.tools.ant.TaskContainer

Parameters:

task - A task to execute

Throws:

org.apache.tools.ant.BuildException - won't happen

addUntil

public void addUntil(BooleanConditionTask c)
              throws org.apache.tools.ant.BuildException

"until" is the same as a "bool" as used in assert and if. If used, this task will repeat until either this condition is met or the maximum number of repetitions has been met, whichever is first.

Parameters:

c - The feature to be added to the Until attribute

Throws:

org.apache.tools.ant.BuildException - Description of Exception

setInterval

public void setInterval(int wait)

How long to wait between repeating the nested tasks, default is 10 sec.

Parameters:

wait - time between repeats

setUnit

public void setUnit(java.lang.String unit)

Sets the unit for the time between repeats. Default is seconds.

Parameters:

unit - valid values are "millisecond", "second", "minute", "hour", "day", and "week".

setMilliseconds

public void setMilliseconds(int value)

Set a number of milliseconds between repeats.

Parameters:

value - the number of milliseconds between repeats.

setSeconds

public void setSeconds(int value)

Set a number of seconds between repeats.

Parameters:

value - the number of seconds to wait.

setMinutes

public void setMinutes(int value)

Set a number of minutes between repeats.

Parameters:

value - the number of milliseconds to wait.

setHours

public void setHours(int value)

Set a number of hours between repeats.

Parameters:

value - the number of hours to wait.

setDays

public void setDays(int value)

Set a number of days between repeats.

Parameters:

value - the number of days to wait.

setWeeks

public void setWeeks(int value)

Set a number of weeks between repeats.

Parameters:

value - the number of weeks to wait.

setRepeatunit

public void setRepeatunit(ise.antelope.tasks.typedefs.TimeUnit unit)

Set the max wait time unit, default is minutes.

Parameters:

unit - The new repeatUnit value

setFailonerror

public void setFailonerror(boolean fail)

Determines whether the build should fail if the time limit has expired on this task. Default is no.

Parameters:

fail - if true, fail the build if the time limit has been reached.

setProperty

public void setProperty(java.lang.String p)

Name the property to set after all repeats are complete.

Parameters:

p - name of property

setValue

public void setValue(java.lang.String v)

The value for the property to set after all repeats are complete, defaults to true.

Parameters:

v - value for the property

setCount

public void setCount(int count)

Sets the number of times to repeat, default is 1. Use -1 to repeat forever.

Parameters:

count - The new repeatCount value

execute

public void execute()
             throws org.apache.tools.ant.BuildException

Execute all nested tasks, repeating.

Overrides:

execute in class org.apache.tools.ant.Task

Throws:

org.apache.tools.ant.BuildException - Description of the Exception