Uses of Class
jenkins.scm.api.SCMSource

Packages that use SCMSource

Package	Description
jenkins.scm.api	The public API contract of the SCM API plugin.
jenkins.scm.api.trait	An API/SPI to allow the sharing of common traits between different SCMSource and SCMNavigator implementations.
jenkins.scm.impl	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 SCMSource

Modifier and Type	Class and Description
class	SCMHeadMigration<S extends SCMSource,H extends SCMHead,R extends SCMRevision> If a SCMSource plugin needs to migrate the implementation classes for SCMHead this extension point allows the plugin to register type migrations.

Fields in jenkins.scm.api with type parameters of type SCMSource

Modifier and Type	Field and Description
static AlternativeUiTextProvider.Message<SCMSource>	SCMSource.PRONOUN Replaceable pronoun of that points to a SCMSource.

Methods in jenkins.scm.api that return SCMSource

Modifier and Type	Method and Description
static SCMSource	SCMSource.SourceByItem.findSource(Item item) Runs all registered implementations.
SCMSource	SCMSourceOwner.getSCMSource(String sourceId) Gets the source with the specified getId().
abstract SCMSource	SCMSource.SourceByItem.getSource(Item item) Checks whether a given item corresponds to a particular SCMSource.
SCMSource	SCMSource.withId(String id) Variant of setId(String) that can be useful for method chaining.

Methods in jenkins.scm.api that return types with arguments of type SCMSource

Modifier and Type	Method and Description
List<SCMSource>	SCMSourceOwner.getSCMSources() Returns the SCMSource instances that this item is consuming.

Methods in jenkins.scm.api with parameters of type SCMSource

Modifier and Type	Method and Description
abstract void	SCMSourceObserver.ProjectObserver.addSource(SCMSource source) Adds a source repository to be used from a new project.
SCMFileSystem	SCMFileSystem.Builder.build(SCMSource source, SCMHead head, SCMRevision rev) Given a SCMSource, a SCMHead and a SCMRevision this method should try to build a corresponding SCMFileSystem instance that reflects the content of the specified SCMHead at the specified SCMRevision.
String	SCMHeadEvent.descriptionFor(SCMSource source) Return a description of the event in the context of the supplied SCMSource.
String	SCMSourceEvent.descriptionFor(SCMSource source) Return a description of the event in the context of the supplied SCMSource.
<O extends SCMHeadObserver> SCMHeadObserver.Wrapped<O>	SCMHeadEvent.filter(SCMSource source, O delegate) Wraps a SCMHeadObserver such that the wrapped observer will only observe SCMHead instances mentioned in this event.
String	SCMSourceDescriptor.getId(SCMSource source) Return or generate the ID for a source instance.
static SCMRevision	SCMRevisionAction.getRevision(SCMSource source, Actionable actionable) Gets the SCMRevision for the specified SCMSource from the specified Actionable.
SCMSourceCriteria	SCMSourceOwner.getSCMSourceCriteria(SCMSource source) Returns the criteria for determining if a candidate head is relevant for consumption.
abstract Map<SCMHead,SCMRevision>	SCMHeadEvent.heads(SCMSource source) Returns the SCMHead for the supplied SCMSource that this event corresponds to.
boolean	SCMHeadEvent.isMatch(SCMSource source) Tests if this event applies to the supplied SCMSource.
abstract boolean	SCMSourceEvent.isMatch(SCMSource source) Tests if this event applies to the supplied SCMSource.
static SCMFileSystem	SCMFileSystem.of(SCMSource source, SCMHead head) Given a SCMSource and a SCMHead this method will try to retrieve a corresponding SCMFileSystem instance that reflects the content of the specified SCMHead.
static SCMFileSystem	SCMFileSystem.of(SCMSource source, SCMHead head, SCMRevision rev) Given a SCMSource, a SCMHead and a SCMRevision this method will try to retrieve a corresponding SCMFileSystem instance that reflects the content of the specified SCMHead at the specified SCMRevision.
void	SCMSourceOwner.onSCMSourceUpdated(SCMSource source) Deprecated. implementations of SCMSourceOwner would prefer the SCMEventListener extension point which allows for more fine-grained response to events, so prefer delivering event notification through SCMHeadEvent.fireNow(SCMHeadEvent), SCMSourceEvent.fireNow(SCMSourceEvent) or SCMNavigatorEvent.fireNow(SCMNavigatorEvent) as appropriate.
static SCMHead	SCMHeadMigration.readResolveSCMHead(SCMSource source, SCMHead head) Perform a migration.
static SCMRevision	SCMHeadMigration.readResolveSCMRevision(SCMSource source, SCMRevision revision) Perform a migration.
static boolean	SCMFileSystem.supports(SCMSource source) Given a SCMSource this method will check if there is at least one SCMFileSystem provider capable of being instantiated.
abstract boolean	SCMFileSystem.Builder.supports(SCMSource source) Checks if this SCMFileSystem.Builder supports the supplied SCMSource.

Method parameters in jenkins.scm.api with type arguments of type SCMSource

Modifier and Type	Method and Description
static List<SCMHeadCategory>	SCMHeadCategory.collect(Iterable<SCMSource> sources) Iterates SCMSource instances collecting the unique list of SCMHeadCategory instances.
static Map<String,SCMHeadCategory>	SCMHeadCategory.collectAndSimplify(Iterable<SCMSource> sources) Collects the SCMHeadCategory instances from a set of SCMSource instances and simplifies the result.

Constructors in jenkins.scm.api with parameters of type SCMSource

Constructor and Description
SCMRevisionAction(SCMSource source, SCMRevision revision) Constructor.

Uses of SCMSource in jenkins.scm.api.trait

Classes in jenkins.scm.api.trait with type parameters of type SCMSource

Modifier and Type	Class and Description
class	SCMSourceBuilder<B extends SCMSourceBuilder<B,S>,S extends SCMSource> Builder for a SCMSource instance.
class	SCMSourceDecorator<B extends SCMSourceBuilder<B,S>,S extends SCMSource> A contextual decorator of SCMSourceBuilder instances that can be used by a SCMNavigatorTrait for example to apply SCMSourceTraits to a subset of projects.

Methods in jenkins.scm.api.trait that return SCMSource

Modifier and Type	Method and Description
SCMSource	SCMNavigatorRequest.SourceLambda.create(String projectName) Creates the SCMSource for the named project.

Methods in jenkins.scm.api.trait that return types with arguments of type SCMSource

Modifier and Type	Method and Description
Class<? extends SCMSource>	SCMSourceTraitDescriptor.getSourceClass() Returns the type of SCMSource that this SCMSourceTrait is applicable to.
Class<? extends SCMSource>	SCMNavigatorTraitDescriptor.getSourceClass() Returns the type of SCMSource that this SCMNavigatorTrait is applicable to.

Methods in jenkins.scm.api.trait with parameters of type SCMSource

Modifier and Type	Method and Description
boolean	SCMSourceTraitDescriptor.isApplicableTo(SCMSource source) Checks if the SCMSourceTrait is relevant to the specified SCMSource.
boolean	SCMNavigatorTraitDescriptor.isApplicableToSource(SCMSource source) Checks if the SCMNavigatorTrait is relevant to the specified SCMSource.
abstract boolean	SCMHeadPrefilter.isExcluded(SCMSource source, SCMHead head) Checks if the supplied SCMHead is excluded from the specified SCMSource.
abstract R	SCMSourceContext.newRequest(SCMSource source, TaskListener listener) Creates a new SCMSourceRequest.

Method parameters in jenkins.scm.api.trait with type arguments of type SCMSource

Modifier and Type	Method and Description
boolean	SCMSourceTraitDescriptor.isApplicableTo(Class<? extends SCMSource> sourceClass) Checks if the SCMSourceTrait is relevant to the specified type of SCMSource.
boolean	SCMNavigatorTraitDescriptor.isApplicableToSource(Class<? extends SCMSource> sourceClass) Checks if the SCMNavigatorTrait is relevant to the specified type of SCMSource.

Constructors in jenkins.scm.api.trait with parameters of type SCMSource

Constructor and Description
SCMSourceRequest(SCMSource source, SCMSourceContext<?,?> context, TaskListener listener) Constructor.

Uses of SCMSource in jenkins.scm.impl

Subclasses of SCMSource in jenkins.scm.impl

Modifier and Type	Class and Description
class	NullSCMSource A special SCMSource that does not fetch any SCMHead instances and will build instances of NullSCM.
class	SingleSCMSource A single fixed branch using a legacy SCM implementation.

Methods in jenkins.scm.impl that return types with arguments of type SCMSource

Modifier and Type	Method and Description
List<SCMSource>	SingleSCMNavigator.getSources()

Methods in jenkins.scm.impl with parameters of type SCMSource

Modifier and Type	Method and Description
void	NoOpProjectObserver.addSource(SCMSource source) Adds a source repository to be used from a new project.
boolean	UncategorizedSCMSourceCategory.isMatch(SCMSource instance) Checks if the supplied instance is a match for this SCMCategory.

Constructor parameters in jenkins.scm.impl with type arguments of type SCMSource

Constructor and Description
SingleSCMNavigator(String name, List<SCMSource> sources)