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 the SCMRevision of a specific SCMHead 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>

Constructor Summary

Constructors

Constructor	Description
Selector(SCMHead head)	Constructor.

Method Summary

Modifier and Type	Method	Description
Set<SCMHead>	getIncludes()	Returns the subset of SCMHead instances that this observer is interested in or null if interested in all SCMHead instances.
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.

Methods inherited from class jenkins.scm.api.SCMHeadObserver

allOf, any, collect, filter, first, named, none, select

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Selector

public Selector(@NonNull
 SCMHead head)

Constructor.

Parameters:

head - the SCMHead to get the SCMRevision of.

Method Details

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 class SCMHeadObserver

Parameters:

head - the head.

revision - the revision.

isObserving

public boolean isObserving()

Returns information about whether the observer wants more results.

Overrides:

isObserving in class SCMHeadObserver

Returns:

true if the observer is still observing or false to signal that it is ok to stop early.

getIncludes

public Set<SCMHead> getIncludes()

Returns the subset of SCMHead instances that this observer is interested in or null if interested in all SCMHead instances.

Implementations should not assume that the SCMHeadObserver.getIncludes() will be honoured. This method is designed to provide a hint to SCMSource implementations.

Overrides:

getIncludes in class SCMHeadObserver

Returns:

the subset of SCMHead instances that this observer is interested in or null.