Package org.sonar.plugins.java.api

Class IssuableSubscriptionVisitor

java.lang.Object

org.sonar.java.ast.visitors.SubscriptionVisitor

org.sonar.plugins.java.api.IssuableSubscriptionVisitor

All Implemented Interfaces:

JavaCheck, JavaFileScanner

public abstract class IssuableSubscriptionVisitor
extends SubscriptionVisitor

Subscription visitor providing an API to report issues.

Field Summary

Fields inherited from class org.sonar.java.ast.visitors.SubscriptionVisitor

context

Constructor Summary

Constructors

Constructor	Description
IssuableSubscriptionVisitor()

Method Summary

Modifier and Type	Method	Description
void	addIssue(int line, String message)	Report an issue on a specific line.
void	addIssueOnFile(String message)	Report an issue at file level.
void	reportIssue(Tree tree, String message)	Report an issue.
void	reportIssue(Tree tree, String message, List<JavaFileScannerContext.Location> flow, Integer cost)	Report an issue.
void	reportIssue(Tree startTree, Tree endTree, String message)	Report an issue.
protected void	scanTree(Tree tree)

Methods inherited from class org.sonar.java.ast.visitors.SubscriptionVisitor

hasSemantic, leaveFile, leaveNode, nodesToVisit, scanFile, setContext, visitNode, visitToken, visitTrivia

Methods inherited from class java.lang.Object

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

Constructor Detail

IssuableSubscriptionVisitor

public IssuableSubscriptionVisitor()

Method Detail

scanTree

protected void scanTree(Tree tree)

Overrides:

scanTree in class SubscriptionVisitor

addIssue

public void addIssue(int line,
                     String message)

Report an issue on a specific line.

Parameters:

line - line on which to report the issue

message - Message to display to the user

addIssueOnFile

public void addIssueOnFile(String message)

Report an issue at file level.

Parameters:

message - Message to display to the user

reportIssue

public void reportIssue(Tree tree,
                        String message)

Report an issue.

Parameters:

tree - syntax node on which to raise the issue.

message - Message to display to the user.

reportIssue

public void reportIssue(Tree tree,
                        String message,
                        List<JavaFileScannerContext.Location> flow,
                        @Nullable
                        Integer cost)

Report an issue.

Parameters:

tree - syntax node on which to raise the issue.

message - Message to display to the user.

flow - List of JavaFileScannerContext.Location to display secondary locations describing the flow leading to the issue. Empty list if the issue does not requires secondary location.

cost - computed remediation cost if applicable, null if not.

reportIssue

public void reportIssue(Tree startTree,
                        Tree endTree,
                        String message)

Report an issue.

Parameters:

startTree - syntax node on which to start the highlighting of the issue.

endTree - syntax node on which to end the highlighting of the issue.

message - Message to display to the user.