hudson.tasks
Class Shell.DescriptorImpl

java.lang.Object
  hudson.model.Descriptor<T>
      hudson.tasks.BuildStepDescriptor<Builder>
          hudson.tasks.Shell.DescriptorImpl

All Implemented Interfaces:

Saveable

Enclosing class:

Shell

@Extension
public static class Shell.DescriptorImpl
extends BuildStepDescriptor<Builder>

Nested Class Summary

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

Descriptor.FormException, Descriptor.PropertyType, Descriptor.Self

Field Summary

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Shell.DescriptorImpl()

Method Summary

boolean	configure(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject data) Invoked when the global configuration page is submitted.
FormValidation	doCheck(String value) Check the existence of sh in the given location.
String	getDisplayName() Human readable name of this kind of configurable object.
String	getShell()
String	getShellOrDefault() Deprecated. 1.403 Use getShellOrDefault(hudson.remoting.VirtualChannel).
String	getShellOrDefault(hudson.remoting.VirtualChannel channel)
boolean	isApplicable(Class<? extends AbstractProject> jobType) Returns true if this task is applicable to the given project.
Builder	newInstance(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject data) Creates a configured instance from the submitted form.
void	setShell(String shell)

Methods inherited from class hudson.tasks.BuildStepDescriptor

filter

Methods inherited from class hudson.model.Descriptor

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

Shell.DescriptorImpl

public Shell.DescriptorImpl()

Method Detail

isApplicable

public boolean isApplicable(Class<? extends AbstractProject> jobType)

Description copied from class: BuildStepDescriptor

Returns true if this task is applicable to the given project.

Specified by:

isApplicable in class BuildStepDescriptor<Builder>

Returns:

true to allow user to configure this post-promotion task for the given project.

See Also:

AbstractProject.AbstractProjectDescriptor.isApplicable(Descriptor)

getShell

public String getShell()

getShellOrDefault

public String getShellOrDefault()

Deprecated. 1.403 Use getShellOrDefault(hudson.remoting.VirtualChannel).

getShellOrDefault

public String getShellOrDefault(hudson.remoting.VirtualChannel channel)

setShell

public void setShell(String shell)

getDisplayName

public String getDisplayName()

Description copied from class: Descriptor

Human readable name of this kind of configurable object.

Specified by:

getDisplayName in class Descriptor<Builder>

newInstance

public Builder newInstance(org.kohsuke.stapler.StaplerRequest req,
                           net.sf.json.JSONObject data)

Description copied from class: Descriptor

Creates a configured instance from the submitted form.

Hudson only invokes this method when the user wants an instance of T. So there's no need to check that in the implementation.

Starting 1.206, the default implementation of this method does the following:

 req.bindJSON(clazz,formData);
 

... which performs the databinding on the constructor of Descriptor.clazz.

For some types of Describable, such as ListViewColumn, this method can be invoked with null request object for historical reason. Such design is considered broken, but due to the compatibility reasons we cannot fix it. Because of this, the default implementation gracefully handles null request, but the contract of the method still is "request is always non-null." Extension points that need to define the "default instance" semantics should define a descriptor subtype and add the no-arg newInstance method.

Overrides:

newInstance in class Descriptor<Builder>

Parameters:

req - Always non-null (see note above.) This object includes represents the entire submission.

data - The JSON object that captures the configuration data for this Descriptor. See http://wiki.jenkins-ci.org/display/JENKINS/Structured+Form+Submission Always non-null.

configure

public boolean configure(org.kohsuke.stapler.StaplerRequest req,
                         net.sf.json.JSONObject data)

Description copied from class: Descriptor

Invoked when the global configuration page is submitted. Can be overriden to store descriptor-specific information.

Overrides:

configure in class Descriptor<Builder>

data - The JSON object that captures the configuration data for this Descriptor. See http://wiki.jenkins-ci.org/display/JENKINS/Structured+Form+Submission

Returns:

false to keep the client in the same config page.

doCheck

public FormValidation doCheck(@QueryParameter
                              String value)

Check the existence of sh in the given location.