com.examples.jenkins.plugins.helloworld

Class HelloWorldBuilder.DescriptorImpl

java.lang.Object

hudson.model.Descriptor<T>

hudson.tasks.BuildStepDescriptor<hudson.tasks.Builder>

com.examples.jenkins.plugins.helloworld.HelloWorldBuilder.DescriptorImpl

All Implemented Interfaces:

hudson.model.Saveable

Enclosing class:

HelloWorldBuilder

@Extension
public static final class HelloWorldBuilder.DescriptorImpl
extends hudson.tasks.BuildStepDescriptor<hudson.tasks.Builder>

Descriptor for HelloWorldBuilder. Used as a singleton. The class is marked as public so that it can be accessed from views.

See src/main/resources/hudson/plugins/hello_world/HelloWorldBuilder/*.jelly for the actual HTML fragment for the configuration screen.

Nested Class Summary

Nested classes/interfaces inherited from class hudson.model.Descriptor

hudson.model.Descriptor.FormException, hudson.model.Descriptor.PropertyType, hudson.model.Descriptor.Self

Field Summary

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor and Description
HelloWorldBuilder.DescriptorImpl() In order to load the persisted global configuration, you have to call load() in the constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	configure(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject formData)
hudson.util.FormValidation	doCheckName(String value) Performs on-the-fly validation of the form field 'name'.
String	getDisplayName() This human readable name is used in the configuration screen.
boolean	getUseFrench() This method returns true if the global configuration says we should speak French.
boolean	isApplicable(Class<? extends hudson.model.AbstractProject> aClass)

Methods inherited from class hudson.tasks.BuildStepDescriptor

filter

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, calcAutoCompleteSettings, calcFillSettings, configure, doHelp, find, find, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, save, self, toArray, toList, toMap

Methods inherited from class java.lang.Object

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

Constructor Detail

HelloWorldBuilder.DescriptorImpl

public HelloWorldBuilder.DescriptorImpl()

In order to load the persisted global configuration, you have to call load() in the constructor.

Method Detail

doCheckName

public hudson.util.FormValidation doCheckName(@QueryParameter
                                     String value)
                                       throws IOException,
                                              javax.servlet.ServletException

Performs on-the-fly validation of the form field 'name'.

Parameters:

value - This parameter receives the value that the user has typed.

Returns:

Indicates the outcome of the validation. This is sent to the browser.

Note that returning FormValidation.error(String) does not prevent the form from being saved. It just means that a message will be displayed to the user.

Throws:

IOException

javax.servlet.ServletException

isApplicable

public boolean isApplicable(Class<? extends hudson.model.AbstractProject> aClass)

Specified by:

isApplicable in class hudson.tasks.BuildStepDescriptor<hudson.tasks.Builder>

getDisplayName

public String getDisplayName()

This human readable name is used in the configuration screen.

Specified by:

getDisplayName in class hudson.model.Descriptor<hudson.tasks.Builder>

configure

public boolean configure(org.kohsuke.stapler.StaplerRequest req,
                net.sf.json.JSONObject formData)
                  throws hudson.model.Descriptor.FormException

Overrides:

configure in class hudson.model.Descriptor<hudson.tasks.Builder>

Throws:

hudson.model.Descriptor.FormException

getUseFrench

public boolean getUseFrench()

This method returns true if the global configuration says we should speak French. The method name is bit awkward because global.jelly calls this method to determine the initial state of the checkbox by the naming convention.