Package jenkins.scm.api.trait
Class SCMNavigatorTraitDescriptor
java.lang.Object
hudson.model.Descriptor<T>
jenkins.scm.api.trait.SCMTraitDescriptor<SCMNavigatorTrait>
jenkins.scm.api.trait.SCMNavigatorTraitDescriptor
- Direct Known Subclasses:
RegexSCMSourceFilterTrait.DescriptorImpl
,WildcardSCMSourceFilterTrait.DescriptorImpl
Abstract base class for
Descriptor
of SCMNavigatorTrait
implementations.- Since:
- 2.2.0
-
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
ModifierConstructorDescriptionprotected
Infers the type of the correspondingSCMNavigatorTrait
from the outer class.protected
SCMNavigatorTraitDescriptor
(Class<? extends SCMNavigatorTrait> clazz) Constructor to use when type inference usingSCMNavigatorTraitDescriptor()
does not work. -
Method Summary
Modifier and TypeMethodDescriptionClass<? extends SCMSourceBuilder>
Returns the type ofSCMSourceBuilder
that thisSCMNavigatorTrait
is applicable to.Class<? extends SCMNavigatorContext>
Returns the type ofSCMNavigatorContext
that thisSCMNavigatorTrait
is applicable to.Class<? extends SCMNavigator>
Returns the type ofSCMNavigator
that thisSCMNavigatorTrait
is applicable to.Returns the type ofSCMSource
that thisSCMNavigatorTrait
is applicable to.boolean
isApplicableTo
(Class<? extends SCMNavigator> navigatorClass) Checks if theSCMNavigatorTrait
is relevant to the specified type ofSCMNavigator
.boolean
isApplicableTo
(SCMNavigator navigator) Checks if theSCMNavigatorTrait
is relevant to the specifiedSCMNavigator
.boolean
isApplicableTo
(SCMNavigatorDescriptor descriptor) Checks if theSCMNavigatorTrait
is relevant to the specifiedSCMNavigatorDescriptor
.boolean
isApplicableToBuilder
(Class<? extends SCMSourceBuilder> builderClass) Checks if theSCMNavigatorTrait
is relevant to the specified type ofSCMSourceBuilder
.boolean
isApplicableToBuilder
(SCMSourceBuilder<?, ?> builder) Checks if theSCMNavigatorTrait
is relevant to the specifiedSCMSourceBuilder
.boolean
isApplicableToContext
(Class<? extends SCMNavigatorContext> contextClass) Checks if theSCMNavigatorTrait
is relevant to the specified type ofSCMNavigatorContext
.boolean
isApplicableToContext
(SCMNavigatorContext context) Checks if theSCMNavigatorTrait
is relevant to the specifiedSCMNavigatorContext
.boolean
isApplicableToSource
(Class<? extends SCMSource> sourceClass) Checks if theSCMNavigatorTrait
is relevant to the specified type ofSCMSource
.boolean
isApplicableToSource
(SCMSource source) Checks if theSCMNavigatorTrait
is relevant to the specifiedSCMSource
.boolean
isApplicableToSource
(SCMSourceDescriptor descriptor) Checks if theSCMNavigatorTrait
is relevant to the specifiedSCMSourceDescriptor
.Methods inherited from class jenkins.scm.api.trait.SCMTraitDescriptor
getScmClass, isApplicableToSCM, isApplicableToSCM
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 Details
-
SCMNavigatorTraitDescriptor
Constructor to use when type inference usingSCMNavigatorTraitDescriptor()
does not work.- Parameters:
clazz
- Pass in the type ofSCMNavigatorTrait
-
SCMNavigatorTraitDescriptor
protected SCMNavigatorTraitDescriptor()Infers the type of the correspondingSCMNavigatorTrait
from the outer class. This version works when you follow the common convention, where a descriptor is written as the static nested class of the describable class.
-
-
Method Details
-
getBuilderClass
Returns the type ofSCMSourceBuilder
that thisSCMNavigatorTrait
is applicable to.- Returns:
- the type of
SCMSourceBuilder
that thisSCMNavigatorTrait
is applicable to.
-
isApplicableToBuilder
Checks if theSCMNavigatorTrait
is relevant to the specified type ofSCMSourceBuilder
.- Parameters:
builderClass
- the type ofSCMBuilder
.- Returns:
true
if applicable to the specified type ofSCMSourceBuilder
.
-
isApplicableToBuilder
Checks if theSCMNavigatorTrait
is relevant to the specifiedSCMSourceBuilder
.- Parameters:
builder
- theSCMSourceBuilder
.- Returns:
true
if applicable to the specified type ofSCMSourceBuilder
.
-
getContextClass
Returns the type ofSCMNavigatorContext
that thisSCMNavigatorTrait
is applicable to.- Returns:
- the type of
SCMNavigatorContext
that thisSCMNavigatorTrait
is applicable to.
-
isApplicableToContext
Checks if theSCMNavigatorTrait
is relevant to the specified type ofSCMNavigatorContext
.- Parameters:
contextClass
- the type ofSCMNavigatorContext
.- Returns:
true
if applicable to the specified type ofSCMNavigatorContext
.
-
getSourceClass
Returns the type ofSCMSource
that thisSCMNavigatorTrait
is applicable to.- Returns:
- the type of
SCMSource
that thisSCMNavigatorTrait
is applicable to.
-
isApplicableToSource
Checks if theSCMNavigatorTrait
is relevant to the specified type ofSCMSource
. -
isApplicableToSource
Checks if theSCMNavigatorTrait
is relevant to the specifiedSCMSourceDescriptor
.- Parameters:
descriptor
- theSCMSourceDescriptor
.- Returns:
true
if applicable to the specifiedSCMSourceDescriptor
.
-
isApplicableToSource
Checks if theSCMNavigatorTrait
is relevant to the specifiedSCMSource
. -
isApplicableTo
Checks if theSCMNavigatorTrait
is relevant to the specified type ofSCMNavigator
.- Parameters:
navigatorClass
- the type ofSCMNavigator
.- Returns:
true
if applicable to the specified type ofSCMNavigator
.
-