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

1 /*
2 * The MIT License
3 *
4 * Copyright (c) 2004-2009, Sun Microsystems, 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.model;
25
26 import hudson.EnvVars;
27 import hudson.model.Queue.Task;
28 import hudson.tasks.Builder;
29 import hudson.tasks.BuildWrapper;
30
31 /**
32 * {@link Action} that contributes environment variables during a build.
33 *
34 * <p>
35 * For example, your {@link Builder} can add an {@link EnvironmentContributingAction} so that
36 * the rest of the builders or publishers see some behavior changes.
37 *
38 * Another use case is for you to {@linkplain Queue#schedule(Task, int, Action...) submit a job} with
39 * {@link EnvironmentContributingAction}s.
40 *
41 * @author Kohsuke Kawaguchi
42 * @since 1.318
43 * @see AbstractBuild#getEnvironment(TaskListener)
44 * @see BuildWrapper
45 */
46 public interface EnvironmentContributingAction extends Action {
47 /**
48 * Called by {@link AbstractBuild} to allow plugins to contribute environment variables.
49 *
50 * @param build
51 * The calling build. Never null.
52 * @param env
53 * Environment variables should be added to this map.
54 */
55 void buildEnvVars(AbstractBuild<?, ?> build, EnvVars env);
56 }
57