Uses of Class
jenkins.scm.api.SCMRevision

Packages that use SCMRevision

Package	Description
jenkins.scm.api	The public API contract of the SCM API plugin.
jenkins.scm.api.mixin	The mix-in interfaces used by SCMHead implementations to advertise that a specific head is not just a regular branch but is actually a special type of branch such as a change request / tag / etc.
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 SCMRevision in jenkins.scm.api

Classes in jenkins.scm.api with type parameters of type SCMRevision

Modifier and Type	Class	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.

Methods in jenkins.scm.api that return SCMRevision

Modifier and Type	Method	Description
final SCMRevision	SCMSource.fetch(String thingName, TaskListener listener)	Deprecated. rather call SCMSource.fetch(String, TaskListener, Item)
final SCMRevision	SCMSource.fetch(String thingName, TaskListener listener, Item context)	Looks up a specific thingName based on some SCM-specific set of permissible syntaxes.
final SCMRevision	SCMSource.fetch(SCMHead head, TaskListener listener)	Gets the current head revision of the specified head.
SCMRevision	SCMFileSystem.getRevision()	If this inspector is looking at the specific commit, returns that revision.
SCMRevision	SCMHeadObserver.Any.getRevision()	Returns the result.
SCMRevision	SCMRevisionAction.getRevision()	Gets the SCMRevision.
static SCMRevision	SCMRevisionAction.getRevision(Actionable actionable)	Deprecated. use SCMRevisionAction.getRevision(SCMSource, Actionable)
static SCMRevision	SCMRevisionAction.getRevision(SCMSource source, Actionable actionable)	Gets the SCMRevision for the specified SCMSource from the specified Actionable.
SCMRevision	SCMSource.getTrustedRevision(SCMRevision revision, TaskListener listener)	Enables a source to request that an alternative revision be used to obtain security-sensitive build instructions.
SCMRevision	SCMHeadMigration.migrate(S source, R revision)	Perform a migration.
static SCMRevision	SCMHeadMigration.readResolveSCMRevision(SCMSource source, SCMRevision revision)	Perform a migration.
SCMRevision	SCMHeadObserver.Any.result()	Returns the result.
SCMRevision	SCMHeadObserver.Named.result()	Returns the result.
SCMRevision	SCMHeadObserver.Selector.result()	Returns the result.
protected SCMRevision	SCMSource.retrieve(String thingName, TaskListener listener)	Deprecated. rather override SCMSource.retrieve(String, TaskListener, Item)
protected SCMRevision	SCMSource.retrieve(String thingName, TaskListener listener, Item context)	SPI: Looks up a specific revision based on some SCM-specific set of permissible syntaxes.
protected SCMRevision	SCMSource.retrieve(SCMHead head, TaskListener listener)	SPI: Gets the current head revision of the specified head.

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

Modifier and Type	Method	Description
abstract Map<SCMHead,SCMRevision>	SCMHeadEvent.heads(SCMSource source)	Returns the SCMHead for the supplied SCMSource that this event corresponds to.
Map<SCMHead,SCMRevision>	SCMSource.parentHeads(SCMHead head, TaskListener listener)	Looks up the immediate parent heads of the specified head within the specified source.
Set<SCMRevision>	SCMSource.parentRevisions(SCMHead head, SCMRevision revision, TaskListener listener)	Looks up the immediate parent revision(s) of the specified revision within the specified head.
Map<SCMHead,SCMRevision>	SCMHeadObserver.Collector.result()	Returns the collected results.

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

Modifier and Type	Method	Description
SCMFileSystem	SCMFileSystem.Builder.build(Item owner, SCM scm, SCMRevision rev)	Given a SCM this should try to build a corresponding SCMFileSystem instance that reflects the content at the specified SCMRevision.
SCMFileSystem	SCMFileSystem.Builder.build(Item owner, SCM scm, SCMRevision rev, Run<?,?> _build)	Given a SCM this should try to build a corresponding SCMFileSystem instance that reflects the content at the specified SCMRevision.
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.
abstract SCM	SCMSource.build(SCMHead head, SCMRevision revision)	Builds a SCM instance for the specified head and revision, no validation of the head is performed, a revision for a different head or source will be treated as equivalent to a null revision.
boolean	SCMFileSystem.changesSince(SCMRevision revision, OutputStream changeLogStream)	Writes the changes between the specified revision and SCMFileSystem.getRevision() in the format compatible with the SCM from this SCMFileSystem.of(Item, SCM) to the supplied OutputStream.
protected SCMProbe	SCMSource.createProbe(SCMHead head, SCMRevision revision)	Creates a SCMProbe for the specified SCMHead and SCMRevision.
final List<Action>	SCMSource.fetchActions(SCMRevision revision, SCMHeadEvent event, TaskListener listener)	Fetches any actions that should be persisted for objects related to the specified revision.
protected final SCMProbe	SCMSource.fromSCMFileSystem(SCMHead head, SCMRevision revision)	Helper method for subclasses that have implemented a SCMFileSystem.Builder and want to use a simple non-caching SCMProbe based off of the SCMFileSystem.
SCMRevision	SCMSource.getTrustedRevision(SCMRevision revision, TaskListener listener)	Enables a source to request that an alternative revision be used to obtain security-sensitive build instructions.
final SCMProbe	SCMSource.newProbe(SCMHead head, SCMRevision revision)	Creates a SCMProbe for the specified SCMHead and SCMRevision.
void	SCMHeadObserver.AllFinished.observe(SCMHead head, SCMRevision revision)	Observes a head and current revision.
void	SCMHeadObserver.Any.observe(SCMHead head, SCMRevision revision)	Observes a head and current revision.
void	SCMHeadObserver.Collector.observe(SCMHead head, SCMRevision revision)	Observes a head and current revision.
void	SCMHeadObserver.Filter.observe(SCMHead head, SCMRevision revision)	Observes a head and current revision.
void	SCMHeadObserver.Named.observe(SCMHead head, SCMRevision revision)	Observes a head and current revision.
void	SCMHeadObserver.None.observe(SCMHead head, SCMRevision revision)	Observes a head and current revision.
abstract void	SCMHeadObserver.observe(SCMHead head, SCMRevision revision)	Observes a head and current revision.
void	SCMHeadObserver.OneFinished.observe(SCMHead head, SCMRevision revision)	Observes a head and current revision.
void	SCMHeadObserver.Selector.observe(SCMHead head, SCMRevision revision)	Observes a head and current revision.
void	SCMHeadObserver.Wrapped.observe(SCMHead head, SCMRevision revision)	Observes a head and current revision.
static SCMFileSystem	SCMFileSystem.of(Item owner, SCM scm, SCMRevision rev)	Given a SCM this method will try to retrieve a corresponding SCMFileSystem instance that reflects the content at the specified SCMRevision.
static SCMFileSystem	SCMFileSystem.of(Item owner, SCM scm, SCMRevision rev, Run<?,?> build)	Given a SCM this method will try to retrieve a corresponding SCMFileSystem instance that reflects the content at the specified SCMRevision.
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.
Set<SCMRevision>	SCMSource.parentRevisions(SCMHead head, SCMRevision revision, TaskListener listener)	Looks up the immediate parent revision(s) of the specified revision within the specified head.
static SCMRevision	SCMHeadMigration.readResolveSCMRevision(SCMSource source, SCMRevision revision)	Perform a migration.
protected List<Action>	SCMSource.retrieveActions(SCMRevision revision, SCMHeadEvent event, TaskListener listener)	SPI for SCMSource.fetchActions(SCMRevision, SCMHeadEvent, TaskListener).

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

Modifier	Constructor	Description
protected	SCMFileSystem(SCMRevision rev)	Constructor.
	SCMRevisionAction(SCMRevision revision)	Deprecated. use SCMRevisionAction(SCMSource, SCMRevision)
	SCMRevisionAction(SCMSource source, SCMRevision revision)	Constructor.

Uses of SCMRevision in jenkins.scm.api.mixin

Subclasses of SCMRevision in jenkins.scm.api.mixin

Modifier and Type	Class	Description
class	ChangeRequestSCMRevision<H extends SCMHead & ChangeRequestSCMHead>	Recommended base class for the SCMRevision of a ChangeRequestSCMHead.

Methods in jenkins.scm.api.mixin that return SCMRevision

Modifier and Type	Method	Description
final SCMRevision	ChangeRequestSCMRevision.getTarget()	Returns the revision of the ChangeRequestSCMHead.getTarget() that this ChangeRequestSCMHead is associated with.

Constructors in jenkins.scm.api.mixin with parameters of type SCMRevision

Modifier	Constructor	Description
protected	ChangeRequestSCMRevision(H head, SCMRevision target)	Constructor.

Uses of SCMRevision in jenkins.scm.api.trait

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

Modifier and Type	Class	Description
class	SCMHeadAuthority<S extends SCMSourceRequest,H extends SCMHeadMixin,R extends SCMRevision>	Abstraction to allow pluggable definitions of trust for SCMHead and SCMRevision instances in the context of a specific SCMSourceRequest.
static interface	SCMSourceRequest.LazyRevisionLambda<H extends SCMHead,R extends SCMRevision,I>	A lambda that will create the SCMRevision instance for a specific SCMHead using the intermediate value produced by a SCMSourceRequest.IntermediateLambda.
static interface	SCMSourceRequest.RevisionLambda<H extends SCMHead,R extends SCMRevision>	A lambda that will create the SCMRevision instance for a specific SCMHead.
static interface	SCMSourceRequest.Witness<H extends SCMHead,R extends SCMRevision>	Callback lambda to track the results of SCMSourceRequest.process(SCMHead, IntermediateLambda, ProbeLambda, LazyRevisionLambda, Witness[])

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

Modifier and Type	Method	Description
final <H extends SCMHead, I, R extends SCMRevision> boolean	SCMSourceRequest.process(H head, SCMSourceRequest.IntermediateLambda<I> intermediateFactory, SCMSourceRequest.ProbeLambda<H,I> probeFactory, SCMSourceRequest.LazyRevisionLambda<H,R,I> revisionFactory, SCMSourceRequest.Witness... witnesses)	Processes a head in the context of the current request where an intermediary operation is required before the SCMRevision can be instantiated.
final <H extends SCMHead, R extends SCMRevision> boolean	SCMSourceRequest.process(H head, SCMSourceRequest.RevisionLambda<H,R> revisionFactory, SCMSourceRequest.ProbeLambda<H,R> probeFactory, SCMSourceRequest.Witness... witnesses)	Processes a head in the context of the current request.
final <H extends SCMHead, R extends SCMRevision> boolean	SCMSourceRequest.process(H head, R revision, SCMSourceRequest.ProbeLambda<H,R> probeFactory, SCMSourceRequest.Witness... witnesses)	Processes a head in the context of the current request.

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

Modifier and Type	Method	Description
final SCMRevision	SCMBuilder.revision()	Returns the SCMRevision to produce the SCM for or null to produce the SCM for the head revision.

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

Modifier and Type	Method	Description
final boolean	SCMHeadAuthority.isApplicableTo(SCMRevision revision)	Checks if this authority is relevant to the supplied SCMRevision.
boolean	SCMHeadAuthorityDescriptor.isApplicableToRevision(SCMRevision revision)	Checks if this SCMHeadAuthorityDescriptor is applicable to the supplied SCMRevision.
final boolean	SCMHeadAuthority.isTrusted(SCMSourceRequest request, SCMRevision revision)	Checks if the supplied SCMRevision is trusted in the context of the specified SCMSourceRequest.
final B	SCMBuilder.withRevision(SCMRevision revision)	Replace the SCMBuilder.revision() with a new SCMRevision

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

Modifier and Type	Method	Description
boolean	SCMHeadAuthorityDescriptor.isApplicableToRevision(Class<? extends SCMRevision> revisionClass)	Checks if this SCMHeadAuthorityDescriptor is applicable to the supplied type of SCMRevision.

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

Modifier	Constructor	Description
	SCMBuilder(Class<S> clazz, SCMHead head, SCMRevision revision)	Constructor.

Uses of SCMRevision in jenkins.scm.impl

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

Modifier and Type	Method	Description
SCM	NullSCMSource.build(SCMHead head, SCMRevision revision)	Builds a SCM instance for the specified head and revision, no validation of the head is performed, a revision for a different head or source will be treated as equivalent to a null revision.
SCM	SingleSCMSource.build(SCMHead head, SCMRevision revision)	Builds a SCM instance for the specified head and revision, no validation of the head is performed, a revision for a different head or source will be treated as equivalent to a null revision.