org.sonar.javascript.se

Class SeCheck

java.lang.Object

org.sonar.javascript.se.SeCheck

All Implemented Interfaces:

JavaScriptCheck

public class SeCheck
extends Object
implements JavaScriptCheck

Constructor Summary

Constructors

Constructor and Description
SeCheck()

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).
void	afterBlockElement(ProgramState currentState, Tree element)
void	beforeBlockElement(ProgramState currentState, Tree element)
void	checkConditions(Map<Tree,Collection<Truthiness>> conditions)
void	endOfExecution(Scope functionScope) Method is called when the execution finished before reaching limit
List<Issue>	scanFile(TreeVisitorContext context)
void	startOfExecution(Scope functionScope)

Methods inherited from class java.lang.Object

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

Constructor Detail

SeCheck

public SeCheck()

Method Detail

checkConditions

public void checkConditions(Map<Tree,Collection<Truthiness>> conditions)

beforeBlockElement

public void beforeBlockElement(ProgramState currentState,
                      Tree element)

afterBlockElement

public void afterBlockElement(ProgramState currentState,
                     Tree element)

endOfExecution

public void endOfExecution(Scope functionScope)

Method is called when the execution finished before reaching limit

startOfExecution

public void startOfExecution(Scope functionScope)

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

scanFile

public List<Issue> scanFile(TreeVisitorContext context)

Specified by:

scanFile in interface JavaScriptCheck