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 TypeClassDescriptionclassSCMHeadMigration<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.PRONOUNReplaceable pronoun of that points to aSCMSource.Methods in jenkins.scm.api that return SCMSourceModifier and TypeMethodDescriptionstatic SCMSourceSCMSource.SourceByItem.findSource(Item item) Runs all registered implementations.default SCMSourceSCMSourceOwner.getSCMSource(String sourceId) Gets the source with the specifiedgetId().abstract SCMSourceChecks whether a given item corresponds to a particularSCMSource.final SCMSourceVariant 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 theSCMSourceinstances that this item is consuming.Methods in jenkins.scm.api with parameters of type SCMSourceModifier and TypeMethodDescriptionabstract voidAdds a source repository to be used from a new project.SCMFileSystem.Builder.build(SCMSource source, SCMHead head, SCMRevision rev) Given aSCMSource, aSCMHeadand aSCMRevisionthis method should try to build a correspondingSCMFileSysteminstance that reflects the content of the specifiedSCMHeadat 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 aSCMHeadObserversuch that the wrapped observer will only observeSCMHeadinstances mentioned in this event.Return or generate the ID for a source instance.static SCMRevisionSCMRevisionAction.getRevision(SCMSource source, Actionable actionable) default SCMSourceCriteriaSCMSourceOwner.getSCMSourceCriteria(SCMSource source) Returns the criteria for determining if a candidate head is relevant for consumption.abstract Map<SCMHead,SCMRevision> booleanTests if this event applies to the suppliedSCMSource.abstract booleanTests if this event applies to the suppliedSCMSource.static SCMFileSystemGiven aSCMSourceand aSCMHeadthis method will try to retrieve a correspondingSCMFileSysteminstance that reflects the content of the specifiedSCMHead.static SCMFileSystemSCMFileSystem.of(SCMSource source, SCMHead head, SCMRevision rev) Given aSCMSource, aSCMHeadand aSCMRevisionthis method will try to retrieve a correspondingSCMFileSysteminstance that reflects the content of the specifiedSCMHeadat the specifiedSCMRevision.voidSCMSourceOwner.onSCMSourceUpdated(SCMSource source) Deprecated.static SCMHeadSCMHeadMigration.readResolveSCMHead(SCMSource source, SCMHead head) Perform a migration.static SCMRevisionSCMHeadMigration.readResolveSCMRevision(SCMSource source, SCMRevision revision) Perform a migration.abstract booleanChecks if thisSCMFileSystem.Buildersupports the suppliedSCMSource.static booleanGiven aSCMSourcethis method will check if there is at least oneSCMFileSystemprovider capable of being instantiated.Method parameters in jenkins.scm.api with type arguments of type SCMSourceModifier and TypeMethodDescriptionstatic List<SCMHeadCategory>IteratesSCMSourceinstances collecting the unique list ofSCMHeadCategoryinstances.static Map<String,SCMHeadCategory> SCMHeadCategory.collectAndSimplify(Iterable<SCMSource> sources) Collects theSCMHeadCategoryinstances from a set ofSCMSourceinstances 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 TypeClassDescriptionclassSCMSourceBuilder<B extends SCMSourceBuilder<B,S>, S extends SCMSource> Builder for aSCMSourceinstance.classSCMSourceDecorator<B extends SCMSourceBuilder<B,S>, S extends SCMSource> A contextual decorator ofSCMSourceBuilderinstances that can be used by aSCMNavigatorTraitfor example to applySCMSourceTraits 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 ofSCMSourcethat thisSCMNavigatorTraitis applicable to.SCMSourceTraitDescriptor.getSourceClass()Returns the type ofSCMSourcethat thisSCMSourceTraitis applicable to.Methods in jenkins.scm.api.trait with parameters of type SCMSourceModifier and TypeMethodDescriptionbooleanSCMSourceTraitDescriptor.isApplicableTo(SCMSource source) Checks if theSCMSourceTraitis relevant to the specifiedSCMSource.booleanSCMNavigatorTraitDescriptor.isApplicableToSource(SCMSource source) Checks if theSCMNavigatorTraitis relevant to the specifiedSCMSource.abstract booleanSCMHeadPrefilter.isExcluded(SCMSource source, SCMHead head) abstract RSCMSourceContext.newRequest(SCMSource source, TaskListener listener) Creates a newSCMSourceRequest.Method parameters in jenkins.scm.api.trait with type arguments of type SCMSourceModifier and TypeMethodDescriptionbooleanSCMSourceTraitDescriptor.isApplicableTo(Class<? extends SCMSource> sourceClass) Checks if theSCMSourceTraitis relevant to the specified type ofSCMSource.booleanSCMNavigatorTraitDescriptor.isApplicableToSource(Class<? extends SCMSource> sourceClass) Checks if theSCMNavigatorTraitis relevant to the specified type ofSCMSource.Constructors in jenkins.scm.api.trait with parameters of type SCMSourceModifierConstructorDescriptionprotectedSCMSourceRequest(SCMSource source, SCMSourceContext<?, ?> context, TaskListener listener) Constructor. -
Uses of SCMSource in jenkins.scm.impl
Subclasses of SCMSource in jenkins.scm.implModifier and TypeClassDescriptionclassclassA 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 TypeMethodDescriptionvoidAdds a source repository to be used from a new project.booleanChecks if the supplied instance is a match for thisSCMCategory.Constructor parameters in jenkins.scm.impl with type arguments of type SCMSource
SCMSourceOwnerwould prefer theSCMEventListenerextension 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.