jenkins.scm.api

Class SCMHeadObserver

java.lang.Object

jenkins.scm.api.SCMHeadObserver

Direct Known Subclasses:

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

public abstract class SCMHeadObserver
extends Object

Something that observes SCMHead and corresponding SCMRevision details.

Author:

Stephen Connolly

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SCMHeadObserver.AllFinished An observer that wraps multiple observers and keeps observing as long as one of the wrapped observers wants to.
static class	SCMHeadObserver.Collector An observer that collects the observed SCMHeads and SCMRevisions.
static class	SCMHeadObserver.OneFinished An observer that wraps multiple observers and keeps observing until one of the wrapped observers stops observing.
static class	SCMHeadObserver.Selector An observer that collects the SCMRevision of a specific SCMHead and then stops observing.

Constructor Summary

Constructors

Constructor and Description
SCMHeadObserver()

Method Summary

Methods

Modifier and Type	Method and Description
static SCMHeadObserver.AllFinished	allOf(SCMHeadObserver... observers) Wraps multiple observers returning a combined observer that remains observing as long as at least one of the wrapped observers is still observing.
static SCMHeadObserver.Collector	collect() Creates an observer that collects all the heads and revisions.
static SCMHeadObserver.OneFinished	first(SCMHeadObserver... observers) Wraps multiple observers returning a combined observer that remains observing until one of the wrapped observers stops observing.
boolean	isObserving() Returns information about whether the observer wants more results.
abstract void	observe(SCMHead head, SCMRevision revision) Observes a head and current revision.
static SCMHeadObserver.Selector	select(SCMHead head) Creates an observer that selects the revision of a specific head.

Methods inherited from class java.lang.Object

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

Constructor Detail

SCMHeadObserver

public SCMHeadObserver()

Method Detail

observe

public abstract void observe(@NonNull
           SCMHead head,
           @NonNull
           SCMRevision revision)

Observes a head and current revision.

Parameters:

head - the head.

revision - the revision.

isObserving

public boolean isObserving()

Returns information about whether the observer wants more results.

Returns:

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

allOf

@NonNull
public static SCMHeadObserver.AllFinished allOf(SCMHeadObserver... observers)

Wraps multiple observers returning a combined observer that remains observing as long as at least one of the wrapped observers is still observing.

Parameters:

observers - the observers to wrap.

Returns:

a wrapped observer.

first

@NonNull
public static SCMHeadObserver.OneFinished first(SCMHeadObserver... observers)

Wraps multiple observers returning a combined observer that remains observing until one of the wrapped observers stops observing.

Parameters:

observers - the observers to wrap.

Returns:

a wrapped observer.

collect

@NonNull
public static SCMHeadObserver.Collector collect()

Creates an observer that collects all the heads and revisions.

Returns:

an observer that collects all the heads and revisions.

select

@NonNull
public static SCMHeadObserver.Selector select(@NonNull
                                      SCMHead head)

Creates an observer that selects the revision of a specific head.

Parameters:

head - the head to watch out for.

Returns:

an observer that selects the revision of a specific head.