Package hudson.tasks

Class BuildStepDescriptor<T extends BuildStep & Describable<T>>

java.lang.Object

hudson.model.Descriptor<T>

hudson.tasks.BuildStepDescriptor<T>

All Implemented Interfaces:

Saveable, Loadable, OnMaster

Direct Known Subclasses:

ArtifactArchiver.DescriptorImpl, BatchFile.DescriptorImpl, BuildTrigger.DescriptorImpl, Fingerprinter.DescriptorImpl, Maven.DescriptorImpl, Shell.DescriptorImpl

public abstract class BuildStepDescriptor<T extends BuildStep & Describable<T>>
extends Descriptor<T>

Descriptor for Builder and Publisher.

For compatibility reasons, plugins developed before 1.150 may not extend from this descriptor type.

Since:

1.150

Author:

Kohsuke Kawaguchi

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

Modifier	Constructor	Description
protected	BuildStepDescriptor()	Infers the type of the corresponding BuildStep from the outer class.
protected	BuildStepDescriptor(Class<? extends T> clazz)

Method Summary

Modifier and Type	Method	Description
static <T extends BuildStep & Describable<T>> List<Descriptor<T>>	filter(List<Descriptor<T>> base, Class<? extends AbstractProject> type)	Filters a descriptor for BuildSteps by using isApplicable(Class).
abstract boolean	isApplicable(Class<? extends AbstractProject> jobType)	Returns true if this task is applicable to the given project.

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, bindJSON, bindJSON, calcAutoCompleteSettings, calcFillSettings, configure, configure, configure, doHelp, doHelp, find, find, findByDescribableClassName, findById, getCategory, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getDisplayName, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getRequiredGlobalConfigPagePermission, getStaticHelpUrl, getStaticHelpUrl, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, 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 Details

BuildStepDescriptor

protected BuildStepDescriptor(Class<? extends T> clazz)

BuildStepDescriptor

protected BuildStepDescriptor()

Infers the type of the corresponding BuildStep from the outer class. This version works when you follow the common convention, where a descriptor is written as the static nested class of the describable class.

Since:

1.278

Method Details

isApplicable

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

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

Returns:

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

See Also:

• AbstractProject.AbstractProjectDescriptor.isApplicable(Descriptor)

filter

public static <T extends BuildStep & Describable<T>>
List<Descriptor<T>> filter(List<Descriptor<T>> base,
 Class<? extends AbstractProject> type)

Filters a descriptor for BuildSteps by using isApplicable(Class).