org.oddjob.jobs.structural

Class RepeatJob

java.lang.Object

org.oddjob.framework.extend.BaseComponent

org.oddjob.framework.extend.BasePrimary

org.oddjob.framework.extend.StructuralJob<java.lang.Runnable>

org.oddjob.jobs.structural.RepeatJob

All Implemented Interfaces:

java.io.Serializable, java.lang.Runnable, ArooaContextAware, ArooaSessionAware, Forceable, PropertyChangeNotifier, Iconic, LogEnabled, Resettable, Stateful, Stoppable, Structural

public class RepeatJob
extends StructuralJob<java.lang.Runnable>
implements Stoppable

Description

This job will repeatedly run its child job. The repeat can be either for:

• Each value of a collection.
• Or a given number times.
• Or until the until property is true.

Without either a until or a times or values the job will loop indefinitely.

Example

Repeat a job 3 times.

<oddjob>
    <job>
        <repeat times="3" id="repeat">
            <job>
                <echo>Hello ${repeat.count}</echo>
            </job>
        </repeat>
    </job>
</oddjob>

Example

Repeat a job 3 times with a sequence.

<oddjob>
    <job>
        <repeat id="each">
            <values>
                <sequence from="1" to="3"/>
            </values>
            <job>
                <echo>Hello ${each.current}</echo>
            </job>
        </repeat>
    </job>
</oddjob>

See Also:

Serialized Form

Author:

Rob Gordon.

Field Summary

Fields inherited from class org.oddjob.framework.extend.StructuralJob

childHelper, destroy, stop, structuralState

Constructor Summary

Constructors

Constructor and Description
RepeatJob()

Method Summary

Modifier and Type	Method and Description
protected void	execute() Execute this job.
int	getCount()
java.lang.Object	getCurrent()
java.util.concurrent.ExecutorService	getExecutorService() Getter for executor service.
int	getIndex()
protected StateOperator	getInitialStateOp() Subclasses must provide the StateOperator that will decide how to evaluate the children's state.
int	getTimes()
java.lang.Iterable<?>	getValues()
boolean	isUntil()
protected void	onHardReset() Allow sub classes to do something on HARD reset.
protected void	onStop() Allow sub classes to do something on stop.
void	setExecutorService(java.util.concurrent.ExecutorService executorService) Set the ExecutorService.
void	setJob(java.lang.Runnable child)
void	setTimes(int times)
void	setUntil(boolean until)
void	setValues(java.lang.Iterable<?> values)
protected void	startChildStateReflector() Start the child state reflector.

Methods inherited from class org.oddjob.framework.extend.StructuralJob

addStructuralListener, fireDestroyedState, force, getStateChanger, hardReset, iconHelper, isStop, onDestroy, onReset, onSoftReset, postStop, removeStructuralListener, run, softReset, stateHandler, stop, stopChildStateReflector, waitForChildrenOnStop

Methods inherited from class org.oddjob.framework.extend.BasePrimary

configure, getName, logger, logger, loggerName, save, setName, toString

Methods inherited from class org.oddjob.framework.extend.BaseComponent

addIconListener, addPropertyChangeListener, addStateListener, configure, destroy, firePropertyChange, getArooaSession, iconForId, initialise, lastStateEvent, onConfigured, onInitialised, removeIconListener, removePropertyChangeListener, removeStateListener, save, setArooaContext, setArooaSession

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.oddjob.Stoppable

stop

Methods inherited from interface org.oddjob.Stateful

addStateListener, lastStateEvent, removeStateListener

Constructor Detail

RepeatJob

public RepeatJob()

Method Detail

getInitialStateOp

protected StateOperator getInitialStateOp()

Description copied from class: StructuralJob

Subclasses must provide the StateOperator that will decide how to evaluate the children's state.

Specified by:

getInitialStateOp in class StructuralJob<java.lang.Runnable>

Returns:

A State Operator. Must not be null.

setExecutorService

@Inject
public void setExecutorService(java.util.concurrent.ExecutorService executorService)

Set the ExecutorService.

Property: executorService

Description: The ExecutorService to use. This will be automatically set by Oddjob.

Required: No.

Parameters:

executorService - The Executor Service.

getExecutorService

public java.util.concurrent.ExecutorService getExecutorService()

Getter for executor service.

Returns:

The executor service or null if not set.

setJob

public void setJob(java.lang.Runnable child)

Property: job

Description: The job who's execution to schedule.

Required: Yes.

execute

protected void execute()

Description copied from class: StructuralJob

Execute this job.

Specified by:

execute in class StructuralJob<java.lang.Runnable>

onStop

protected void onStop()
               throws FailedToStopException

Description copied from class: StructuralJob

Allow sub classes to do something on stop.

Overrides:

onStop in class StructuralJob<java.lang.Runnable>

Throws:

FailedToStopException

startChildStateReflector

protected void startChildStateReflector()

Description copied from class: StructuralJob

Start the child state reflector. Sub classes override this if they need to start the child state reflector at a different time.

Overrides:

startChildStateReflector in class StructuralJob<java.lang.Runnable>

onHardReset

protected void onHardReset()

Description copied from class: StructuralJob

Allow sub classes to do something on HARD reset.

Overrides:

onHardReset in class StructuralJob<java.lang.Runnable>

setValues

public void setValues(java.lang.Iterable<?> values)

getValues

public java.lang.Iterable<?> getValues()

isUntil

public boolean isUntil()

setUntil

public void setUntil(boolean until)

getTimes

public int getTimes()

setTimes

public void setTimes(int times)

getCount

public int getCount()

getIndex

public int getIndex()

Property: index

Description: The same as count. Provided so configurations can be swapped between this and ForEachJob job.

Returns:

The index.

getCurrent

public java.lang.Object getCurrent()