jenkins.scm.api.trait

Class SCMSourceTraitDescriptor

java.lang.Object

hudson.model.Descriptor<T>

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

jenkins.scm.api.trait.SCMSourceTraitDescriptor

All Implemented Interfaces:

Saveable, OnMaster

Direct Known Subclasses:

RegexSCMHeadFilterTrait.DescriptorImpl, WildcardSCMHeadFilterTrait.DescriptorImpl

public abstract class SCMSourceTraitDescriptor
extends SCMTraitDescriptor<SCMSourceTrait>

Abstract base class for Descriptor of SCMSourceTrait 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	SCMSourceTraitDescriptor() Infers the type of the corresponding SCMSourceTrait from the outer class.
protected	SCMSourceTraitDescriptor(Class<? extends SCMSourceTrait> clazz) Constructor to use when type inference using SCMSourceTraitDescriptor() does not work.

Method Summary

Modifier and Type	Method and Description
Class<? extends SCMBuilder>	getBuilderClass() Returns the type of SCMBuilder that this SCMSourceTrait is applicable to.
Class<? extends SCMSourceContext>	getContextClass() Returns the type of SCMSourceContext that this SCMSourceTrait is applicable to.
Class<? extends SCMSource>	getSourceClass() Returns the type of SCMSource that this SCMSourceTrait is applicable to.
boolean	isApplicableTo(Class<? extends SCMSource> sourceClass) Checks if the SCMSourceTrait is relevant to the specified type of SCMSource.
boolean	isApplicableTo(SCMSource source) Checks if the SCMSourceTrait is relevant to the specified SCMSource.
boolean	isApplicableTo(SCMSourceDescriptor descriptor) Checks if the SCMSourceTrait is relevant to the specified SCMSourceDescriptor.
boolean	isApplicableToBuilder(Class<? extends SCMBuilder> builderClass) Checks if the SCMSourceTrait is relevant to the specified type of SCMBuilder.
boolean	isApplicableToBuilder(SCMBuilder<?,?> builder) Checks if the SCMSourceTrait is relevant to the specified SCMBuilder.
boolean	isApplicableToContext(Class<? extends SCMSourceContext> contextClass) Checks if the SCMSourceTrait is relevant to the specified type of SCMSourceContext.
boolean	isApplicableToContext(SCMSourceContext context) Checks if the SCMSourceTrait is relevant to the specified SCMSourceContext.

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

SCMSourceTraitDescriptor

protected SCMSourceTraitDescriptor(@NonNull
                                   Class<? extends SCMSourceTrait> clazz)

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

Parameters:

clazz - Pass in the type of SCMTrait

SCMSourceTraitDescriptor

protected SCMSourceTraitDescriptor()

Infers the type of the corresponding SCMSourceTrait 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 SCMBuilder> getBuilderClass()

Returns the type of SCMBuilder that this SCMSourceTrait is applicable to.

Returns:

the type of SCMBuilder that this SCMSourceTrait is applicable to.

isApplicableToBuilder

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

Checks if the SCMSourceTrait is relevant to the specified type of SCMBuilder.

Parameters:

builderClass - the type of SCMBuilder.

Returns:

true if applicable to the specified type of SCMBuilder.

isApplicableToBuilder

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

Checks if the SCMSourceTrait is relevant to the specified SCMBuilder.

Parameters:

builder - the SCMBuilder.

Returns:

true if applicable to the specified type of SCMBuilder.

getContextClass

public Class<? extends SCMSourceContext> getContextClass()

Returns the type of SCMSourceContext that this SCMSourceTrait is applicable to.

Returns:

the type of SCMSourceContext that this SCMSourceTrait is applicable to.

isApplicableToContext

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

Checks if the SCMSourceTrait is relevant to the specified type of SCMSourceContext.

Parameters:

contextClass - the type of SCMSourceContext.

Returns:

true if applicable to the specified type of SCMSourceContext.

isApplicableToContext

public boolean isApplicableToContext(@NonNull
                                     SCMSourceContext context)

Checks if the SCMSourceTrait is relevant to the specified SCMSourceContext.

Parameters:

context - the SCMSourceContext.

Returns:

true if applicable to the specified type of SCMSourceContext.

getSourceClass

public Class<? extends SCMSource> getSourceClass()

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

Returns:

the type of SCMSource that this SCMSourceTrait is applicable to.

isApplicableTo

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

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

Parameters:

sourceClass - the type of SCMSource.

Returns:

true if applicable to the specified type of SCMSource.

isApplicableTo

public boolean isApplicableTo(@NonNull
                              SCMSourceDescriptor descriptor)

Checks if the SCMSourceTrait is relevant to the specified SCMSourceDescriptor.

Parameters:

descriptor - the SCMSourceDescriptor.

Returns:

true if applicable to the specified SCMSourceDescriptor.

isApplicableTo

public boolean isApplicableTo(@NonNull
                              SCMSource source)

Checks if the SCMSourceTrait is relevant to the specified SCMSource.

Parameters:

source - the SCMSource.

Returns:

true if applicable to the specified SCMSource.