File D:\maven-qcr-plugin-testsunitaires\qcr4java\jenkins-master\target\site\qc\core\src\main\java\hudson\tasks\BuildStepDescriptor.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.tasks;
25
26 import hudson.model.Describable;
27 import hudson.model.Descriptor;
28 import hudson.model.AbstractProject;
29 import jenkins.model.Jenkins;
30 import hudson.model.AbstractProject.AbstractProjectDescriptor;
31
32 import java.util.List;
33 import java.util.ArrayList;
34
35 /**
36 * {@link Descriptor} for {@link Builder} and {@link Publisher}.
37 *
38 * <p>
39 * For compatibility reasons, plugins developed before 1.150 may not extend from this descriptor type.
40 *
41 * @author Kohsuke Kawaguchi
42 * @since 1.150
43 */
44 public abstract class BuildStepDescriptor<T extends BuildStep & Describable<T>> extends Descriptor<T> {
45 protected BuildStepDescriptor(Class<? extends T> clazz) {
46 super(clazz);
47 }
48
49 /**
50 * Infers the type of the corresponding {@link BuildStep} from the outer class.
51 * This version works when you follow the common convention, where a descriptor
52 * is written as the static nested class of the describable class.
53 *
54 * @since 1.278
55 */
56 protected BuildStepDescriptor() {
57 }
58
59 /**
60 * Returns true if this task is applicable to the given project.
61 *
62 * @return
63 * true to allow user to configure this post-promotion task for the given project.
64 * @see AbstractProjectDescriptor#isApplicable(Descriptor)
65 */
66 public abstract boolean isApplicable(Class<? extends AbstractProject> jobType);
67
68
69 /**
70 * Filters a descriptor for {@link BuildStep}s by using {@link BuildStepDescriptor#isApplicable(Class)}.
71 */
72 public static <T extends BuildStep&Describable<T>>
73 List<Descriptor<T>> filter(List<Descriptor<T>> base, Class<? extends AbstractProject> type) {
74 // descriptor of the project
75 Descriptor pd = Jenkins.getInstance().getDescriptor((Class) type);
76
77 List<Descriptor<T>> r = new ArrayList<Descriptor<T>>(base.size());
78 for (Descriptor<T> d : base) {
79 if (pd instanceof AbstractProjectDescriptor && !((AbstractProjectDescriptor)pd).isApplicable(d))
80 continue;
81
82 if (d instanceof BuildStepDescriptor) {
83 BuildStepDescriptor<T> bd = (BuildStepDescriptor<T>) d;
84 if(!bd.isApplicable(type)) continue;
85 r.add(bd);
86 } else {
87 // old plugins built before 1.150 may not implement BuildStepDescriptor
88 r.add(d);
89 }
90 }
91 return r;
92 }
93 }
94