org.sonar.javascript.checks

Class AbstractAnyPathSeCheck

java.lang.Object

org.sonar.javascript.se.SeCheck

org.sonar.javascript.checks.AbstractAnyPathSeCheck

All Implemented Interfaces:

JavaScriptCheck

Direct Known Subclasses:

ArrayCallbackWithoutReturnCheck, ArrayReverseCheck, CallabilityCheck, InOperatorTypeErrorCheck, NonExistentPropertyAccessCheck, NonNumberInArithmeticExpressionCheck, ReturnValueNotIgnoredCheck, TooManyArgumentsCheck, ValuesNotConvertibleToNumbersCheck

public abstract class AbstractAnyPathSeCheck
extends SeCheck

Base class for check classes which must ensure that the same issue is never raised more than once for the same tree.

Constructor Summary

Constructors

Constructor and Description
AbstractAnyPathSeCheck()

Method Summary

Modifier and Type	Method and Description
<T extends Issue> T	addIssue(T issue)
PreciseIssue	addIssue(Tree tree, String message) Subclasses should not use this function, as this function bypasses the non-duplication mechanism implemented by this class.
Optional<PreciseIssue>	addUniqueIssue(Tree tree, String message) Creates an issue for the specified tree and message, then adds the issue to the list of issues.
Optional<PreciseIssue>	addUniqueIssue(Tree tree, String message, IssueLocation... secondaryLocations) Same contract as method addIssue(Tree, String).
Optional<PreciseIssue>	addUniqueIssue(Tree tree, String message, Tree... secondaryLocations) Same contract as method addIssue(Tree, String).
boolean	alreadyHasIssueOn(Tree tree) Returns true if an issue has already been reported for the specified tree.
void	doStartOfExecution(Scope functionScope) Override this method to perform actions before the start of execution.
void	startOfExecution(Scope functionScope)

Methods inherited from class org.sonar.javascript.se.SeCheck

addLineIssue, afterBlockElement, beforeBlockElement, checkConditions, cleanupAndStartFileAnalysis, endOfExecution, endOfFile, getContext, scanFile, setContext, startOfFile, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractAnyPathSeCheck

public AbstractAnyPathSeCheck()

Method Detail

startOfExecution

public final void startOfExecution(Scope functionScope)

Overrides:

startOfExecution in class SeCheck

doStartOfExecution

public void doStartOfExecution(Scope functionScope)

Override this method to perform actions before the start of execution. This method is called for each execution, i.e. for each function in the file. Note this method is called even if the execution limit was reached later.

Parameters:

functionScope - scope corresponding to the function which will be executed

addIssue

public final PreciseIssue addIssue(Tree tree,
                                   String message)

Subclasses should not use this function, as this function bypasses the non-duplication mechanism implemented by this class. They should use one of the addUniqueIssue(org.sonar.plugins.javascript.api.tree.Tree, java.lang.String) methods.

Specified by:

addIssue in interface JavaScriptCheck

Overrides:

addIssue in class SeCheck

addIssue

public final <T extends Issue> T addIssue(T issue)

Specified by:

addIssue in interface JavaScriptCheck

Overrides:

addIssue in class SeCheck

addUniqueIssue

public Optional<PreciseIssue> addUniqueIssue(Tree tree,
                                             String message)

Creates an issue for the specified tree and message, then adds the issue to the list of issues. Does nothing if an issue has already been added for the specified tree.

Returns:

the created issue, or nothing if no issue was created

addUniqueIssue

public Optional<PreciseIssue> addUniqueIssue(Tree tree,
                                             String message,
                                             Tree... secondaryLocations)

Same contract as method addIssue(Tree, String).

addUniqueIssue

public Optional<PreciseIssue> addUniqueIssue(Tree tree,
                                             String message,
                                             IssueLocation... secondaryLocations)

Same contract as method addIssue(Tree, String).

alreadyHasIssueOn

public boolean alreadyHasIssueOn(Tree tree)

Returns true if an issue has already been reported for the specified tree. This method does not have to be invoked prior to invoking method addUniqueIssue(org.sonar.plugins.javascript.api.tree.Tree, java.lang.String): this method is just an optimization tool that allows subclasses not to perform useless operations when an issue has already been reported.