Package jenkins.branch

Class BranchProjectFactoryDescriptor

java.lang.Object

hudson.model.Descriptor<BranchProjectFactory<?,?>>

jenkins.branch.BranchProjectFactoryDescriptor

All Implemented Interfaces:

Saveable, Loadable, OnMaster

public abstract class BranchProjectFactoryDescriptor
extends Descriptor<BranchProjectFactory<?,?>>

Base class for all BranchProjectFactory 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

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BranchProjectFactoryDescriptor()	Fully inferring constructor to use when the descriptor is an inner class of the BranchProjectFactory 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 the BranchProjectFactory.
protected	BranchProjectFactoryDescriptor(Class<? extends BranchProjectFactory<?,?>> clazz, Class<? extends Job> branchProjectClass)	Explicit constructor to use when type inference fails.

Method Summary

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)	Returns true if and only if this BranchPropertyDescriptor is applicable in the specified type of MultiBranchProject.

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

BranchProjectFactoryDescriptor

protected BranchProjectFactoryDescriptor(Class<? extends BranchProjectFactory<?,?>> clazz,
 Class<? extends Job> branchProjectClass)

Explicit constructor to use when type inference fails.

Parameters:

clazz - the BranchProjectFactory that this descriptor is for.

branchProjectClass - the Job type that the BranchProjectFactory 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 the BranchProjectFactory.

Parameters:

clazz - the BranchProjectFactory that this descriptor is for.

Since:

2.0

BranchProjectFactoryDescriptor

protected BranchProjectFactoryDescriptor()

Fully inferring constructor to use when the descriptor is an inner class of the BranchProjectFactory and type parameter inference works because it just should work.

Since:

2.0

Method Details

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)

Returns true if and only if this BranchPropertyDescriptor is applicable in the specified type of MultiBranchProject.

Parameters:

clazz - the type of MultiBranchProject.

Returns:

true if this factory can be used in the MultiBranchProject.