jenkins.scm.api

Class SCMHeadObserver.Filter<O extends SCMHeadObserver>

java.lang.Object

jenkins.scm.api.SCMHeadObserver

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

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

Type Parameters:

O - the type of wrapped SCMHeadObserver

Enclosing class:

SCMHeadObserver

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

A SCMHeadObserver that filters the SCMHead instances that will be observed by the wrapped SCMHeadObserver.

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

Constructor and Description
Filter(O delegate, SCMHead... heads) Constructor.

Method Summary

Modifier and Type	Method and 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.

Methods inherited from class jenkins.scm.api.SCMHeadObserver.Wrapped

unwrap

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

Filter

public Filter(O delegate,
              SCMHead... heads)

Constructor.

Parameters:

delegate - The SCMHeadObserver to wrap.

heads - The SCMHead instances that my be observed by the wrapped SCMHeadObserver.

Method Detail

observe

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

Observes a head and current revision.

Overrides:

observe in class SCMHeadObserver.Wrapped<O extends 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

isObserving

public boolean isObserving()

Returns information about whether the observer wants more results.

Overrides:

isObserving in class SCMHeadObserver.Wrapped<O extends 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.Wrapped<O extends SCMHeadObserver>

Returns:

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