Package hudson.matrix.listeners

Class MatrixBuildListener

java.lang.Object

hudson.matrix.listeners.MatrixBuildListener

All Implemented Interfaces:

ExtensionPoint

public abstract class MatrixBuildListener
extends Object
implements ExtensionPoint

Controls which subset of MatrixRuns to rebuild.

Plugins can implement this extension point to filter out the subset of matrix project to build. Most typically, such a plugin would add a custom Action to a build when it goes to the queue (Queue.schedule2(Task, int, List), then access this from MatrixBuild to drive the filtering logic.

See the matrix reloaded plugin for an example.

Since:

1.413

Author:

Christian Wolfgang

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
MatrixBuildListener()

Method Summary

Modifier and Type	Method	Description
static ExtensionList<MatrixBuildListener>	all()	Returns all the registered MatrixBuildListener descriptors.
static boolean	buildConfiguration(MatrixBuild b, MatrixConfiguration c)
abstract boolean	doBuildConfiguration(MatrixBuild b, MatrixConfiguration c)	Determine whether to build a given configuration or not

Methods inherited from class java.lang.Object

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

Constructor Details

MatrixBuildListener

public MatrixBuildListener()

Method Details

doBuildConfiguration

public abstract boolean doBuildConfiguration(MatrixBuild b,
 MatrixConfiguration c)

Determine whether to build a given configuration or not

Parameters:

b - Never null. The umbrella build.

c - The configuration whose build is being considered. If any of the MatrixBuildListener returns false, then the build for this configuration is skipped, and the previous build of this configuration will be taken as the default result.

Returns:

True to let the build happen, false to skip it.

buildConfiguration

public static boolean buildConfiguration(MatrixBuild b,
 MatrixConfiguration c)

all

@NonNull
public static ExtensionList<MatrixBuildListener> all()

Returns all the registered MatrixBuildListener descriptors.