Uses of Class
jenkins.scm.api.SCMHead

Packages that use SCMHead

Package	Description
jenkins.scm.api	The public API contract of the SCM API plugin.
jenkins.scm.api.actions	Do not use.
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 SCMHead in jenkins.scm.api

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

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.

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

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

Methods in jenkins.scm.api that return SCMHead

Modifier and Type	Method	Description
static SCMHead	SCMHead.HeadByItem.findHead(Item item)	Runs all registered implementations.
abstract SCMHead	SCMHead.HeadByItem.getHead(Item item)	Checks whether a given item corresponds to a particular SCM head.
final SCMHead	SCMRevision.getHead()	Returns the SCMHead that this SCMRevision belongs to.
abstract SCMHead	SCMHeadMigration.migrate(S source, H head)	Perform a migration.
static SCMHead	SCMHeadMigration.readResolveSCMHead(SCMSource source, SCMHead head)	Perform a migration.

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

Modifier and Type	Method	Description
final Set<SCMHead>	SCMSource.fetch(TaskListener listener)	Fetches the current list of heads.
Set<SCMHead>	SCMHeadObserver.AllFinished.getIncludes()	Returns the subset of SCMHead instances that this observer is interested in or null if interested in all SCMHead instances.
Set<SCMHead>	SCMHeadObserver.Filter.getIncludes()	Returns the subset of SCMHead instances that this observer is interested in or null if interested in all SCMHead instances.
Set<SCMHead>	SCMHeadObserver.getIncludes()	Returns the subset of SCMHead instances that this observer is interested in or null if interested in all SCMHead instances.
Set<SCMHead>	SCMHeadObserver.OneFinished.getIncludes()	Returns the subset of SCMHead instances that this observer is interested in or null if interested in all SCMHead instances.
Set<SCMHead>	SCMHeadObserver.Selector.getIncludes()	Returns the subset of SCMHead instances that this observer is interested in or null if interested in all SCMHead instances.
Set<SCMHead>	SCMHeadObserver.Wrapped.getIncludes()	Returns the subset of SCMHead instances that this observer is interested in or null if interested in all SCMHead instances.
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.
Map<SCMHead,SCMRevision>	SCMHeadObserver.Collector.result()	Returns the collected results.
protected Set<SCMHead>	SCMSource.retrieve(TaskListener listener)	SPI: Fetches the current list of heads.
protected Set<SCMHead>	SCMSource.retrieve(SCMSourceCriteria criteria, TaskListener listener)	SPI: Fetches the current list of heads.

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

Modifier and Type	Method	Description
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.
final SCM	SCMSource.build(SCMHead head)	Builds a SCM instance for the specified head.
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.
int	SCMHead.compareTo(SCMHead o)
protected SCMProbe	SCMSource.createProbe(SCMHead head, SCMRevision revision)	Creates a SCMProbe for the specified SCMHead and SCMRevision.
final SCMRevision	SCMSource.fetch(SCMHead head, TaskListener listener)	Gets the current head revision of the specified head.
final List<Action>	SCMSource.fetchActions(SCMHead head, SCMHeadEvent event, TaskListener listener)	Fetches any actions that should be persisted for objects related to the specified head.
static <O extends SCMHeadObserver> SCMHeadObserver.Filter<O>	SCMHeadObserver.filter(O delegate, SCMHead... heads)	Creates an observer that filters a delegates observer to the specified heads
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.
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(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.
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.
static SCMHead	SCMHeadMigration.readResolveSCMHead(SCMSource source, SCMHead head)	Perform a migration.
protected SCMRevision	SCMSource.retrieve(SCMHead head, TaskListener listener)	SPI: Gets the current head revision of the specified head.
protected List<Action>	SCMSource.retrieveActions(SCMHead head, SCMHeadEvent event, TaskListener listener)	SPI for SCMSource.fetchActions(SCMHead, SCMHeadEvent, TaskListener).
static SCMHeadObserver.Selector	SCMHeadObserver.select(SCMHead head)	Creates an observer that selects the revision of a specific head.

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

Modifier	Constructor	Description
	Filter(O delegate, SCMHead... heads)	Constructor.
protected	SCMRevision(SCMHead head)	Constructor.
	Selector(SCMHead head)	Constructor.

Uses of SCMHead in jenkins.scm.api.actions

Methods in jenkins.scm.api.actions that return SCMHead

Modifier and Type	Method	Description
SCMHead	ChangeRequestAction.getTarget()	Deprecated.

Uses of SCMHead in jenkins.scm.api.mixin

Classes in jenkins.scm.api.mixin with type parameters of type SCMHead

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 SCMHead

Modifier and Type	Method	Description
SCMHead	ChangeRequestSCMHead.getTarget()	Branch to which this change would be merged or applied if it were accepted.

Uses of SCMHead in jenkins.scm.api.trait

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

Modifier and Type	Interface	Description
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.ProbeLambda<H extends SCMHead,I>	A lambda that will create a SCMSourceCriteria.Probe (ideally a SCMProbe but for legacy code migration we use SCMSourceCriteria.Probe) for a specified SCMHead and either a SCMRevision or some other type created 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 SCMHead

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 SCMHead

Modifier and Type	Method	Description
final SCMHead	SCMBuilder.head()	Returns the SCMHead to produce the SCM for.

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

Modifier and Type	Method	Description
final boolean	SCMHeadAuthority.isApplicableTo(SCMHead head)	Checks if this authority is relevant to the supplied SCMHead.
boolean	SCMHeadAuthorityDescriptor.isApplicableToHead(SCMHead head)	Checks if this SCMHeadAuthorityDescriptor is applicable to the supplied SCMHead.
abstract boolean	SCMHeadFilter.isExcluded(SCMSourceRequest request, SCMHead head)	Checks if the supplied SCMHead is excluded from the specified SCMSourceRequest.
abstract boolean	SCMHeadPrefilter.isExcluded(SCMSource source, SCMHead head)	Checks if the supplied SCMHead is excluded from the specified SCMSource.
final boolean	SCMSourceRequest.isExcluded(SCMHead head)	Tests if the SCMHead is excluded from the request.
final boolean	SCMHeadAuthority.isTrusted(SCMSourceRequest request, SCMHead head)	Checks if the supplied SCMHead is trusted in the context of the specified SCMSourceRequest.
final boolean	SCMSourceRequest.isTrusted(SCMHead head)	Tests if the SCMHead is trusted.
final B	SCMBuilder.withHead(SCMHead head)	Replace the SCMBuilder.head() with a new SCMHead.

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

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

Uses of SCMHead in jenkins.scm.impl

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

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.
boolean	ChangeRequestSCMHeadCategory.isMatch(SCMHead instance)	Checks if the supplied instance is a match for this SCMCategory.
boolean	TagSCMHeadCategory.isMatch(SCMHead instance)	Checks if the supplied instance is a match for this SCMCategory.
boolean	UncategorizedSCMHeadCategory.isMatch(SCMHead instance)	Checks if the supplied instance is a match for this SCMCategory.