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

http://github.com/hudson/hudson · Java · 77 lines · 23 code · 8 blank · 46 comment · 0 complexity · d168bfedb233369109102724f1a2f505 MD5 · raw file

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