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 bySCMHead
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 differentSCMSource
andSCMNavigator
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>
Fields in jenkins.scm.api with type parameters of type SCMHead Modifier and Type Field Description static AlternativeUiTextProvider.Message<SCMHead>
SCMHead. PRONOUN
Replaceable pronoun of that points to aSCMHead
.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.SCMHead
SCMRevision. getHead()
Returns theSCMHead
that thisSCMRevision
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 Set<SCMHead>
SCMSource. fetch(TaskListener listener)
Fetches the current list of heads.Set<SCMHead>
SCMHeadObserver.AllFinished. getIncludes()
Set<SCMHead>
SCMHeadObserver.Filter. getIncludes()
Set<SCMHead>
SCMHeadObserver. getIncludes()
Set<SCMHead>
SCMHeadObserver.OneFinished. getIncludes()
Set<SCMHead>
SCMHeadObserver.Selector. getIncludes()
Set<SCMHead>
SCMHeadObserver.Wrapped. getIncludes()
abstract Map<SCMHead,SCMRevision>
SCMHeadEvent. heads(SCMSource source)
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 aSCMSource
, aSCMHead
and aSCMRevision
this method should try to build a correspondingSCMFileSystem
instance that reflects the content of the specifiedSCMHead
at the specifiedSCMRevision
.SCM
SCMSource. build(SCMHead head)
Builds aSCM
instance for the specified head.abstract SCM
SCMSource. build(SCMHead head, SCMRevision revision)
Builds aSCM
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 anull
revision.int
SCMHead. compareTo(SCMHead o)
protected SCMProbe
SCMSource. createProbe(SCMHead head, SCMRevision revision)
SCMRevision
SCMSource. fetch(SCMHead head, TaskListener listener)
Gets the current head revision of the specified head.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 headsprotected SCMProbe
SCMSource. fromSCMFileSystem(SCMHead head, SCMRevision revision)
Helper method for subclasses that have implemented aSCMFileSystem.Builder
and want to use a simple non-cachingSCMProbe
based off of theSCMFileSystem
.SCMProbe
SCMSource. newProbe(SCMHead head, SCMRevision revision)
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 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
.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)
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 Constructor Description Filter(O delegate, SCMHead... heads)
Constructor.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 theSCMRevision
of aChangeRequestSCMHead
.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 theSCMRevision
instance for a specificSCMHead
using the intermediate value produced by aSCMSourceRequest.IntermediateLambda
.static interface
SCMSourceRequest.ProbeLambda<H extends SCMHead,I>
A lambda that will create aSCMSourceCriteria.Probe
(ideally aSCMProbe
but for legacy code migration we useSCMSourceCriteria.Probe
) for a specifiedSCMHead
and either aSCMRevision
or some other type created by aSCMSourceRequest.IntermediateLambda
.static interface
SCMSourceRequest.RevisionLambda<H extends SCMHead,R extends SCMRevision>
A lambda that will create theSCMRevision
instance for a specificSCMHead
.static interface
SCMSourceRequest.Witness<H extends SCMHead,R extends SCMRevision>
Callback lambda to track the results ofSCMSourceRequest.process(SCMHead, IntermediateLambda, ProbeLambda, LazyRevisionLambda, Witness[])
Methods in jenkins.scm.api.trait with type parameters of type SCMHead Modifier and Type Method Description <H extends SCMHead,I,R extends SCMRevision>
booleanSCMSourceRequest. 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 theSCMRevision
can be instantiated.<H extends SCMHead,R extends SCMRevision>
booleanSCMSourceRequest. 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.<H extends SCMHead,R extends SCMRevision>
booleanSCMSourceRequest. 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 SCMHead
SCMBuilder. head()
Methods in jenkins.scm.api.trait with parameters of type SCMHead Modifier and Type Method Description boolean
SCMHeadAuthority. isApplicableTo(SCMHead head)
Checks if this authority is relevant to the suppliedSCMHead
.boolean
SCMHeadAuthorityDescriptor. isApplicableToHead(SCMHead head)
Checks if thisSCMHeadAuthorityDescriptor
is applicable to the suppliedSCMHead
.abstract boolean
SCMHeadFilter. isExcluded(SCMSourceRequest request, SCMHead head)
Checks if the suppliedSCMHead
is excluded from the specifiedSCMSourceRequest
.abstract boolean
SCMHeadPrefilter. isExcluded(SCMSource source, SCMHead head)
boolean
SCMSourceRequest. isExcluded(SCMHead head)
Tests if theSCMHead
is excluded from the request.boolean
SCMHeadAuthority. isTrusted(SCMSourceRequest request, SCMHead head)
Checks if the suppliedSCMHead
is trusted in the context of the specifiedSCMSourceRequest
.boolean
SCMSourceRequest. isTrusted(SCMHead head)
Tests if theSCMHead
is trusted.B
SCMBuilder. withHead(SCMHead head)
Replace theSCMBuilder.head()
with a newSCMHead
.Constructors in jenkins.scm.api.trait with parameters of type SCMHead 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 aSCM
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 anull
revision.SCM
SingleSCMSource. build(SCMHead head, SCMRevision revision)
Builds aSCM
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 anull
revision.boolean
ChangeRequestSCMHeadCategory. isMatch(SCMHead instance)
Checks if the supplied instance is a match for thisSCMCategory
.boolean
TagSCMHeadCategory. isMatch(SCMHead instance)
Checks if the supplied instance is a match for thisSCMCategory
.boolean
UncategorizedSCMHeadCategory. isMatch(SCMHead instance)
Checks if the supplied instance is a match for thisSCMCategory
.
-