Package org.sonar.java.checks.regex

Class AbstractRegexCheckTrackingMatchType

java.lang.Object

org.sonar.java.ast.visitors.SubscriptionVisitor

org.sonar.plugins.java.api.IssuableSubscriptionVisitor

org.sonar.java.checks.regex.AbstractRegexCheck

org.sonar.java.checks.regex.AbstractRegexCheckTrackingMatchers

org.sonar.java.checks.regex.AbstractRegexCheckTrackingMatchType

All Implemented Interfaces:

RegexCheck, JavaCheck, JavaFileScanner

Direct Known Subclasses:

RedosCheck, RegexLookaheadCheck, ReluctantQuantifierWithEmptyContinuationCheck

public abstract class AbstractRegexCheckTrackingMatchType
extends AbstractRegexCheckTrackingMatchers

Nested Class Summary

Nested classes/interfaces inherited from interface org.sonar.java.regex.RegexCheck

RegexCheck.RegexIssueLocation

Field Summary

Fields inherited from class org.sonar.java.checks.regex.AbstractRegexCheck

JAVA_LANG_STRING, LANG3_REGEX_UTILS, METHODS_IMPLYING_DOT_ALL_FLAG, REGEX_METHODS, REGEX_ON_THE_SECOND_ARGUMENT_METHODS

Fields inherited from class org.sonar.java.ast.visitors.SubscriptionVisitor

context

Constructor Summary

Constructors

Constructor	Description
AbstractRegexCheckTrackingMatchType()

Method Summary

Modifier and Type	Method	Description
protected void	checkRegex(org.sonarsource.analyzer.commons.regex.RegexParseResult regexForLiterals, ExpressionTree methodInvocationOrAnnotation, List<MethodInvocationTree> trackedMethodsCalled, boolean didEscape)
protected abstract void	checkRegex(org.sonarsource.analyzer.commons.regex.RegexParseResult regex, ExpressionTree methodInvocationOrAnnotation, org.sonarsource.analyzer.commons.regex.MatchType matchType)
protected MethodMatchers	trackedMethodMatchers()	The methods for which we want to know whether they're invoked on the given regex.

Methods inherited from class org.sonar.java.checks.regex.AbstractRegexCheckTrackingMatchers

checkRegex, leaveNode, nodesToVisit, onMethodInvocationFound, visitNode

Methods inherited from class org.sonar.java.checks.regex.AbstractRegexCheck

filterAnnotation, getFinalVariableInitializer, getFlagsTree, getLiterals, getMethodInvocationMatchers, getRegexLiteralExpression, methodOrAnnotationName, onAnnotationFound, regexForLiterals, reportIssue, reportIssue, reportIssueFromCommons, setContext

Methods inherited from class org.sonar.plugins.java.api.IssuableSubscriptionVisitor

addIssue, addIssueOnFile, leaveFile, reportIssue, reportIssue, reportIssue, scanFile, scanTree

Methods inherited from class org.sonar.java.ast.visitors.SubscriptionVisitor

visitToken, visitTrivia

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.sonar.plugins.java.api.JavaFileScanner

scanWithoutParsing

Constructor Details

AbstractRegexCheckTrackingMatchType

public AbstractRegexCheckTrackingMatchType()

Method Details

checkRegex

protected abstract void checkRegex(org.sonarsource.analyzer.commons.regex.RegexParseResult regex,
 ExpressionTree methodInvocationOrAnnotation,
 org.sonarsource.analyzer.commons.regex.MatchType matchType)

trackedMethodMatchers

protected MethodMatchers trackedMethodMatchers()

Description copied from class: AbstractRegexCheckTrackingMatchers

The methods for which we want to know whether they're invoked on the given regex. These should either be methods of the Pattern or Matcher class or part of REGEX_METHODS.

Specified by:

trackedMethodMatchers in class AbstractRegexCheckTrackingMatchers

checkRegex

protected void checkRegex(org.sonarsource.analyzer.commons.regex.RegexParseResult regexForLiterals,
 ExpressionTree methodInvocationOrAnnotation,
 List<MethodInvocationTree> trackedMethodsCalled,
 boolean didEscape)

Specified by:

checkRegex in class AbstractRegexCheckTrackingMatchers

Parameters:

regexForLiterals - The regex to be checked

methodInvocationOrAnnotation - The method invocation or annotation that the regex string is passed to

trackedMethodsCalled - The list of method invocations performed on the Pattern or Matcher object associated with the regex (only taking into account methods returned by trackedMethodMatchers)

didEscape - Whether or not the regex escaped the method in which it was created (via return, being assigned to a non-local variable or being passed to a different method). If true, trackedMethodsCalled may not be exhaustive.