File D:\maven-qcr-plugin-testsunitaires\qcr4java\jenkins-master\target\site\qc\core\src\main\java\jenkins\model\DependencyDeclarer.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 jenkins.model;
25
26 import hudson.model.AbstractProject;
27 import hudson.model.DependencyGraph;
28 import hudson.tasks.BuildStep;
29 import hudson.tasks.Builder;
30 import hudson.tasks.Publisher;
31
32 /**
33 * Marker interface for those {@link BuildStep}s that can participate
34 * in the dependency graph computation process.
35 *
36 * <p>
37 * {@link Publisher}s, {@link Builder}s, and {@link JobProperty}s
38 * can additional implement this method to add additional edges
39 * to the dependency graph computation.
40 *
41 * @author Nicolas Lalevee
42 * @author Martin Ficker
43 * @author Kohsuke Kawaguchi
44 * @since 1.501
45 */
46 public interface DependencyDeclarer {
47 // I thought about whether this should extend BuildStep or not and decided not to.
48 // so that this concept can be extended elsewhere, like maven projects and so on.
49
50 /**
51 * Invoked from {@link AbstractProject#buildDependencyGraph(DependencyGraph)}.
52 *
53 * @param owner
54 * The project that owns the publishers, builders, etc.
55 * This information is conceptually redundant, as those objects are
56 * only configured against the single owner, but this information is
57 * nevertheless passed in since often owner information is not recorded.
58 * Never null.
59 * @param graph
60 * The dependency graph being built. Never null.
61 */
62 void buildDependencyGraph(AbstractProject owner, DependencyGraph graph);
63 }
64