jenkins.scm.api

Class SCMHeadObserver.AllFinished

java.lang.Object

jenkins.scm.api.SCMHeadObserver

jenkins.scm.api.SCMHeadObserver.AllFinished

Enclosing class:

SCMHeadObserver

public static class SCMHeadObserver.AllFinished
extends SCMHeadObserver

An observer that wraps multiple observers and keeps observing as long as one of the wrapped observers wants to.

Nested Class Summary

Nested classes/interfaces inherited from class jenkins.scm.api.SCMHeadObserver

SCMHeadObserver.AllFinished, SCMHeadObserver.Collector, SCMHeadObserver.OneFinished, SCMHeadObserver.Selector

Constructor Summary

Constructors

Constructor and Description
SCMHeadObserver.AllFinished(Iterable<SCMHeadObserver> observers) Constructor.
SCMHeadObserver.AllFinished(SCMHeadObserver... observers) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isObserving() Returns information about whether the observer wants more results.
void	observe(SCMHead head, SCMRevision revision) Observes a head and current revision.

Methods inherited from class jenkins.scm.api.SCMHeadObserver

allOf, collect, first, select

Methods inherited from class java.lang.Object

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

Constructor Detail

SCMHeadObserver.AllFinished

public SCMHeadObserver.AllFinished(SCMHeadObserver... observers)

Constructor.

Parameters:

observers - the observers to wrap.

SCMHeadObserver.AllFinished

public SCMHeadObserver.AllFinished(@NonNull
                           Iterable<SCMHeadObserver> observers)

Constructor.

Parameters:

observers - the observers to wrap.

Method Detail

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.