Class UnusedGroupNamesCheck

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.UnusedGroupNamesCheck

All Implemented Interfaces:

RegexCheck, JavaCheck, JavaFileScanner

public class UnusedGroupNamesCheck
extends AbstractRegexCheckTrackingMatchers

Nested Class Summary

Nested classes/interfaces inherited from interface RegexCheck

RegexCheck.RegexIssueLocation

Field Summary

Fields inherited from class AbstractRegexCheck

JAVA_LANG_STRING, LANG3_REGEX_UTILS, METHODS_IMPLYING_DOT_ALL_FLAG, REGEX_METHODS, REGEX_ON_THE_SECOND_ARGUMENT_METHODS

Modifier and Type	Field	Description
protected static final String	JAVA_LANG_STRING
protected static final String	LANG3_REGEX_UTILS
protected static final MethodMatchers	METHODS_IMPLYING_DOT_ALL_FLAG
protected static final MethodMatchers	REGEX_METHODS
protected static final MethodMatchers	REGEX_ON_THE_SECOND_ARGUMENT_METHODS

Fields inherited from class SubscriptionVisitor

context

Constructor Summary

Constructors

Constructor	Description
UnusedGroupNamesCheck()

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 MethodMatchers	trackedMethodMatchers()	The methods for which we want to know whether they're invoked on the given regex.

Methods inherited from class AbstractRegexCheckTrackingMatchers

checkRegex, leaveNode, nodesToVisit, onMethodInvocationFound, visitNode

Modifier and Type	Method	Description
void	checkRegex(org.sonarsource.analyzer.commons.regex.RegexParseResult regexForLiterals, ExpressionTree methodInvocationOrAnnotation)
void	leaveNode(Tree tree)
List<Tree.Kind>	nodesToVisit()
protected void	onMethodInvocationFound(MethodInvocationTree mit)
void	visitNode(Tree tree)

Methods inherited from class AbstractRegexCheck

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

Modifier and Type	Method	Description
protected boolean	filterAnnotation(AnnotationTree annotation)
protected static Optional<ExpressionTree>	getFinalVariableInitializer(IdentifierTree identifier)
protected static Optional<ExpressionTree>	getFlagsTree(ExpressionTree methodInvocationOrAnnotation)
protected static Optional<LiteralTree[]>	getLiterals(ExpressionTree expr)
protected MethodMatchers	getMethodInvocationMatchers()
protected ExpressionTree	getRegexLiteralExpression(ExpressionTree methodInvocationOrAnnotation)
Tree	methodOrAnnotationName(ExpressionTree methodInvocationOrAnnotation)
protected void	onAnnotationFound(AnnotationTree annotation)
protected final org.sonarsource.analyzer.commons.regex.RegexParseResult	regexForLiterals(org.sonarsource.analyzer.commons.regex.ast.FlagSet flags, LiteralTree... literals)
final void	reportIssue(Tree javaTree, String message, Integer cost, List<RegexCheck.RegexIssueLocation> secondaries)
final void	reportIssue(org.sonarsource.analyzer.commons.regex.ast.RegexSyntaxElement regexTree, String message, Integer cost, List<RegexCheck.RegexIssueLocation> secondaries)
final void	reportIssueFromCommons(org.sonarsource.analyzer.commons.regex.ast.RegexSyntaxElement regexTree, String message, Integer cost, List<org.sonarsource.analyzer.commons.regex.RegexIssueLocation> secondaries)
final void	setContext(JavaFileScannerContext context)

Methods inherited from class IssuableSubscriptionVisitor

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

Methods inherited from class SubscriptionVisitor

visitToken, visitTrivia

Methods inherited from class Object

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

Methods inherited from interface JavaFileScanner

scanWithoutParsing

Constructor Details

UnusedGroupNamesCheck

public UnusedGroupNamesCheck()

Method Details

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.