Uses of Class
jenkins.scm.api.SCMSource
Packages that use SCMSource
Package
Description
The public API contract of the SCM API plugin.
An API/SPI to allow the sharing of common traits between different
SCMSource
and
SCMNavigator
implementations.The common implementations of classes in the public API.
-
Uses of SCMSource in jenkins.scm.api
Classes in jenkins.scm.api with type parameters of type SCMSourceModifier and TypeClassDescriptionclass
SCMHeadMigration<S extends SCMSource,
H extends SCMHead, R extends SCMRevision> Fields in jenkins.scm.api with type parameters of type SCMSourceModifier and TypeFieldDescriptionstatic final AlternativeUiTextProvider.Message<SCMSource>
SCMSource.PRONOUN
Replaceable pronoun of that points to aSCMSource
.Methods in jenkins.scm.api that return SCMSourceModifier and TypeMethodDescriptionstatic SCMSource
SCMSource.SourceByItem.findSource
(Item item) Runs all registered implementations.default SCMSource
SCMSourceOwner.getSCMSource
(String sourceId) Gets the source with the specifiedgetId()
.abstract SCMSource
Checks whether a given item corresponds to a particularSCMSource
.final SCMSource
Variant ofsetId(String)
that can be useful for method chaining.Methods in jenkins.scm.api that return types with arguments of type SCMSourceModifier and TypeMethodDescriptionSCMSourceOwner.getSCMSources()
Returns theSCMSource
instances that this item is consuming.Methods in jenkins.scm.api with parameters of type SCMSourceModifier and TypeMethodDescriptionabstract void
Adds a source repository to be used from a new project.SCMFileSystem.Builder.build
(SCMSource source, SCMHead head, SCMRevision rev) Given aSCMSource
, aSCMHead
and aSCMRevision
this method should try to build a correspondingSCMFileSystem
instance that reflects the content of the specifiedSCMHead
at the specifiedSCMRevision
.SCMHeadEvent.descriptionFor
(SCMSource source) Return a description of the event in the context of the suppliedSCMSource
.SCMSourceEvent.descriptionFor
(SCMSource source) Return a description of the event in the context of the suppliedSCMSource
.<O extends SCMHeadObserver>
SCMHeadObserver.Wrapped<O>Wraps aSCMHeadObserver
such that the wrapped observer will only observeSCMHead
instances mentioned in this event.Return or generate the ID for a source instance.static SCMRevision
SCMRevisionAction.getRevision
(SCMSource source, Actionable actionable) default SCMSourceCriteria
SCMSourceOwner.getSCMSourceCriteria
(SCMSource source) Returns the criteria for determining if a candidate head is relevant for consumption.abstract Map<SCMHead,
SCMRevision> boolean
Tests if this event applies to the suppliedSCMSource
.abstract boolean
Tests if this event applies to the suppliedSCMSource
.static SCMFileSystem
Given aSCMSource
and aSCMHead
this method will try to retrieve a correspondingSCMFileSystem
instance that reflects the content of the specifiedSCMHead
.static SCMFileSystem
SCMFileSystem.of
(SCMSource source, SCMHead head, SCMRevision rev) Given aSCMSource
, aSCMHead
and aSCMRevision
this method will try to retrieve a correspondingSCMFileSystem
instance that reflects the content of the specifiedSCMHead
at the specifiedSCMRevision
.void
SCMSourceOwner.onSCMSourceUpdated
(SCMSource source) Deprecated.static SCMHead
SCMHeadMigration.readResolveSCMHead
(SCMSource source, SCMHead head) Perform a migration.static SCMRevision
SCMHeadMigration.readResolveSCMRevision
(SCMSource source, SCMRevision revision) Perform a migration.abstract boolean
Checks if thisSCMFileSystem.Builder
supports the suppliedSCMSource
.static boolean
Given aSCMSource
this method will check if there is at least oneSCMFileSystem
provider capable of being instantiated.Method parameters in jenkins.scm.api with type arguments of type SCMSourceModifier and TypeMethodDescriptionstatic List<SCMHeadCategory>
IteratesSCMSource
instances collecting the unique list ofSCMHeadCategory
instances.static Map<String,
SCMHeadCategory> SCMHeadCategory.collectAndSimplify
(Iterable<SCMSource> sources) Collects theSCMHeadCategory
instances from a set ofSCMSource
instances and simplifies the result.Constructors in jenkins.scm.api with parameters of type SCMSourceModifierConstructorDescriptionSCMRevisionAction
(SCMSource source, SCMRevision revision) Constructor. -
Uses of SCMSource in jenkins.scm.api.trait
Classes in jenkins.scm.api.trait with type parameters of type SCMSourceModifier and TypeClassDescriptionclass
SCMSourceBuilder<B extends SCMSourceBuilder<B,
S>, S extends SCMSource> Builder for aSCMSource
instance.class
SCMSourceDecorator<B extends SCMSourceBuilder<B,
S>, S extends SCMSource> A contextual decorator ofSCMSourceBuilder
instances that can be used by aSCMNavigatorTrait
for example to applySCMSourceTrait
s to a subset of projects.Methods in jenkins.scm.api.trait that return SCMSourceMethods in jenkins.scm.api.trait that return types with arguments of type SCMSourceModifier and TypeMethodDescriptionSCMNavigatorTraitDescriptor.getSourceClass()
Returns the type ofSCMSource
that thisSCMNavigatorTrait
is applicable to.SCMSourceTraitDescriptor.getSourceClass()
Returns the type ofSCMSource
that thisSCMSourceTrait
is applicable to.Methods in jenkins.scm.api.trait with parameters of type SCMSourceModifier and TypeMethodDescriptionboolean
SCMSourceTraitDescriptor.isApplicableTo
(SCMSource source) Checks if theSCMSourceTrait
is relevant to the specifiedSCMSource
.boolean
SCMNavigatorTraitDescriptor.isApplicableToSource
(SCMSource source) Checks if theSCMNavigatorTrait
is relevant to the specifiedSCMSource
.abstract boolean
SCMHeadPrefilter.isExcluded
(SCMSource source, SCMHead head) abstract R
SCMSourceContext.newRequest
(SCMSource source, TaskListener listener) Creates a newSCMSourceRequest
.Method parameters in jenkins.scm.api.trait with type arguments of type SCMSourceModifier and TypeMethodDescriptionboolean
SCMSourceTraitDescriptor.isApplicableTo
(Class<? extends SCMSource> sourceClass) Checks if theSCMSourceTrait
is relevant to the specified type ofSCMSource
.boolean
SCMNavigatorTraitDescriptor.isApplicableToSource
(Class<? extends SCMSource> sourceClass) Checks if theSCMNavigatorTrait
is relevant to the specified type ofSCMSource
.Constructors in jenkins.scm.api.trait with parameters of type SCMSourceModifierConstructorDescriptionprotected
SCMSourceRequest
(SCMSource source, SCMSourceContext<?, ?> context, TaskListener listener) Constructor. -
Uses of SCMSource in jenkins.scm.impl
Subclasses of SCMSource in jenkins.scm.implModifier and TypeClassDescriptionclass
class
A single fixed branch using a legacy SCM implementation.Methods in jenkins.scm.impl that return types with arguments of type SCMSourceMethods in jenkins.scm.impl with parameters of type SCMSourceModifier and TypeMethodDescriptionvoid
Adds a source repository to be used from a new project.boolean
Checks if the supplied instance is a match for thisSCMCategory
.Constructor parameters in jenkins.scm.impl with type arguments of type SCMSource
SCMSourceOwner
would prefer theSCMEventListener
extension point which allows for more fine-grained response to events, so prefer delivering event notification throughSCMHeadEvent.fireNow(SCMHeadEvent)
,SCMSourceEvent.fireNow(SCMSourceEvent)
orSCMNavigatorEvent.fireNow(SCMNavigatorEvent)
as appropriate.