org.sonar.plugins.javascript.api.visitors

Class DoubleDispatchVisitorCheck

java.lang.Object

org.sonar.plugins.javascript.api.visitors.DoubleDispatchVisitor

org.sonar.plugins.javascript.api.visitors.DoubleDispatchVisitorCheck

All Implemented Interfaces:

JavaScriptCheck, TreeVisitor

public abstract class DoubleDispatchVisitorCheck
extends DoubleDispatchVisitor
implements JavaScriptCheck

Constructor Summary

Constructors

Constructor and Description
DoubleDispatchVisitorCheck()

Method Summary

Methods

Modifier and Type	Method and Description
<T extends Issue> T	addIssue(T issue) Use this method only to add specific kind of issue (when listed below methods don't meet your needs).
PreciseIssue	addIssue(Tree tree, String message) Returns new issue which is instance of PreciseIssue.
LineIssue	addLineIssue(Tree tree, String message) This method should be deprecated, as soon as this plugin will be migrated on 5.X LTS (with support of precise issue locations).
List<Issue>	scanFile(TreeVisitorContext context)

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

getContext, scan, scan, scanTree, visitArrayBindingPattern, visitArrayLiteral, visitArrowFunction, visitAssignmentExpression, visitBinaryExpression, visitBindingProperty, visitBlock, visitBreakStatement, visitCallExpression, visitCaseClause, visitCatchBlock, visitClass, visitComputedPropertyName, visitConditionalExpression, visitContinueStatement, visitDebugger, visitDefaultClause, visitDefaultExportDeclaration, visitDoWhileStatement, visitElseClause, visitEmptyStatement, visitExportClause, visitExpressionStatement, visitForObjectStatement, visitForStatement, visitFromClause, visitFunctionDeclaration, visitFunctionExpression, visitIdentifier, visitIfStatement, visitImportClause, visitImportDeclaration, visitImportModuleDeclaration, visitInitializedBindingElement, visitLabelledStatement, visitLiteral, visitMemberExpression, visitMethodDeclaration, visitModule, visitNamedExportDeclaration, visitNameSpaceExportDeclaration, visitNewExpression, visitObjectBindingPattern, visitObjectLiteral, visitPairProperty, visitParameterList, visitParenthesisedExpression, visitRestElement, visitReturnStatement, visitScript, visitSpecifier, visitSpecifierList, visitSuper, visitSwitchStatement, visitTaggedTemplate, visitTemplateCharacters, visitTemplateExpression, visitTemplateLiteral, visitThrowStatement, visitTryStatement, visitUnaryExpression, visitVariableDeclaration, visitVariableStatement, visitWhileStatement, visitWithStatement, visitYieldExpression

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.sonar.plugins.javascript.api.JavaScriptCheck

getContext

Constructor Detail

DoubleDispatchVisitorCheck

public DoubleDispatchVisitorCheck()

Method Detail

scanFile

public List<Issue> scanFile(TreeVisitorContext context)

Specified by:

scanFile in interface JavaScriptCheck

addLineIssue

public LineIssue addLineIssue(Tree tree,
                     String message)

Description copied from interface: JavaScriptCheck

This method should be deprecated, as soon as this plugin will be migrated on 5.X LTS (with support of precise issue locations).

Instead please use JavaScriptCheck.addIssue(Tree, String)

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 (when listed below methods don't meet your needs). E.g. you can use this method to add issue on file level, line issue knowing only line number (i.e. not having tree instance) or precise issue with sophisticated primary location.

Otherwise please use:

• JavaScriptCheck.addIssue(Tree, String) for precise issue (see PreciseIssue)
• JavaScriptCheck.addLineIssue(Tree, String) for line issue (see LineIssue)

Specified by:

addIssue in interface JavaScriptCheck