From d67f4c5ff89c2f595bd2b9d04c5abe765fd9b9f6 Mon Sep 17 00:00:00 2001 From: Kohsuke Kawaguchi Date: Fri, 13 May 2011 14:23:17 -0700 Subject: [PATCH] doc improvement --- .../main/java/hudson/matrix/MatrixBuild.java | 3 +- .../matrix/listeners/MatrixBuildListener.java | 120 ++++++++++++------ 2 files changed, 86 insertions(+), 37 deletions(-) diff --git a/core/src/main/java/hudson/matrix/MatrixBuild.java b/core/src/main/java/hudson/matrix/MatrixBuild.java index 2d100136aa..1b5a070cb3 100644 --- a/core/src/main/java/hudson/matrix/MatrixBuild.java +++ b/core/src/main/java/hudson/matrix/MatrixBuild.java @@ -218,7 +218,8 @@ public class MatrixBuild extends AbstractBuild { Collection touchStoneConfigurations = new HashSet(); Collection delayedConfigurations = new HashSet(); for (MatrixConfiguration c: activeConfigurations) { - if (!MatrixBuildListener.buildConfiguration(MatrixBuild.this, c)) continue; + if (!MatrixBuildListener.buildConfiguration(MatrixBuild.this, c)) + continue; // skip rebuild if (touchStoneFilter != null && c.getCombination().evalGroovyExpression(p.getAxes(), p.getTouchStoneCombinationFilter())) { touchStoneConfigurations.add(c); } else { diff --git a/core/src/main/java/hudson/matrix/listeners/MatrixBuildListener.java b/core/src/main/java/hudson/matrix/listeners/MatrixBuildListener.java index a0b2ce018f..c1b2a1354c 100644 --- a/core/src/main/java/hudson/matrix/listeners/MatrixBuildListener.java +++ b/core/src/main/java/hudson/matrix/listeners/MatrixBuildListener.java @@ -1,36 +1,84 @@ -package hudson.matrix.listeners; - -import hudson.ExtensionList; -import hudson.ExtensionPoint; -import hudson.matrix.MatrixConfiguration; -import hudson.matrix.MatrixBuild; -import hudson.model.Hudson; - -public abstract class MatrixBuildListener implements ExtensionPoint { - - /** - * Determine whether to build a given configuration or not - * @param b - * @param c - * @return - */ - public boolean doBuildConfiguration(MatrixBuild b, MatrixConfiguration c){return true;} - - public static boolean buildConfiguration(MatrixBuild b, MatrixConfiguration c) { - for (MatrixBuildListener l : all()) { - if(!l.doBuildConfiguration(b, c)) { - return false; - } - - } - - return true; - } - - /** - * Returns all the registered {@link MatrixBuildListener} descriptors. - */ - public static ExtensionList all() { - return Hudson.getInstance().getExtensionList(MatrixBuildListener.class); - } -} +/* + * The MIT License + * + * Copyright (c) 2011, Christian Wolfgang + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN + * THE SOFTWARE. + */ +package hudson.matrix.listeners; + +import hudson.ExtensionList; +import hudson.ExtensionPoint; +import hudson.matrix.MatrixConfiguration; +import hudson.matrix.MatrixBuild; +import hudson.matrix.MatrixRun; +import hudson.model.Action; +import hudson.model.Hudson; +import hudson.model.Queue; +import hudson.model.Queue.Task; + +import java.util.List; + +/** + * Controls which subset of {@link MatrixRun}s 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 {@link Action} to a build when it goes to the queue + * ({@link Queue#schedule(Task, int, List)}, then access this from {@link MatrixBuild} to drive + * the filtering logic. + * + *

+ * See the matrix reloaded plugin for an example. + * + * @author Christian Wolfgang + * @since 1.413 + */ +public abstract class MatrixBuildListener implements ExtensionPoint { + /** + * Determine whether to build a given configuration or not + * + * @param b + * Never null. The umbrella build. + * @param c + * The configuration whose build is being considered. If any of the {@link 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. + * @return + * True to let the build happen, false to skip it. + */ + public abstract boolean doBuildConfiguration(MatrixBuild b, MatrixConfiguration c); + + public static boolean buildConfiguration(MatrixBuild b, MatrixConfiguration c) { + for (MatrixBuildListener l : all()) { + if(!l.doBuildConfiguration(b, c)) { + return false; + } + } + + return true; + } + + /** + * Returns all the registered {@link MatrixBuildListener} descriptors. + */ + public static ExtensionList all() { + return Hudson.getInstance().getExtensionList(MatrixBuildListener.class); + } +}