jenkins.branch

Class MultiBranchProjectDescriptor

java.lang.Object

hudson.model.Descriptor<hudson.model.TopLevelItem>

hudson.model.TopLevelItemDescriptor

com.cloudbees.hudson.plugins.folder.AbstractFolderDescriptor

jenkins.branch.MultiBranchProjectDescriptor

All Implemented Interfaces:

hudson.model.Saveable

public abstract class MultiBranchProjectDescriptor
extends com.cloudbees.hudson.plugins.folder.AbstractFolderDescriptor

The Descriptor for MultiBranchProjects.

Compatible SCMs displayed by SingleSCMSource (via their SCMDescriptor) can be defined by overriding TopLevelItemDescriptor.isApplicable(Descriptor):

 @Override
 public boolean isApplicable(Descriptor descriptor) {
     if (descriptor instanceof SCMDescriptor) {
         SCMDescriptor d = (SCMDescriptor) descriptor;
         // Your logic
     }
     return super.isApplicable(descriptor);
 }
 

Author:

Stephen Connolly

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
MultiBranchProjectDescriptor()

Method Summary

Modifier and Type	Method and Description
hudson.model.Descriptor<BranchSource>	getBranchSourceDescriptor() Returns the BranchSource.DescriptorImpl.
Class<? extends MultiBranchProject>	getClazz() We have to extend TopLevelItemDescriptor but we want to be able to access Descriptor.clazz as a MultiBranchProject based type.
List<BranchProjectFactoryDescriptor>	getProjectFactoryDescriptors() Returns the BranchProjectFactoryDescriptors.
List<jenkins.scm.api.SCMSourceDescriptor>	getSCMSourceDescriptors(boolean onlyUserInstantiable) Gets the SCMSourceDescriptors.

Methods inherited from class com.cloudbees.hudson.plugins.folder.AbstractFolderDescriptor

getCategoryId, getDisplayName, getHealthMetricDescriptors, getPropertyDescriptors

Methods inherited from class hudson.model.TopLevelItemDescriptor

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

Methods inherited from class hudson.model.Descriptor

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

MultiBranchProjectDescriptor

public MultiBranchProjectDescriptor()

Method Detail

getClazz

@NonNull
public Class<? extends MultiBranchProject> getClazz()

We have to extend TopLevelItemDescriptor but we want to be able to access Descriptor.clazz as a MultiBranchProject based type.

Returns:

the Descriptor.clazz

getSCMSourceDescriptors

@NonNull
public List<jenkins.scm.api.SCMSourceDescriptor> getSCMSourceDescriptors(boolean onlyUserInstantiable)

Gets the SCMSourceDescriptors.

Parameters:

onlyUserInstantiable - true retains only those SCMSource types that are instantiable by the user.

Returns:

the list of SCMSourceDescriptors.

getProjectFactoryDescriptors

@NonNull
public List<BranchProjectFactoryDescriptor> getProjectFactoryDescriptors()

Returns the BranchProjectFactoryDescriptors.

Returns:

the BranchProjectFactoryDescriptors.

getBranchSourceDescriptor

@NonNull
public hudson.model.Descriptor<BranchSource> getBranchSourceDescriptor()

Returns the BranchSource.DescriptorImpl.

Returns:

the BranchSource.DescriptorImpl.