Package jenkins.scm.api.trait
Class SCMHeadFilter
- java.lang.Object
-
- jenkins.scm.api.trait.SCMHeadFilter
-
public abstract class SCMHeadFilter extends Object
ASCMSourceRequest
dependent filter ofSCMHead
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 independent filters / filters that can perform completely off-line.
-
-
Constructor Summary
Constructors Constructor Description SCMHeadFilter()
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description abstract boolean
isExcluded(SCMSourceRequest request, SCMHead head)
Checks if the suppliedSCMHead
is excluded from the specifiedSCMSourceRequest
.
-
-
-
Method Detail
-
isExcluded
public abstract boolean isExcluded(@NonNull SCMSourceRequest request, @NonNull SCMHead head) throws IOException, InterruptedException
Checks if the suppliedSCMHead
is excluded from the specifiedSCMSourceRequest
.- Parameters:
request
- theSCMSourceRequest
.head
- theSCMHead
.- Returns:
true
if and only if theSCMHead
is excluded from the request.- Throws:
IOException
- if there was an I/O error when determining exclusion.InterruptedException
- if interrupted while determining exclusion.
-
-