org.sonar.api.scan.issue.filter

Interface IssueFilter

All Known Implementing Classes:

NoSonarFilter

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@ScannerSide
 @SonarLintSide
 @ExtensionPoint
 @FunctionalInterface
public interface IssueFilter

Method Summary

Modifier and Type	Method and Description
boolean	accept(FilterableIssue issue, IssueFilterChain chain) The accept method is called for each FilterableIssue created during analysis, to check if it has to be persisted.

Method Detail

accept

boolean accept(FilterableIssue issue,
               IssueFilterChain chain)

The accept method is called for each FilterableIssue created during analysis, to check if it has to be persisted. Examples of use cases are:

• Ignoring or enforcing rules on specific resources
• Switching-off an issue based on its context (//NOSONAR comments, semantic annotations)

The chain parameter allows for fine control of the filtering logic: it is each filter's duty to either pass the issue to the next filter, by calling the IssueFilterChain.accept(org.sonar.api.scan.issue.filter.FilterableIssue) method, or return directly if the issue has to be accepted or not

Parameters:

issue - the issue being filtered

chain - the rest of the filters

Returns:

true to accept the issue, false to reject it, IssueFilterChain.accept(org.sonar.api.scan.issue.filter.FilterableIssue) to let the other filters decide.