Package hudson.matrix

Class MatrixAggregator

java.lang.Object

hudson.matrix.MatrixAggregator

All Implemented Interfaces:

ExtensionPoint

Direct Known Subclasses:

TestResultAggregator

public abstract class MatrixAggregator
extends Object
implements ExtensionPoint

Performs the aggregation of MatrixRun results into MatrixBuild.

MatrixAggregator is a transitive stateful mutable object. Unlike Publisher, it is not persisted. Instead, a fresh instance is created for each MatrixBuild, and various methods on this class are invoked in the event callback style as the build progresses.

The end result of the aggregation should be contributed as actions.

Since:

1.115

Author:

Kohsuke Kawaguchi

See Also:

• MatrixAggregatable

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field	Description
protected final MatrixBuild	build	The build in progress.
protected final Launcher	launcher
protected final BuildListener	listener	The listener to send the output to.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MatrixAggregator(MatrixBuild build, Launcher launcher, BuildListener listener)

Method Summary

Modifier and Type	Method	Description
boolean	endBuild()	Called after all the MatrixRuns have been completed to indicate that the build is about to finish.
boolean	endRun(MatrixRun run)	Called whenever one run is completed.
boolean	startBuild()	Called before the build starts.

Methods inherited from class java.lang.Object

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

Field Details

build

protected final MatrixBuild build

The build in progress. Never null.

launcher

protected final Launcher launcher

listener

protected final BuildListener listener

The listener to send the output to. Never null.

Constructor Details

MatrixAggregator

protected MatrixAggregator(MatrixBuild build,
 Launcher launcher,
 BuildListener listener)

Method Details

startBuild

public boolean startBuild()
                   throws InterruptedException,
IOException

Called before the build starts.

Returns:

true if the build can continue, false if there was an error and the build needs to be aborted.

Throws:

InterruptedException

IOException

See Also:

• BuildStep.prebuild(AbstractBuild,BuildListener)

endRun

public boolean endRun(MatrixRun run)
               throws InterruptedException,
IOException

Called whenever one run is completed.

Parameters:

run - The completed MatrixRun object. Always non-null.

Returns:

See startBuild() for the return value semantics.

Throws:

InterruptedException

IOException

endBuild

public boolean endBuild()
                 throws InterruptedException,
IOException

Called after all the MatrixRuns have been completed to indicate that the build is about to finish.

Returns:

See startBuild() for the return value semantics.

Throws:

InterruptedException

IOException