Package jenkins.branch
Class BranchProjectFactoryDescriptor
- java.lang.Object
-
- hudson.model.Descriptor<BranchProjectFactory<?,?>>
-
- jenkins.branch.BranchProjectFactoryDescriptor
-
public abstract class BranchProjectFactoryDescriptor extends Descriptor<BranchProjectFactory<?,?>>
Base class for allBranchProjectFactory
instances.
-
-
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
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
BranchProjectFactoryDescriptor()
Fully inferring constructor to use when the descriptor is an inner class of theBranchProjectFactory
and type parameter inference works because it just should work.protected
BranchProjectFactoryDescriptor(Class<? extends BranchProjectFactory<?,?>> clazz)
Semi explicit constructor to use when the descriptor is not an inner class of theBranchProjectFactory
.protected
BranchProjectFactoryDescriptor(Class<? extends BranchProjectFactory<?,?>> clazz, Class<? extends Job> branchProjectClass)
Explicit constructor to use when type inference fails.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description Class<? extends Job>
getProjectClass()
Returns the base class of the projects that are produced by this factory.abstract boolean
isApplicable(Class<? extends MultiBranchProject> clazz)
Returnstrue
if and only if thisBranchPropertyDescriptor
is applicable in the specified type ofMultiBranchProject
.-
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, getDisplayName, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, 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
-
-
-
-
Constructor Detail
-
BranchProjectFactoryDescriptor
protected BranchProjectFactoryDescriptor(Class<? extends BranchProjectFactory<?,?>> clazz, Class<? extends Job> branchProjectClass)
Explicit constructor to use when type inference fails.- Parameters:
clazz
- theBranchProjectFactory
that this descriptor is for.branchProjectClass
- theJob
type that theBranchProjectFactory
creates.- Since:
- 2.0
-
BranchProjectFactoryDescriptor
protected BranchProjectFactoryDescriptor(Class<? extends BranchProjectFactory<?,?>> clazz)
Semi explicit constructor to use when the descriptor is not an inner class of theBranchProjectFactory
.- Parameters:
clazz
- theBranchProjectFactory
that this descriptor is for.- Since:
- 2.0
-
BranchProjectFactoryDescriptor
protected BranchProjectFactoryDescriptor()
Fully inferring constructor to use when the descriptor is an inner class of theBranchProjectFactory
and type parameter inference works because it just should work.- Since:
- 2.0
-
-
Method Detail
-
getProjectClass
@NonNull public Class<? extends Job> getProjectClass()
Returns the base class of the projects that are produced by this factory.- Returns:
- the base class of the projects that are produced by this factory.
- Since:
- 2.0
-
isApplicable
public abstract boolean isApplicable(Class<? extends MultiBranchProject> clazz)
Returnstrue
if and only if thisBranchPropertyDescriptor
is applicable in the specified type ofMultiBranchProject
.- Parameters:
clazz
- the type ofMultiBranchProject
.- Returns:
true
if this factory can be used in theMultiBranchProject
.
-
-