PathBasedPullRequestFilterTrait (GitHub Branch Source Pull Request Change Filter 1.2.4 API)

java.lang.Object
- hudson.model.AbstractDescribableImpl<T>
- - jenkins.scm.api.trait.SCMTrait<jenkins.scm.api.trait.SCMSourceTrait>
  - - jenkins.scm.api.trait.SCMSourceTrait
    - - io.jenkins.plugins.github_branch_pr_change_filter.PathBasedPullRequestFilterTrait

All Implemented Interfaces:

Describable<jenkins.scm.api.trait.SCMSourceTrait>
```
public class PathBasedPullRequestFilterTrait
extends jenkins.scm.api.trait.SCMSourceTrait
```
A Discovery trait for GitHub that will only select pull requests that match a given regex

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class PathBasedPullRequestFilterTrait.DescriptorImpl

Field Summary

Fields
Modifier and Type	Field	Description
`Pattern`	`exclusionPattern`	The pattern compiled from supplied exclusion regex
`Pattern`	`inclusionPattern`	The pattern compiled from supplied inclusion regex

Constructor Summary

Constructors
Constructor Description

PathBasedPullRequestFilterTrait(String inclusionField, String exclusionField)
Constructor for stapler.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`decorateContext(jenkins.scm.api.trait.SCMSourceContext<?,?> context)`
`String`	`getExclusionField()`
`String`	`getInclusionField()`
`boolean`	`includeCategory(jenkins.scm.api.SCMHeadCategory category)`

Methods inherited from class jenkins.scm.api.trait.SCMSourceTrait
_for, _for, all, applyToBuilder, applyToContext, applyToObserver, decorateBuilder, decorateObserver, getDescriptor, isCategoryEnabled

Methods inherited from class jenkins.scm.api.trait.SCMTrait
asSetList, asSetList, find

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - inclusionPattern
```
public Pattern inclusionPattern
```
    The pattern compiled from supplied inclusion regex
  - exclusionPattern
```
public Pattern exclusionPattern
```
    The pattern compiled from supplied exclusion regex
- Constructor Detail
  - PathBasedPullRequestFilterTrait
```
@DataBoundConstructor
public PathBasedPullRequestFilterTrait(String inclusionField,
                                       String exclusionField)
```
    Constructor for stapler.
    
    Parameters:
    
    inclusionField - Path regex for which pull request files to include
    
    exclusionField - Path regex for which pull request files to exclude
- Method Detail
  - getInclusionField
```
public String getInclusionField()
```
  - getExclusionField
```
public String getExclusionField()
```
  - decorateContext
```
protected void decorateContext(jenkins.scm.api.trait.SCMSourceContext<?,?> context)
```
    Overrides:
    
    decorateContext in class jenkins.scm.api.trait.SCMSourceTrait
  - includeCategory
```
public boolean includeCategory(@NonNull
                               jenkins.scm.api.SCMHeadCategory category)
```
    Overrides:
    
    includeCategory in class jenkins.scm.api.trait.SCMSourceTrait