File D:\maven-qcr-plugin-testsunitaires\qcr4java\jenkins-master\target\site\qc\core\src\main\java\hudson\matrix\MatrixAggregatable.java.html

1 /*
2 * The MIT License
3 *
4 * Copyright (c) 2004-2009, Sun Microsystems, Inc., Kohsuke Kawaguchi
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 * THE SOFTWARE.
23 */
24 package hudson.matrix;
25
26 import hudson.model.JobProperty;
27 import hudson.tasks.BuildWrapper;
28 import hudson.tasks.Publisher;
29 import hudson.ExtensionPoint;
30 import hudson.Launcher;
31 import hudson.model.BuildListener;
32
33 /**
34 * {@link Publisher}, {@link JobProperty}, {@link BuildWrapper} can optionally implement this interface
35 * to perform result aggregation across {@link MatrixRun}.
36 *
37 * <p>
38 * This is useful for example to aggregate all the test results
39 * in {@link MatrixRun} into a single table/graph.
40 *
41 * @author Kohsuke Kawaguchi
42 * @since 1.115
43 */
44 public interface MatrixAggregatable extends ExtensionPoint {
45 /**
46 * Creates a new instance of the aggregator.
47 *
48 * <p>
49 * This method is called during the build of
50 * {@link MatrixBuild} and the created aggregator
51 * will perform the aggregation.
52 *
53 * @param build
54 * The build for which the aggregation shall happen. Never null.
55 * @param launcher
56 * Can be used to launch processes during the build.
57 * @param listener
58 * Progress report and errors during the aggregation should
59 * be sent to this object. Never null.
60 *
61 * @return
62 * null if the implementation is not willing to contribute
63 * an aggregator.
64 *
65 * @see MatrixAggregator#build
66 * @see MatrixAggregator#listener
67 */
68 MatrixAggregator createAggregator(MatrixBuild build, Launcher launcher, BuildListener listener);
69 }
70