/hudson-core/src/main/java/hudson/tasks/Builder.java

 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 */
24package hudson.tasks;
25
26import hudson.ExtensionPoint;
27import hudson.Extension;
28import hudson.DescriptorExtensionList;
29import hudson.model.Build;
30import hudson.model.BuildListener;
31import hudson.model.Describable;
32import hudson.model.Descriptor;
33import hudson.model.Hudson;
34
35
36/**
37 * {@link BuildStep}s that perform the actual build.
38 *
39 * <p>
40 * To register a custom {@link Builder} from a plugin,
41 * put {@link Extension} on your descriptor.
42 *
43 * @author Kohsuke Kawaguchi
44 */
45public abstract class Builder extends BuildStepCompatibilityLayer implements BuildStep, Describable<Builder>, ExtensionPoint {
46    
47
48//
49// these two methods need to remain to keep binary compatibility with plugins built with Hudson < 1.150
50//
51    /**
52     * Default implementation that does nothing.
53     */
54    public boolean prebuild(Build build, BuildListener listener) {
55        return true;
56    }
57
58    /**
59     * Returns {@link BuildStepMonitor#NONE} by default, as {@link Builder}s normally don't depend
60     * on its previous result.
61     */
62    public BuildStepMonitor getRequiredMonitorService() {
63        return BuildStepMonitor.NONE;
64    }
65
66    public Descriptor<Builder> getDescriptor() {
67        return Hudson.getInstance().getDescriptorOrDie(getClass());
68    }
69
70    /**
71     * Returns all the registered {@link Builder} descriptors.
72     */
73    // for backward compatibility, the signature is not BuildStepDescriptor
74    public static DescriptorExtensionList<Builder,Descriptor<Builder>> all() {
75        return Hudson.getInstance().<Builder,Descriptor<Builder>>getDescriptorList(Builder.class);
76    }
77}