File D:\maven-qcr-plugin-testsunitaires\qcr4java\jenkins-master\target\site\qc\maven-plugin\src\main\java\hudson\maven\AggregatableAction.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.maven;
25
26 import hudson.model.Action;
27
28 import java.util.List;
29 import java.util.Map;
30
31 /**
32 * Indicates that this {@link Action} for {@link MavenBuild} contributes
33 * an "aggregated" action to {@link MavenBuild#getModuleSetBuild()
34 * its governing MavenModuleSetBuild}.
35 *
36 * @author Kohsuke Kawaguchi
37 * @since 1.99
38 * @see MavenReporter
39 */
40 public interface AggregatableAction extends Action {
41 /**
42 * Creates {@link Action} to be contributed to {@link MavenModuleSetBuild}.
43 *
44 * @param build
45 * {@link MavenModuleSetBuild} for which the aggregated report is
46 * created.
47 * @param moduleBuilds
48 * The result of {@link MavenModuleSetBuild#getModuleBuilds()} provided
49 * for convenience and efficiency.
50 * @return
51 * null if the reporter provides no such action.
52 */
53 MavenAggregatedReport createAggregatedAction(
54 MavenModuleSetBuild build, Map<MavenModule,List<MavenBuild>> moduleBuilds);
55 }
56