jenkins.scm.api.trait

Class SCMHeadFilter

java.lang.Object

jenkins.scm.api.trait.SCMHeadFilter

public abstract class SCMHeadFilter
extends Object

A SCMSourceRequest dependent filter of SCMHead instances. Typically these filters may need to make remote requests in order to determine exclusion. If multiple filters are used, if any exclude then the head is excluded.

Since:

3.4.0

See Also:

for {@link SCMSourceRequest} independent filters / filters that can perform completely off-line.

Constructor Summary

Constructors

Constructor and Description
SCMHeadFilter()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

SCMHeadFilter

public SCMHeadFilter()

Method Detail

isExcluded

public abstract boolean isExcluded(@NonNull
                                   SCMSourceRequest request,
                                   @NonNull
                                   SCMHead head)
                            throws IOException,
                                   InterruptedException

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

Parameters:

request - the SCMSourceRequest.

head - the SCMHead.

Returns:

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

Throws:

IOException - if there was an I/O error when determining exclusion.

InterruptedException - if interrupted while determining exclusion.