org.sonar.plugins.javascript.api.tests

Class TestCheckContext

java.lang.Object

org.sonar.plugins.javascript.api.tests.TestCheckContext

All Implemented Interfaces:

TreeVisitorContext

public class TestCheckContext
extends Object
implements TreeVisitorContext

Field Summary

Fields

Modifier and Type	Field and Description
protected static com.sonar.sslr.api.typed.ActionParser<Tree>	p

Constructor Summary

Constructors

Constructor and Description
TestCheckContext(File file, org.sonar.api.config.Settings settings, JavaScriptCheck check)

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()
List<org.sonar.squidbridge.api.CheckMessage>	getIssues()
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

Field Detail

p

protected static final com.sonar.sslr.api.typed.ActionParser<Tree> p

Constructor Detail

TestCheckContext

public TestCheckContext(File file,
                org.sonar.api.config.Settings settings,
                JavaScriptCheck check)

Method Detail

getTopTree

public ScriptTree getTopTree()

Specified by:

getTopTree in interface TreeVisitorContext

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: TreeVisitorContext

Creates an issue.

Specified by:

addIssue in interface TreeVisitorContext

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: TreeVisitorContext

Creates an issue.

Specified by:

addIssue in interface TreeVisitorContext

Parameters:

check - instance of the check that create the issue

line - source line on which the issue should be raised

message - the issue message

addFileIssue

public void addFileIssue(JavaScriptCheck check,
                String message)

Description copied from interface: TreeVisitorContext

Creates an issue at a file level.

Specified by:

addFileIssue in interface TreeVisitorContext

Parameters:

check - instance of the check that create the issue

message - the issue message

addIssue

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

Description copied from interface: TreeVisitorContext

Creates an issue.

Specified by:

addIssue in interface TreeVisitorContext

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: TreeVisitorContext

Creates an issue.

Specified by:

addIssue in interface TreeVisitorContext

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

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

Specified by:

addIssue in interface TreeVisitorContext

getFile

public File getFile()

Specified by:

getFile in interface TreeVisitorContext

Returns:

the current file

getSymbolModel

public SymbolModel getSymbolModel()

Specified by:

getSymbolModel in interface TreeVisitorContext

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: TreeVisitorContext

Fetch project property

Specified by:

getPropertyValues in interface TreeVisitorContext

Parameters:

name - property key

Returns:

the value for the given key

getComplexity

public int getComplexity(Tree tree)

Specified by:

getComplexity in interface TreeVisitorContext

getIssues

public List<org.sonar.squidbridge.api.CheckMessage> getIssues()