jenkins.scm.api.trait

Class SCMTraitDescriptor<T extends SCMTrait<T>>

java.lang.Object

hudson.model.Descriptor<T>

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

All Implemented Interfaces:

Saveable, OnMaster

Direct Known Subclasses:

SCMNavigatorTraitDescriptor, SCMSourceTraitDescriptor

public abstract class SCMTraitDescriptor<T extends SCMTrait<T>>
extends Descriptor<T>

Abstract base class for Descriptor of SCMTrait 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

Method Summary

Modifier and Type	Method and Description
Class<? extends SCM>	getScmClass() Returns the type of SCM that this SCMTrait is applicable to.
boolean	isApplicableToSCM(Class<? extends SCM> scmClass) Checks if the SCMTrait is relevant to the specified type of SCM.
boolean	isApplicableToSCM(SCMDescriptor<?> scm) Checks if the SCMTrait is relevant to the specified SCM.

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

Method Detail

getScmClass

public Class<? extends SCM> getScmClass()

Returns the type of SCM that this SCMTrait is applicable to.

Returns:

the type of SCM that this SCMTrait is applicable to.

isApplicableToSCM

public boolean isApplicableToSCM(@NonNull
                                 Class<? extends SCM> scmClass)

Checks if the SCMTrait is relevant to the specified type of SCM.

Parameters:

scmClass - the type of SCM.

Returns:

true if applicable to the specified type of SCM.

isApplicableToSCM

public boolean isApplicableToSCM(@NonNull
                                 SCMDescriptor<?> scm)

Checks if the SCMTrait is relevant to the specified SCM.

Parameters:

scm - the SCMDescriptor for the type of SCM.

Returns:

true if applicable to the specified type of SCM.