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

1 /*
2 * The MIT License
3 *
4 * Copyright (c) 2010, InfraDNA, Inc.
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 import hudson.tasks.BuildStep;
28
29 import java.util.Collection;
30
31 /**
32 * Can contribute to project actions.
33 *
34 *
35 * @author Kohsuke Kawaguchi
36 * @see MavenBuildProxy#registerAsProjectAction(MavenProjectActionBuilder)
37 */
38 public interface MavenProjectActionBuilder {
39 /**
40 * Equivalent of {@link BuildStep#getProjectActions(AbstractProject)}.
41 *
42 * <p>
43 * Registers a transient action to {@link MavenModule} when it's rendered.
44 * This is useful if you'd like to display an action at the module level.
45 *
46 * <p>
47 * Since this contributes a transient action, the returned {@link Action}
48 * will not be serialized.
49 *
50 * <p>
51 * For this method to be invoked, call
52 * {@link MavenBuildProxy#registerAsProjectAction(MavenProjectActionBuilder)} during the build.
53 *
54 * @return
55 * can be empty but never null.
56 * @since 1.341
57 */
58 Collection<? extends Action> getProjectActions(MavenModule module);
59 }
60