org.jenkinsci.plugins.managedscripts

Class ScriptBuildStep.DescriptorImpl

java.lang.Object

hudson.model.Descriptor<T>

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

org.jenkinsci.plugins.managedscripts.ScriptBuildStep.DescriptorImpl

All Implemented Interfaces:

hudson.model.Saveable

Enclosing class:

ScriptBuildStep

@Extension(ordinal=50.0)
public static final class ScriptBuildStep.DescriptorImpl
extends hudson.tasks.BuildStepDescriptor<hudson.tasks.Builder>

Descriptor for ScriptBuildStep.

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
ScriptBuildStep.DescriptorImpl()

Method Summary

Methods

Modifier and Type	Method and Description
hudson.util.FormValidation	doCheckBuildStepId(String buildStepId) validate that an existing config was chosen
List<ScriptConfig.Arg>	getArgs(String configId)
String	getArgsDescription(String configId) gets the argument description to be displayed on the screen when selecting a config in the dropdown
Collection<org.jenkinsci.lib.configprovider.model.Config>	getAvailableBuildTemplates() Return all config files (templates) that the user can choose from when creating a build step.
ScriptConfig	getBuildStepConfigById(String id) Returns a Config object for a given config file Id.
String	getDisplayName() This human readable name is used in the configuration screen.
boolean	isApplicable(Class<? extends hudson.model.AbstractProject> aClass) Enables this builder for all kinds of projects.

Methods inherited from class hudson.tasks.BuildStepDescriptor

filter

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, calcAutoCompleteSettings, calcFillSettings, configure, 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

ScriptBuildStep.DescriptorImpl

public ScriptBuildStep.DescriptorImpl()

Method Detail

isApplicable

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

Enables this builder for all kinds of projects.

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>

getAvailableBuildTemplates

public Collection<org.jenkinsci.lib.configprovider.model.Config> getAvailableBuildTemplates()

Return all config files (templates) that the user can choose from when creating a build step. Ordered by name.

Returns:

A collection of config files of type ScriptConfig.

getBuildStepConfigById

public ScriptConfig getBuildStepConfigById(String id)

Returns a Config object for a given config file Id.

Parameters:

id - The Id of a config file.

Returns:

If Id can be found a Config object that represents the given Id is returned. Otherwise null.

getArgsDescription

@JavaScriptMethod
public String getArgsDescription(String configId)

gets the argument description to be displayed on the screen when selecting a config in the dropdown

Parameters:

configId - the config id to get the arguments description for

Returns:

the description

getArgs

@JavaScriptMethod
public List<ScriptConfig.Arg> getArgs(String configId)

doCheckBuildStepId

public hudson.util.FormValidation doCheckBuildStepId(@QueryParameter
                                            String buildStepId)

validate that an existing config was chosen

Parameters:

value - the configId

Returns: