Package org.sonar.plugins.javascript.api.visitors

Class SubscriptionVisitorCheck

java.lang.Object

org.sonar.plugins.javascript.api.visitors.SubscriptionVisitor

org.sonar.plugins.javascript.api.visitors.SubscriptionVisitorCheck

All Implemented Interfaces:

JavaScriptCheck, TreeVisitor

Direct Known Subclasses:

SeChecksDispatcher

@Beta
public abstract class SubscriptionVisitorCheck
extends SubscriptionVisitor
implements JavaScriptCheck

Constructor Summary

Constructors

Constructor	Description
SubscriptionVisitorCheck()

Method Summary

Modifier and Type	Method	Description
PreciseIssue	addIssue(Tree tree, String message)	Returns new issue which is instance of PreciseIssue.
<T extends Issue> T	addIssue(T issue)	Use this method only to add specific kind of issue.
LineIssue	addLineIssue(Tree tree, String message)	Deprecated. see JavaScriptCheck.addLineIssue(Tree, String)
List<Issue>	scanFile(TreeVisitorContext context)

Methods inherited from class org.sonar.plugins.javascript.api.visitors.SubscriptionVisitor

getContext, isSubscribed, leaveFile, leaveNode, nodesToVisit, scanTree, scanTree, visitFile, visitNode

Methods inherited from class java.lang.Object

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

Constructor Detail

SubscriptionVisitorCheck

public SubscriptionVisitorCheck()

Method Detail

scanFile

public List<Issue> scanFile(TreeVisitorContext context)

Specified by:

scanFile in interface JavaScriptCheck

addLineIssue

@Deprecated
public LineIssue addLineIssue(Tree tree,
                              String message)

Deprecated.

see JavaScriptCheck.addLineIssue(Tree, String)

Description copied from interface: JavaScriptCheck

Returns new issue which is located on first line of tree

Specified by:

addLineIssue in interface JavaScriptCheck

addIssue

public PreciseIssue addIssue(Tree tree,
                             String message)

Description copied from interface: JavaScriptCheck

Returns new issue which is instance of PreciseIssue. Then you can chain this method with following method calls to provide more information about issue:

• PreciseIssue.secondary(Tree, String), PreciseIssue.secondary(Tree) (without message) or PreciseIssue.secondary(IssueLocation) to add secondary location
• PreciseIssue.cost(double) to add cost

See example

 
  newIssue(functionDeclaration, "Remove this function declaration")
    .secondary(call, "Function call")
    .secondary(redefinition, "Function redefinition")
    .cost(functionDeclaration.parameters().parameters().size());
 
 

To create new issue you also can use JavaScriptCheck.addIssue(Issue):

getContext().addIssue(new FileIssue(this, "Some message"))

Specified by:

addIssue in interface JavaScriptCheck

Parameters:

tree - primary location of issue

message - primary message

Returns:

new issue

addIssue

public <T extends Issue> T addIssue(T issue)

Description copied from interface: JavaScriptCheck

Use this method only to add specific kind of issue. E.g. you can use this method to add issue on file level, line issue or precise issue with sophisticated primary location.

Otherwise please use JavaScriptCheck.addIssue(Tree, String)

Specified by:

addIssue in interface JavaScriptCheck