hudson.plugins.hello_world

Class HelloWorldBuilder

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Builder

hudson.plugins.hello_world.HelloWorldBuilder

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.tasks.Builder>, hudson.tasks.BuildStep

public class HelloWorldBuilder
extends hudson.tasks.Builder

Sample Builder.

When the user configures the project and enables this builder, Descriptor.newInstance(StaplerRequest) is invoked and a new HelloWorldBuilder is created. The created instance is persisted to the project configuration XML by using XStream, so this allows you to use instance fields (like name) to remember the configuration.

When a build is performed, the BuildStepCompatibilityLayer.perform(Build, Launcher, BuildListener) method will be invoked.

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HelloWorldBuilder.DescriptorImpl Descriptor for HelloWorldBuilder.

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

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

hudson.tasks.BuildStep.PublisherList

Field Summary

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor and Description
HelloWorldBuilder(String name) This annotation tells Hudson to call this constructor, with values from the configuration form page with matching parameter names.

Method Summary

Modifier and Type	Method and Description
HelloWorldBuilder.DescriptorImpl	getDescriptor() Hudson defines a method Builder.getDescriptor(), which returns the corresponding Descriptor object.
String	getName() We'll use this from the config.jelly.
boolean	perform(hudson.model.AbstractBuild build, hudson.Launcher launcher, hudson.model.BuildListener listener)

Methods inherited from class hudson.tasks.Builder

all, getRequiredMonitorService, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectAction, getProjectAction, getProjectActions, perform, prebuild

Methods inherited from class java.lang.Object

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

Constructor Detail

HelloWorldBuilder

@DataBoundConstructor
public HelloWorldBuilder(String name)

This annotation tells Hudson to call this constructor, with values from the configuration form page with matching parameter names.

Method Detail

getName

public String getName()

We'll use this from the config.jelly.

perform

public boolean perform(hudson.model.AbstractBuild build,
                       hudson.Launcher launcher,
                       hudson.model.BuildListener listener)

Specified by:

perform in interface hudson.tasks.BuildStep

Overrides:

perform in class hudson.tasks.BuildStepCompatibilityLayer

getDescriptor

public HelloWorldBuilder.DescriptorImpl getDescriptor()

Hudson defines a method Builder.getDescriptor(), which returns the corresponding Descriptor object. Since we know that it's actually HelloWorldBuilder.DescriptorImpl, override the method and give a better return type, so that we can access HelloWorldBuilder.DescriptorImpl methods more easily. This is not necessary, but just a coding style preference.

Specified by:

getDescriptor in interface hudson.model.Describable<hudson.tasks.Builder>

Overrides:

getDescriptor in class hudson.tasks.Builder