jenkins.scm.api

Class SCMSourceObserver.Filter<O extends SCMSourceObserver>

java.lang.Object

jenkins.scm.api.SCMSourceObserver

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

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

Type Parameters:

O - the type of observer being filtered.

Enclosing class:

SCMSourceObserver

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

An observer that filters the observed sources to a subset of named instances.

Since:

2.0

Nested Class Summary

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

SCMSourceObserver.Filter<O extends SCMSourceObserver>, SCMSourceObserver.ProjectObserver, SCMSourceObserver.Wrapped<O extends SCMSourceObserver>

Constructor Summary

Constructors

Constructor and Description
Filter(O delegate, String... projectNames) Constructor.

Method Summary

Modifier and Type	Method and Description
Set<String>	getIncludes() Returns the subset of "project" names that this observer is interested in or null if interested in all "project" names.
boolean	isObserving() Returns information about whether the observer wants more results.
SCMSourceObserver.ProjectObserver	observe(String projectName) Declare that a new “project” such as a source repository has been found.

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

addAttribute, getContext, getListener

Methods inherited from class jenkins.scm.api.SCMSourceObserver

filter

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,
              String... projectNames)

Constructor.

Parameters:

delegate - the delegate.

projectNames - the project names to filter.

Method Detail

getIncludes

public Set<String> getIncludes()

Returns the subset of "project" names that this observer is interested in or null if interested in all "project" names.

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

Overrides:

getIncludes in class SCMSourceObserver.Wrapped<O extends SCMSourceObserver>

Returns:

the subset of "project" names that this observer is interested in or null.

See Also:

for the definition of "project" names

observe

@NonNull
public SCMSourceObserver.ProjectObserver observe(@NonNull
                                                          String projectName)
                                                   throws IllegalArgumentException,
                                                          IOException,
                                                          InterruptedException

Declare that a new “project” such as a source repository has been found.

Overrides:

observe in class SCMSourceObserver.Wrapped<O extends SCMSourceObserver>

Parameters:

projectName - a name of the project, such as a repository name within an organization; may be used as an Item.getName()

Returns:

a secondary callback to customize the project, on which you must call SCMSourceObserver.ProjectObserver.complete()

Throws:

IllegalArgumentException - if this projectName has already been encountered

IOException - if observing this projectName could not be completed due to an IOException.

InterruptedException - if observing this projectName was interrupted.

isObserving

public boolean isObserving()

Returns information about whether the observer wants more results.

Overrides:

isObserving in class SCMSourceObserver.Wrapped<O extends SCMSourceObserver>

Returns:

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