jenkins.plugins.git.traits

Class GitSCMExtensionTraitDescriptor

java.lang.Object

hudson.model.Descriptor<T>

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

jenkins.scm.api.trait.SCMSourceTraitDescriptor

jenkins.plugins.git.traits.GitSCMExtensionTraitDescriptor

All Implemented Interfaces:

Saveable, OnMaster

Direct Known Subclasses:

AuthorInChangelogTrait.DescriptorImpl, CheckoutOptionTrait.DescriptorImpl, CleanAfterCheckoutTrait.DescriptorImpl, CleanBeforeCheckoutTrait.DescriptorImpl, CloneOptionTrait.DescriptorImpl, GitLFSPullTrait.DescriptorImpl, LocalBranchTrait.DescriptorImpl, PruneStaleBranchTrait.DescriptorImpl, PruneStaleTagTrait.DescriptorImpl, SparseCheckoutPathsTrait.DescriptorImpl, SubmoduleOptionTrait.DescriptorImpl, UserIdentityTrait.DescriptorImpl, WipeWorkspaceTrait.DescriptorImpl

public abstract class GitSCMExtensionTraitDescriptor
extends jenkins.scm.api.trait.SCMSourceTraitDescriptor

Base class for the Descriptor of a GitSCMExtension.

Since:

3.4.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	GitSCMExtensionTraitDescriptor() Infers the type of the corresponding GitSCMExtensionTrait from the outer class.
protected	GitSCMExtensionTraitDescriptor(Class<? extends jenkins.scm.api.trait.SCMSourceTrait> clazz, Class<? extends GitSCMExtension> extension) Constructor to use when type inference using GitSCMExtensionTraitDescriptor() does not work.

Method Summary

Modifier and Type	Method and Description
jenkins.scm.api.trait.SCMSourceTrait	convertToTrait(GitSCMExtension extension) Converts the supplied GitSCMExtension (which must be of type getExtensionClass()) into its corresponding GitSCMExtensionTrait.
Class<? extends jenkins.scm.api.trait.SCMBuilder>	getBuilderClass()
Class<? extends GitSCMExtension>	getExtensionClass() Returns the type of GitSCMExtension that the GitSCMExtensionTrait wraps.
GitSCMExtensionDescriptor	getExtensionDescriptor() Returns the GitSCMExtensionDescriptor for this getExtensionClass().
String	getHelpFile()
Class<? extends SCM>	getScmClass()

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

getContextClass, getSourceClass, isApplicableTo, isApplicableTo, isApplicableTo, isApplicableToBuilder, isApplicableToBuilder, isApplicableToContext, isApplicableToContext

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

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

GitSCMExtensionTraitDescriptor

protected GitSCMExtensionTraitDescriptor(Class<? extends jenkins.scm.api.trait.SCMSourceTrait> clazz,
                                         Class<? extends GitSCMExtension> extension)

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

Parameters:

clazz - Pass in the type of SCMTrait

extension - Pass in the type of GitSCMExtension.

GitSCMExtensionTraitDescriptor

protected GitSCMExtensionTraitDescriptor()

Infers the type of the corresponding GitSCMExtensionTrait 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 jenkins.scm.api.trait.SCMBuilder> getBuilderClass()

Overrides:

getBuilderClass in class jenkins.scm.api.trait.SCMSourceTraitDescriptor

getScmClass

public Class<? extends SCM> getScmClass()

Overrides:

getScmClass in class jenkins.scm.api.trait.SCMTraitDescriptor<jenkins.scm.api.trait.SCMSourceTrait>

getExtensionDescriptor

@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public GitSCMExtensionDescriptor getExtensionDescriptor()

Returns the GitSCMExtensionDescriptor for this getExtensionClass().

Returns:

the GitSCMExtensionDescriptor for this getExtensionClass().

getExtensionClass

public Class<? extends GitSCMExtension> getExtensionClass()

Returns the type of GitSCMExtension that the GitSCMExtensionTrait wraps.

Returns:

the type of GitSCMExtension that the GitSCMExtensionTrait wraps.

convertToTrait

@CheckForNull
public jenkins.scm.api.trait.SCMSourceTrait convertToTrait(@NonNull
                                                                         GitSCMExtension extension)

Converts the supplied GitSCMExtension (which must be of type getExtensionClass()) into its corresponding GitSCMExtensionTrait. The default implementation assumes that the Descriptor.clazz has a public constructor taking either no arguments or a single argument of type getExtensionClass() and will just call that. Override this method if you need more complex conversion logic, for example LocalBranch only makes sense for a LocalBranch.getLocalBranch() value of ** so LocalBranchTrait.DescriptorImpl.convertToTrait(GitSCMExtension) returns null for all other LocalBranch configurations.

Parameters:

extension - the GitSCMExtension (must be of type getExtensionClass())

Returns:

the GitSCMExtensionTrait or null if the supplied GitSCMExtension is not appropriate for conversion to a GitSCMExtensionTrait

Throws:

UnsupportedOperationException - if the conversion failed because of a implementation bug.

getHelpFile

public String getHelpFile()

Overrides:

getHelpFile in class Descriptor<jenkins.scm.api.trait.SCMSourceTrait>