hudson.model

Class AbstractProject.AbstractProjectDescriptor

java.lang.Object

hudson.model.Descriptor<TopLevelItem>

hudson.model.TopLevelItemDescriptor

hudson.model.AbstractProject.AbstractProjectDescriptor

All Implemented Interfaces:

Saveable, OnMaster, org.jenkins.ui.icon.IconSpec

Direct Known Subclasses:

FreeStyleProject.DescriptorImpl

Enclosing class:

AbstractProject<P extends AbstractProject<P,R>,R extends AbstractBuild<P,R>>

public abstract static class AbstractProject.AbstractProjectDescriptor
extends TopLevelItemDescriptor

AbstractProject subtypes should implement this base class as a descriptor.

Since:

1.294

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 and Description
AbstractProjectDescriptor()

Method Summary

Modifier and Type	Method and Description
AutoCompletionCandidates	doAutoCompleteAssignedLabelString(String value)
AutoCompletionCandidates	doAutoCompleteLabel(String value)
AutoCompletionCandidates	doAutoCompleteUpstreamProjects(String value)
FormValidation	doCheckAssignedLabelString(AbstractProject<?,?> project, String value)
FormValidation	doCheckCustomWorkspace(String customWorkspace)
FormValidation	doCheckLabel(AbstractProject<?,?> project, String value)
List<SCMCheckoutStrategyDescriptor>	getApplicableSCMCheckoutStrategyDescriptors(AbstractProject p)
boolean	isApplicable(Descriptor descriptor) AbstractProject subtypes can override this method to veto some Descriptors from showing up on their configuration screen.
static FormValidation	validateLabelExpression(String value, AbstractProject<?,?> project) Validate label expression string.

Methods inherited from class hudson.model.TopLevelItemDescriptor

all, checkApplicableIn, getCategoryId, getDescription, getDisplayName, getIconClassName, getIconFilePath, getIconFilePathPattern, isApplicableIn, newInstance, newInstance, newInstance, testInstance

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, 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, 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

AbstractProjectDescriptor

public AbstractProjectDescriptor()

Method Detail

isApplicable

public boolean isApplicable(Descriptor descriptor)

AbstractProject subtypes can override this method to veto some Descriptors from showing up on their configuration screen. This is often useful when you are building a workflow/company specific project type, where you want to limit the number of choices given to the users.

Some Descriptors define their own schemes for controlling applicability (such as BuildStepDescriptor.isApplicable(Class)), This method works like AND in conjunction with them; Both this method and that method need to return true in order for a given Descriptor to show up for the given Project.

The default implementation returns true for everything.

Overrides:

isApplicable in class TopLevelItemDescriptor

See Also:

BuildStepDescriptor.isApplicable(Class), BuildWrapperDescriptor.isApplicable(AbstractProject), TriggerDescriptor.isApplicable(Item)

doCheckAssignedLabelString

@Restricted(value=org.kohsuke.accmod.restrictions.DoNotUse.class)
public FormValidation doCheckAssignedLabelString(@AncestorInPath
                                                                                                                   AbstractProject<?,?> project,
                                                                                                                   @QueryParameter
                                                                                                                   String value)

doCheckLabel

public FormValidation doCheckLabel(@AncestorInPath
                                   AbstractProject<?,?> project,
                                   @QueryParameter
                                   String value)

validateLabelExpression

@Nonnull
public static FormValidation validateLabelExpression(String value,
                                                              @CheckForNull
                                                              AbstractProject<?,?> project)

Validate label expression string.

Parameters:

project - May be specified to perform project specific validation.

Since:

1.590

doCheckCustomWorkspace

public FormValidation doCheckCustomWorkspace(@QueryParameter
                                             String customWorkspace)

doAutoCompleteUpstreamProjects

public AutoCompletionCandidates doAutoCompleteUpstreamProjects(@QueryParameter
                                                               String value)

doAutoCompleteAssignedLabelString

@Restricted(value=org.kohsuke.accmod.restrictions.DoNotUse.class)
public AutoCompletionCandidates doAutoCompleteAssignedLabelString(@QueryParameter
                                                                                                                                    String value)

doAutoCompleteLabel

public AutoCompletionCandidates doAutoCompleteLabel(@QueryParameter
                                                    String value)

getApplicableSCMCheckoutStrategyDescriptors

public List<SCMCheckoutStrategyDescriptor> getApplicableSCMCheckoutStrategyDescriptors(AbstractProject p)