org.sonar.api.issue

Class NoSonarFilter

java.lang.Object

org.sonar.api.issue.NoSonarFilter

All Implemented Interfaces:

IssueFilter

public class NoSonarFilter
extends Object
implements IssueFilter

Issue filter used to ignore issues created on lines commented with the tag "NOSONAR".
Plugins, via ScannerSides, must feed this filter by registering the lines that contain "NOSONAR". Note that filters are disabled for the issues reported by end-users from UI or web services.

Since:

3.6

Constructor Summary

Constructors

Constructor and Description
NoSonarFilter()

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.
NoSonarFilter	addComponent(String componentKey, Set<Integer> noSonarLines) Deprecated. since 5.0 use noSonarInFile(InputFile, Set)
NoSonarFilter	noSonarInFile(InputFile inputFile, Set<Integer> noSonarLines) Register lines in a file that contains the NOSONAR flag.

Methods inherited from class java.lang.Object

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

Constructor Detail

NoSonarFilter

public NoSonarFilter()

Method Detail

addComponent

@Deprecated
public NoSonarFilter addComponent(String componentKey,
                                              Set<Integer> noSonarLines)

Deprecated. since 5.0 use noSonarInFile(InputFile, Set)

noSonarInFile

public NoSonarFilter noSonarInFile(InputFile inputFile,
                                   Set<Integer> noSonarLines)

Register lines in a file that contains the NOSONAR flag.

Parameters:

inputFile -

noSonarLines - Line number starts at 1 in a file

Since:

5.0

accept

public boolean accept(FilterableIssue issue,
                      IssueFilterChain chain)

Description copied from interface: IssueFilter

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 Implementations should be thread safe.

Specified by:

accept in interface IssueFilter

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.