org.sonar.plugins.javascript.api.visitors

Interface TreeVisitorContext

All Known Implementing Classes:

TestCheckContext

@Beta
public interface TreeVisitorContext

Method Summary

Methods

Modifier and Type	Method and Description
void	addFileIssue(JavaScriptCheck check, String message) Creates an issue at a file level.
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, IssueLocation location, List<IssueLocation> secondaryLocations, Double cost)
void	addIssue(JavaScriptCheck check, Tree tree, String message) Creates an issue.
void	addIssue(JavaScriptCheck check, Tree tree, String message, double cost) Creates an issue.
int	getComplexity(Tree tree)
File	getFile()
String[]	getPropertyValues(String name) Fetch project property
SymbolModel	getSymbolModel()
ScriptTree	getTopTree()

Method Detail

getTopTree

ScriptTree getTopTree()

Returns:

the top tree node of the current file AST representation.

addIssue

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

Creates an issue.

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

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

Creates an issue.

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

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

Creates an issue.

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

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

Creates an issue.

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

addIssue

void addIssue(JavaScriptCheck check,
            IssueLocation location,
            List<IssueLocation> secondaryLocations,
            Double cost)

addFileIssue

void addFileIssue(JavaScriptCheck check,
                String message)

Creates an issue at a file level.

Parameters:

check - instance of the check that create the issue

message - the issue message

getFile

File getFile()

Returns:

the current file

getSymbolModel

SymbolModel getSymbolModel()

Returns:

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

getPropertyValues

String[] getPropertyValues(String name)

Fetch project property

Parameters:

name - property key

Returns:

the value for the given key

getComplexity

int getComplexity(Tree tree)