Package hudson.tasks

Class BatchFile.DescriptorImpl

java.lang.Object

hudson.model.Descriptor<T>

hudson.tasks.BuildStepDescriptor<Builder>

hudson.tasks.BatchFile.DescriptorImpl

All Implemented Interfaces:

Saveable, OnMaster

Enclosing class:

BatchFile

@Extension
@Symbol("batchFile")
public static final class BatchFile.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

Constructors

Constructor	Description
DescriptorImpl()

Method Summary

Modifier and Type	Method	Description
FormValidation	doCheckUnstableReturn(String value)	Performs on-the-fly validation of the errorlevel.
List<EnvVarsFilterLocalRuleDescriptor>	getApplicableLocalRules()
String	getDisplayName()	Human readable name of this kind of configurable object.
String	getHelpFile()	Returns the resource path to the help screen HTML, if any.
boolean	isApplicable(Class<? extends AbstractProject> jobType)	Returns true if this task is applicable to the given project.

Methods inherited from class hudson.tasks.BuildStepDescriptor

filter

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, bindJSON, calcAutoCompleteSettings, calcFillSettings, configure, configure, doHelp, find, find, findByDescribableClassName, findById, getCategory, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getRequiredGlobalConfigPagePermission, 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

DescriptorImpl

public DescriptorImpl()

Method Detail

getHelpFile

public String getHelpFile()

Description copied from class: Descriptor

Returns the resource path to the help screen HTML, if any.

Starting 1.282, this method uses "convention over configuration" — you should just put the "help.html" (and its localized versions, if any) in the same directory you put your Jelly view files, and this method will automatically does the right thing.

This value is relative to the context root of Hudson, so normally the values are something like "/plugin/emma/help.html" to refer to static resource files in a plugin, or "/publisher/EmmaPublisher/abc" to refer to Jelly script abc.jelly or a method EmmaPublisher.doAbc().

Overrides:

getHelpFile in class Descriptor<Builder>

Returns:

null to indicate that there's no help.

getDisplayName

@NonNull
public String getDisplayName()

Description copied from class: Descriptor

Human readable name of this kind of configurable object. Should be overridden for most descriptors, if the display name is visible somehow. As a fallback it uses Class.getSimpleName() on Descriptor.clazz, so for example MyThing from some.pkg.MyThing.DescriptorImpl. Historically some implementations returned null as a way of hiding the descriptor from the UI, but this is generally managed by an explicit method such as isEnabled or isApplicable.

Overrides:

getDisplayName in class Descriptor<Builder>

doCheckUnstableReturn

@Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class)
public FormValidation doCheckUnstableReturn(@QueryParameter
                                            String value)

Performs on-the-fly validation of the errorlevel.

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)

getApplicableLocalRules

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public List<EnvVarsFilterLocalRuleDescriptor> getApplicableLocalRules()