Package jenkins.scm.api
Class SCMHeadObserver.Selector
- java.lang.Object
-
- jenkins.scm.api.SCMHeadObserver
-
- jenkins.scm.api.SCMHeadObserver.Selector
-
- Enclosing class:
- SCMHeadObserver
public static class SCMHeadObserver.Selector extends SCMHeadObserver
An observer that collects theSCMRevision
of a specificSCMHead
and then stops observing.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class jenkins.scm.api.SCMHeadObserver
SCMHeadObserver.AllFinished, SCMHeadObserver.Any, SCMHeadObserver.Collector, SCMHeadObserver.Filter<O extends SCMHeadObserver>, SCMHeadObserver.Named, SCMHeadObserver.None, SCMHeadObserver.OneFinished, SCMHeadObserver.Selector, SCMHeadObserver.Wrapped<O extends SCMHeadObserver>
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Set<SCMHead>
getIncludes()
boolean
isObserving()
Returns information about whether the observer wants more results.void
observe(SCMHead head, SCMRevision revision)
Observes a head and current revision.SCMRevision
result()
Returns the result.
-
-
-
Constructor Detail
-
Selector
public Selector(@NonNull SCMHead head)
Constructor.- Parameters:
head
- theSCMHead
to get theSCMRevision
of.
-
-
Method Detail
-
result
@CheckForNull public SCMRevision result()
Returns the result.- Returns:
- the result.
-
observe
public void observe(@NonNull SCMHead head, @NonNull SCMRevision revision)
Observes a head and current revision.- Specified by:
observe
in classSCMHeadObserver
- Parameters:
head
- the head.revision
- the revision.
-
isObserving
public boolean isObserving()
Returns information about whether the observer wants more results.- Overrides:
isObserving
in classSCMHeadObserver
- Returns:
true
if the observer is still observing orfalse
to signal that it is ok to stop early.
-
getIncludes
public Set<SCMHead> getIncludes()
Returns the subset ofSCMHead
instances that this observer is interested in ornull
if interested in allSCMHead
instances.Implementations should not assume that the
SCMHeadObserver.getIncludes()
will be honoured. This method is designed to provide a hint toSCMSource
implementations.- Overrides:
getIncludes
in classSCMHeadObserver
- Returns:
- the subset of
SCMHead
instances that this observer is interested in ornull
.
-
-