jenkins.scm.api.trait

Class SCMNavigatorTraitDescriptor

java.lang.Object

hudson.model.Descriptor<T>

jenkins.scm.api.trait.SCMTraitDescriptor<SCMNavigatorTrait>

jenkins.scm.api.trait.SCMNavigatorTraitDescriptor

All Implemented Interfaces:

Saveable, OnMaster

Direct Known Subclasses:

RegexSCMSourceFilterTrait.DescriptorImpl, WildcardSCMSourceFilterTrait.DescriptorImpl

public abstract class SCMNavigatorTraitDescriptor
extends SCMTraitDescriptor<SCMNavigatorTrait>

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

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SCMNavigatorTraitDescriptor() Infers the type of the corresponding SCMNavigatorTrait from the outer class.
protected	SCMNavigatorTraitDescriptor(Class<? extends SCMNavigatorTrait> clazz) Constructor to use when type inference using SCMNavigatorTraitDescriptor() does not work.

Method Summary

Modifier and Type	Method and Description
Class<? extends SCMSourceBuilder>	getBuilderClass() Returns the type of SCMSourceBuilder that this SCMNavigatorTrait is applicable to.
Class<? extends SCMNavigatorContext>	getContextClass() Returns the type of SCMNavigatorContext that this SCMNavigatorTrait is applicable to.
Class<? extends SCMNavigator>	getNavigatorClass() Returns the type of SCMNavigator that this SCMNavigatorTrait is applicable to.
Class<? extends SCMSource>	getSourceClass() Returns the type of SCMSource that this SCMNavigatorTrait is applicable to.
boolean	isApplicableTo(Class<? extends SCMNavigator> navigatorClass) Checks if the SCMNavigatorTrait is relevant to the specified type of SCMNavigator.
boolean	isApplicableTo(SCMNavigator navigator) Checks if the SCMNavigatorTrait is relevant to the specified SCMNavigator.
boolean	isApplicableTo(SCMNavigatorDescriptor descriptor) Checks if the SCMNavigatorTrait is relevant to the specified SCMNavigatorDescriptor.
boolean	isApplicableToBuilder(Class<? extends SCMSourceBuilder> builderClass) Checks if the SCMNavigatorTrait is relevant to the specified type of SCMSourceBuilder.
boolean	isApplicableToBuilder(SCMSourceBuilder<?,?> builder) Checks if the SCMNavigatorTrait is relevant to the specified SCMSourceBuilder.
boolean	isApplicableToContext(Class<? extends SCMNavigatorContext> contextClass) Checks if the SCMNavigatorTrait is relevant to the specified type of SCMNavigatorContext.
boolean	isApplicableToContext(SCMNavigatorContext context) Checks if the SCMNavigatorTrait is relevant to the specified SCMNavigatorContext.
boolean	isApplicableToSource(Class<? extends SCMSource> sourceClass) Checks if the SCMNavigatorTrait is relevant to the specified type of SCMSource.
boolean	isApplicableToSource(SCMSource source) Checks if the SCMNavigatorTrait is relevant to the specified SCMSource.
boolean	isApplicableToSource(SCMSourceDescriptor descriptor) Checks if the SCMNavigatorTrait is relevant to the specified SCMSourceDescriptor.

Methods inherited from class jenkins.scm.api.trait.SCMTraitDescriptor

getScmClass, isApplicableToSCM, isApplicableToSCM

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

SCMNavigatorTraitDescriptor

protected SCMNavigatorTraitDescriptor(@NonNull
                                      Class<? extends SCMNavigatorTrait> clazz)

Constructor to use when type inference using SCMNavigatorTraitDescriptor() does not work.

Parameters:

clazz - Pass in the type of SCMNavigatorTrait

SCMNavigatorTraitDescriptor

protected SCMNavigatorTraitDescriptor()

Infers the type of the corresponding SCMNavigatorTrait 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 Detail

getBuilderClass

public Class<? extends SCMSourceBuilder> getBuilderClass()

Returns the type of SCMSourceBuilder that this SCMNavigatorTrait is applicable to.

Returns:

the type of SCMSourceBuilder that this SCMNavigatorTrait is applicable to.

isApplicableToBuilder

public boolean isApplicableToBuilder(@NonNull
                                     Class<? extends SCMSourceBuilder> builderClass)

Checks if the SCMNavigatorTrait is relevant to the specified type of SCMSourceBuilder.

Parameters:

builderClass - the type of SCMBuilder.

Returns:

true if applicable to the specified type of SCMSourceBuilder.

isApplicableToBuilder

public boolean isApplicableToBuilder(@NonNull
                                     SCMSourceBuilder<?,?> builder)

Checks if the SCMNavigatorTrait is relevant to the specified SCMSourceBuilder.

Parameters:

builder - the SCMSourceBuilder.

Returns:

true if applicable to the specified type of SCMSourceBuilder.

getContextClass

public Class<? extends SCMNavigatorContext> getContextClass()

Returns the type of SCMNavigatorContext that this SCMNavigatorTrait is applicable to.

Returns:

the type of SCMNavigatorContext that this SCMNavigatorTrait is applicable to.

isApplicableToContext

public boolean isApplicableToContext(@NonNull
                                     Class<? extends SCMNavigatorContext> contextClass)

Checks if the SCMNavigatorTrait is relevant to the specified type of SCMNavigatorContext.

Parameters:

contextClass - the type of SCMNavigatorContext.

Returns:

true if applicable to the specified type of SCMNavigatorContext.

isApplicableToContext

public boolean isApplicableToContext(@NonNull
                                     SCMNavigatorContext context)

Checks if the SCMNavigatorTrait is relevant to the specified SCMNavigatorContext.

Parameters:

context - the SCMNavigatorContext.

Returns:

true if applicable to the specified type of SCMNavigatorContext.

getSourceClass

public Class<? extends SCMSource> getSourceClass()

Returns the type of SCMSource that this SCMNavigatorTrait is applicable to.

Returns:

the type of SCMSource that this SCMNavigatorTrait is applicable to.

isApplicableToSource

public boolean isApplicableToSource(@NonNull
                                    Class<? extends SCMSource> sourceClass)

Checks if the SCMNavigatorTrait is relevant to the specified type of SCMSource.

Parameters:

sourceClass - the type of SCMSource.

Returns:

true if applicable to the specified type of SCMSource.

isApplicableToSource

public boolean isApplicableToSource(@NonNull
                                    SCMSourceDescriptor descriptor)

Checks if the SCMNavigatorTrait is relevant to the specified SCMSourceDescriptor.

Parameters:

descriptor - the SCMSourceDescriptor.

Returns:

true if applicable to the specified SCMSourceDescriptor.

isApplicableToSource

public boolean isApplicableToSource(@NonNull
                                    SCMSource source)

Checks if the SCMNavigatorTrait is relevant to the specified SCMSource.

Parameters:

source - the SCMSource.

Returns:

true if applicable to the specified SCMSource.

getNavigatorClass

public Class<? extends SCMNavigator> getNavigatorClass()

Returns the type of SCMNavigator that this SCMNavigatorTrait is applicable to.

Returns:

the type of SCMNavigator that this SCMNavigatorTrait is applicable to.

isApplicableTo

public boolean isApplicableTo(@NonNull
                              Class<? extends SCMNavigator> navigatorClass)

Checks if the SCMNavigatorTrait is relevant to the specified type of SCMNavigator.

Parameters:

navigatorClass - the type of SCMNavigator.

Returns:

true if applicable to the specified type of SCMNavigator.

isApplicableTo

public boolean isApplicableTo(@NonNull
                              SCMNavigatorDescriptor descriptor)

Checks if the SCMNavigatorTrait is relevant to the specified SCMNavigatorDescriptor.

Parameters:

descriptor - the SCMNavigatorDescriptor.

Returns:

true if applicable to the specified SCMNavigatorDescriptor.

isApplicableTo

public boolean isApplicableTo(@NonNull
                              SCMNavigator navigator)

Checks if the SCMNavigatorTrait is relevant to the specified SCMNavigator.

Parameters:

navigator - the SCMNavigator.

Returns:

true if applicable to the specified SCMNavigator.