Class Reactor

java.lang.Object

org.jvnet.hudson.reactor.Reactor

All Implemented Interfaces:

Iterable<org.jvnet.hudson.reactor.Reactor.Node>

public class Reactor
extends Object
implements Iterable<org.jvnet.hudson.reactor.Reactor.Node>

Executes a set of Tasks that dependend on each other.

As a Set, this object represents a read-only view of all Tasks.

Author:

Kohsuke Kawaguchi

Constructor Summary

Constructors

Constructor	Description
Reactor(Collection<? extends TaskBuilder> builders)
Reactor(TaskBuilder... builders)

Method Summary

Modifier and Type	Method	Description
void	add(Task t)	Adds a new Task to the reactor.
void	addAll(Iterable<? extends Task> _tasks)	Adds a set of tasks to the reactor.
void	execute(Executor e)
void	execute(Executor e, ReactorListener listener)	Executes this initialization session with the given executor.
Iterator<org.jvnet.hudson.reactor.Reactor.Node>	iterator()
protected void	runTask(Task t)	Can be overridden by the subtype to enclose the entire execution of the task.
int	size()

Methods inherited from class Object

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

Methods inherited from interface Iterable

forEach, spliterator

Constructor Details

Reactor

public Reactor(Collection<? extends TaskBuilder> builders)
        throws IOException

Throws:

IOException

Reactor

public Reactor(TaskBuilder... builders)
        throws IOException

Throws:

IOException

Method Details

iterator

public Iterator<org.jvnet.hudson.reactor.Reactor.Node> iterator()

Specified by:

iterator in interface Iterable<org.jvnet.hudson.reactor.Reactor.Node>

size

public int size()

execute

public void execute(Executor e)
             throws InterruptedException,
ReactorException

Throws:

InterruptedException

ReactorException

add

public void add(Task t)

Adds a new Task to the reactor.

This can be even invoked during execution.

addAll

public void addAll(Iterable<? extends Task> _tasks)

Adds a set of tasks to the reactor.

When adding a series of related tasks, it's often necessary to add them as a bulk, or else the newly added task can start executing before its dependencies are added.

execute

public void execute(Executor e,
 ReactorListener listener)
             throws InterruptedException,
ReactorException

Executes this initialization session with the given executor.

Parameters:

e - Used for executing Tasks.

listener - Receives callbacks during the execution.

Throws:

InterruptedException - if this thread is interrupted while waiting for the execution of tasks to complete.

ReactorException - if one of the tasks failed by throwing an exception. The caller is responsible for canceling existing Tasks that are in progress in Executor, if that's desired.

runTask

protected void runTask(Task t)
                throws Exception

Can be overridden by the subtype to enclose the entire execution of the task.

Throws:

Exception