jenkins.scm.api.trait

Class SCMHeadPrefilter

java.lang.Object

jenkins.scm.api.trait.SCMHeadPrefilter

public abstract class SCMHeadPrefilter
extends Object

A SCMSourceRequest independent filter of SCMHead instances. These filters may not make remote requests in order to determine exclusion. If multiple filters are used, if any exclude then the head is excluded. The SCMHeadPrefilter instances are applied before SCMHeadFilter instances in order to minimize remote requests.

Since:

3.4.0

See Also:

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

Constructor Summary

Constructors

Constructor and Description
SCMHeadPrefilter()

Method Summary

Modifier and Type	Method and Description
abstract boolean	isExcluded(SCMSource source, SCMHead head) Checks if the supplied SCMHead is excluded from the specified SCMSource.

Methods inherited from class java.lang.Object

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

Constructor Detail

SCMHeadPrefilter

public SCMHeadPrefilter()

Method Detail

isExcluded

public abstract boolean isExcluded(@NonNull
                                   SCMSource source,
                                   @NonNull
                                   SCMHead head)

Checks if the supplied SCMHead is excluded from the specified SCMSource.

Parameters:

source - the SCMSource.

head - the SCMHead.

Returns:

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