jenkins.scm.api.trait

Class SCMSourcePrefilter

java.lang.Object

jenkins.scm.api.trait.SCMSourcePrefilter

public abstract class SCMSourcePrefilter
extends Object

A SCMNavigatorRequest independent filter of project names. These filters may not make remote requests in order to determine exclusion. If multiple filters are used, if any exclude then the project name is excluded. The SCMSourcePrefilter instances are applied before SCMSourceFilter instances in order to minimize remote requests.

Since:

3.4.0

See Also:

for {@link SCMNavigatorRequest} dependent filters / filters that can may require on-line operation.

Constructor Summary

Constructors

Constructor and Description
SCMSourcePrefilter()

Method Summary

Modifier and Type	Method and Description
abstract boolean	isExcluded(SCMNavigator source, String projectName) Checks if the supplied project name is excluded from the specified SCMNavigator.

Methods inherited from class java.lang.Object

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

Constructor Detail

SCMSourcePrefilter

public SCMSourcePrefilter()

Method Detail

isExcluded

public abstract boolean isExcluded(@NonNull
                                   SCMNavigator source,
                                   @NonNull
                                   String projectName)

Checks if the supplied project name is excluded from the specified SCMNavigator.

Parameters:

source - the SCMNavigator.

projectName - the project name.

Returns:

true if and only if the SCMHead is excluded from the request.