Package jenkins.scm.api

Class SCMHeadObserver.Wrapped<O extends SCMHeadObserver>

java.lang.Object

jenkins.scm.api.SCMHeadObserver

jenkins.scm.api.SCMHeadObserver.Wrapped<O>

Type Parameters:

O - the type of wrapped SCMHeadObserver

Direct Known Subclasses:

SCMHeadObserver.Filter

Enclosing class:

SCMHeadObserver

public abstract static class SCMHeadObserver.Wrapped<O extends SCMHeadObserver>
extends SCMHeadObserver

Base class for an SCMHeadObserver that wraps another SCMHeadObserver while allowing access to the original observer via unwrap().

Since:

2.0

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

Modifier	Constructor	Description
protected	Wrapped(O delegate)	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.
O	unwrap()	Unwraps this SCMHeadObserver.

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 Detail

Wrapped

protected Wrapped(O delegate)

Constructor.

Parameters:

delegate - the SCMHeadObserver to wrap.

Method Detail

unwrap

public O unwrap()

Unwraps this SCMHeadObserver.

Returns:

the wrapped SCMHeadObserver.

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.

observe

public void observe(@NonNull
                    SCMHead head,
                    @NonNull
                    SCMRevision revision)
             throws IOException,
                    InterruptedException

Observes a head and current revision.

Specified by:

observe in class SCMHeadObserver

Parameters:

head - the head.

revision - the revision.

Throws:

IOException - if processing of the observation could not be completed due to an IOException.

InterruptedException - if processing of the observation was interrupted

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.