Package org.jenkinsci.plugins.workflow.job

Class WorkflowJob.DescriptorImpl

java.lang.Object

hudson.model.Descriptor<TopLevelItem>

hudson.model.TopLevelItemDescriptor

org.jenkinsci.plugins.workflow.job.WorkflowJob.DescriptorImpl

All Implemented Interfaces:

Saveable, Loadable, OnMaster, IconSpec

Enclosing class:

WorkflowJob

@Extension(ordinal=1.0)
@Symbol("pipeline")
public static final class WorkflowJob.DescriptorImpl
extends TopLevelItemDescriptor

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
String	getCategoryId()	Needed if it wants Pipeline jobs are categorized in Jenkins 2.x.
Collection<org.jenkinsci.plugins.workflow.flow.FlowDefinitionDescriptor>	getDefinitionDescriptors(WorkflowJob context)	TODO JENKINS-20020 can delete this in case f:dropdownDescriptorSelector defaults to applying h.filterDescriptors
String	getDescription()	Needed if it wants Pipeline jobs are categorized in Jenkins 2.x.
String	getDisplayName()
String	getIconClassName()
String	getIconFilePathPattern()	Needed if it wants Pipeline jobs are categorized in Jenkins 2.x.
TopLevelItem	newInstance(ItemGroup parent, String name)

Methods inherited from class hudson.model.TopLevelItemDescriptor

all, checkApplicableIn, getIconFilePath, isApplicable, isApplicableIn, newInstance, newInstance, testInstance

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, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getRequiredGlobalConfigPagePermission, getStaticHelpUrl, 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 Details

DescriptorImpl

public DescriptorImpl()

Method Details

getDisplayName

@NonNull
public String getDisplayName()

Overrides:

getDisplayName in class TopLevelItemDescriptor

newInstance

public TopLevelItem newInstance(ItemGroup parent,
 String name)

Specified by:

newInstance in class TopLevelItemDescriptor

getCategoryId

@NonNull
public String getCategoryId()

Needed if it wants Pipeline jobs are categorized in Jenkins 2.x. TODO: Replace to StandaloneProjectsCategory.ID

Overrides:

getCategoryId in class TopLevelItemDescriptor

Returns:

A string it represents a ItemCategory identifier.

getDescription

@NonNull
public String getDescription()

Needed if it wants Pipeline jobs are categorized in Jenkins 2.x.

Overrides:

getDescription in class TopLevelItemDescriptor

Returns:

A string with the Item description.

getIconFilePathPattern

public String getIconFilePathPattern()

Needed if it wants Pipeline jobs are categorized in Jenkins 2.x.

Overrides:

getIconFilePathPattern in class TopLevelItemDescriptor

Returns:

A string it represents a URL pattern to get the Item icon in different sizes.

getIconClassName

public String getIconClassName()

Specified by:

getIconClassName in interface IconSpec

Overrides:

getIconClassName in class TopLevelItemDescriptor

getDefinitionDescriptors

@Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class)
public Collection<org.jenkinsci.plugins.workflow.flow.FlowDefinitionDescriptor> getDefinitionDescriptors(WorkflowJob context)

TODO JENKINS-20020 can delete this in case f:dropdownDescriptorSelector defaults to applying h.filterDescriptors