Package hudson.tasks

Class Builder

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Builder

All Implemented Interfaces:

ExtensionPoint, Describable<Builder>, BuildStep

Direct Known Subclasses:

CommandInterpreter, Maven

public abstract class Builder
extends BuildStepCompatibilityLayer
implements Describable<Builder>, ExtensionPoint

BuildSteps that perform the actual build.

To register a custom Builder from a plugin, put Extension on your descriptor.

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.tasks.BuildStep

BuildStep.PublisherList

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
static DescriptorExtensionList<Builder,Descriptor<Builder>>	all()	Returns all the registered Builder descriptors.
Descriptor<Builder>	getDescriptor()	Gets the descriptor for this instance.
BuildStepMonitor	getRequiredMonitorService()	Returns BuildStepMonitor.NONE by default, as Builders normally don't depend on its previous result.
boolean	prebuild(Build build, BuildListener listener)	Default implementation that does nothing.

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectAction, getProjectAction, getProjectActions, perform, perform, prebuild

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

prebuild

public boolean prebuild(Build build,
 BuildListener listener)

Default implementation that does nothing.

Overrides:

prebuild in class BuildStepCompatibilityLayer

getRequiredMonitorService

public BuildStepMonitor getRequiredMonitorService()

Returns BuildStepMonitor.NONE by default, as Builders normally don't depend on its previous result.

Specified by:

getRequiredMonitorService in interface BuildStep

getDescriptor

public Descriptor<Builder> getDescriptor()

Description copied from interface: Describable

Gets the descriptor for this instance.

Descriptor is a singleton for every concrete Describable implementation, so if a.getClass() == b.getClass() then by default a.getDescriptor() == b.getDescriptor() as well. (In rare cases a single implementation class may be used for instances with distinct descriptors.)

By default looks for a nested class (conventionally named DescriptorImpl) implementing Descriptor and marked with Extension.

Specified by:

getDescriptor in interface Describable<Builder>

all

public static DescriptorExtensionList<Builder,Descriptor<Builder>> all()

Returns all the registered Builder descriptors.