Package jenkins.branch

Class BranchPropertyDescriptor

java.lang.Object

hudson.model.Descriptor<BranchProperty>

jenkins.branch.BranchPropertyDescriptor

All Implemented Interfaces:

Saveable, OnMaster

Direct Known Subclasses:

BuildRetentionBranchProperty.DescriptorImpl, NoTriggerBranchProperty.DescriptorImpl, RateLimitBranchProperty.DescriptorImpl, UntrustedBranchProperty.DescriptorImpl

public abstract class BranchPropertyDescriptor
extends Descriptor<BranchProperty>

Descriptor for BranchProperty.

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BranchPropertyDescriptor.Visibility	Ensures that the configuration screen of (for example) DefaultBranchPropertyStrategy shows only appropriate descriptors.

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

Method Summary

Modifier and Type	Method	Description
static List<BranchPropertyDescriptor>	all()	All the registered BranchPropertyDescriptors.
static List<BranchPropertyDescriptor>	all(MultiBranchProject project)	Gets all the BranchPropertyDescriptor instances applicable to the specified project.
boolean	isApplicable(MultiBranchProject project)	A branch property may not be appropriate for every project, this method lets a property opt out of being selectable for a specific project.
protected boolean	isApplicable(MultiBranchProjectDescriptor projectDescriptor)	Usually a branch property is more concerned with the specific type of project than the specifics of the project instance.

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BranchPropertyDescriptor

public BranchPropertyDescriptor()

Method Detail

isApplicable

public boolean isApplicable(@NonNull
                            MultiBranchProject project)

A branch property may not be appropriate for every project, this method lets a property opt out of being selectable for a specific project.

Parameters:

project - the project.

Returns:

true iff this property is relevant with this project instance.

isApplicable

protected boolean isApplicable(@NonNull
                               MultiBranchProjectDescriptor projectDescriptor)

Usually a branch property is more concerned with the specific type of project than the specifics of the project instance.

Parameters:

projectDescriptor - the project type.

Returns:

true iff this property is relevant with this project type.

all

public static List<BranchPropertyDescriptor> all()

All the registered BranchPropertyDescriptors.

Returns:

All the registered BranchPropertyDescriptors.

all

public static List<BranchPropertyDescriptor> all(@NonNull
                                                 MultiBranchProject project)

Gets all the BranchPropertyDescriptor instances applicable to the specified project. Probably unused.

Parameters:

project - the project

Returns:

all the BranchPropertyDescriptor instances applicable to the specified project.