org.sonar.javascript.ast.visitors

Class AstTreeVisitorContextImpl

java.lang.Object

org.sonar.javascript.ast.visitors.AstTreeVisitorContextImpl

All Implemented Interfaces:

AstTreeVisitorContext

public class AstTreeVisitorContextImpl
extends Object
implements AstTreeVisitorContext

Constructor Summary

Constructors

Constructor and Description
AstTreeVisitorContextImpl(ScriptTree tree, org.sonar.squidbridge.api.SourceFile sourceFile, File file, SymbolModel symbolModel, org.sonar.api.config.Settings settings)

Method Summary

Methods

Modifier and Type	Method and Description
void	addIssue(JavaScriptCheck check, int line, String message) Creates an issue.
void	addIssue(JavaScriptCheck check, int line, String message, double cost) Creates an issue.
void	addIssue(JavaScriptCheck check, Tree tree, String message) Creates an issue.
void	addIssue(JavaScriptCheck check, Tree tree, String message, double cost) Creates an issue.
File	getFile()
String	getFileKey()
String[]	getPropertyValues(String name) Fetch project property
SymbolModel	getSymbolModel()
ScriptTree	getTopTree()

Methods inherited from class java.lang.Object

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

Constructor Detail

AstTreeVisitorContextImpl

public AstTreeVisitorContextImpl(ScriptTree tree,
                         org.sonar.squidbridge.api.SourceFile sourceFile,
                         File file,
                         SymbolModel symbolModel,
                         org.sonar.api.config.Settings settings)

Method Detail

getTopTree

public ScriptTree getTopTree()

Specified by:

getTopTree in interface AstTreeVisitorContext

Returns:

the top tree node of the current file AST representation.

addIssue

public void addIssue(JavaScriptCheck check,
            Tree tree,
            String message)

Description copied from interface: AstTreeVisitorContext

Creates an issue.

Specified by:

addIssue in interface AstTreeVisitorContext

Parameters:

check - instance of the check that creates the issue.

tree - the tree on which the issue should be raise. Means the issue will be raised on its corresponding line in the source code.

message - the issue message.

addIssue

public void addIssue(JavaScriptCheck check,
            int line,
            String message)

Description copied from interface: AstTreeVisitorContext

Creates an issue.

Specified by:

addIssue in interface AstTreeVisitorContext

Parameters:

check - instance of the check that create the issue

line - source line on which the issue should be raised

message - the issue message

addIssue

public void addIssue(JavaScriptCheck check,
            Tree tree,
            String message,
            double cost)

Description copied from interface: AstTreeVisitorContext

Creates an issue.

Specified by:

addIssue in interface AstTreeVisitorContext

Parameters:

check - instance of the check that create the issue

tree - the tree on which the issue should be raise. Means the issue will be raised on its corresponding line in the source code.

message - the issue message

cost - specific remediation cost for the issue, used to compute the technical debt

addIssue

public void addIssue(JavaScriptCheck check,
            int line,
            String message,
            double cost)

Description copied from interface: AstTreeVisitorContext

Creates an issue.

Specified by:

addIssue in interface AstTreeVisitorContext

Parameters:

check - instance of the check that create the issue

line - source line on which the issue should be raised

message - the issue message

cost - specific remediation cost for the issue, used to compute the technical debt

getFileKey

public String getFileKey()

Specified by:

getFileKey in interface AstTreeVisitorContext

Returns:

the current SonarQube file key

getFile

public File getFile()

Specified by:

getFile in interface AstTreeVisitorContext

Returns:

the current file

getSymbolModel

public SymbolModel getSymbolModel()

Specified by:

getSymbolModel in interface AstTreeVisitorContext

Returns:

the symbol model that allows to access the symbols declared in the current file

getPropertyValues

public String[] getPropertyValues(String name)

Description copied from interface: AstTreeVisitorContext

Fetch project property

Specified by:

getPropertyValues in interface AstTreeVisitorContext

Parameters:

name - property key

Returns:

the value for the given key