Package org.sonar.java.checks

Class AbstractPrintfChecker

java.lang.Object

org.sonar.java.ast.visitors.SubscriptionVisitor

org.sonar.plugins.java.api.IssuableSubscriptionVisitor

org.sonar.java.checks.methods.AbstractMethodDetection

org.sonar.java.checks.AbstractPrintfChecker

All Implemented Interfaces:

JavaCheck, JavaFileScanner

Direct Known Subclasses:

PrintfFailCheck, PrintfMisuseCheck

public abstract class AbstractPrintfChecker
extends AbstractMethodDetection

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	JAVA_LANG_STRING
protected static final String	JAVA_LANG_THROWABLE
protected static final Set<String>	LEVELS
protected static final MethodMatchers	MESSAGE_FORMAT
protected static final Pattern	MESSAGE_FORMAT_PATTERN
protected static final Predicate<String>	MESSAGE_FORMAT_PATTERN_PREDICATE
protected static final String	ORG_APACHE_LOGGING_LOG4J_LOGGER
protected static final String	PRINTF_METHOD_NAME
protected static final MethodMatchers	STRING_FORMATTED

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

context

Constructor Summary

Constructors

Constructor	Description
AbstractPrintfChecker()

Method Summary

Modifier and Type	Method	Description
protected static Set<Integer>	argIndexes(List<String> params)
protected boolean	checkArgumentNumber(MethodInvocationTree mit, int nbReadParams, int nbArgs)
protected final void	checkFormatting(MethodInvocationTree mit, boolean isMessageFormat)
protected static String	cleanupDoubleQuote(String formatString)
protected static void	cleanupLineSeparator(List<String> params)
protected static Integer	getIndex(String param)
protected static Set<Integer>	getMessageFormatIndexes(String formatString, MethodInvocationTree mit)
protected MethodMatchers	getMethodInvocationMatchers()
protected List<String>	getParameters(String formatString, MethodInvocationTree mit)
protected abstract void	handleMessageFormat(MethodInvocationTree mit, String formatString, List<ExpressionTree> args)
protected abstract void	handleOtherFormatTree(MethodInvocationTree mit, ExpressionTree formatTree, List<ExpressionTree> args)
protected abstract void	handlePrintfFormat(MethodInvocationTree mit, String formatString, List<ExpressionTree> args)
protected abstract void	handlePrintfFormatCatchingErrors(MethodInvocationTree mit, String formatString, List<ExpressionTree> args)
protected static boolean	isNewArrayWithInitializers(ExpressionTree expression)
protected void	reportMissingPrevious(MethodInvocationTree mit)
protected static Optional<List<ExpressionTree>>	transposeArgumentArray(List<ExpressionTree> args)
protected void	verifyParametersForErrors(MethodInvocationTree mit, List<ExpressionTree> args, List<String> params)

Methods inherited from class org.sonar.java.checks.methods.AbstractMethodDetection

nodesToVisit, onConstructorFound, onMethodInvocationFound, onMethodReferenceFound, visitNode

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

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

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

leaveNode, 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

Field Details

JAVA_LANG_STRING

protected static final String JAVA_LANG_STRING

See Also:

• Constant Field Values

JAVA_LANG_THROWABLE

protected static final String JAVA_LANG_THROWABLE

See Also:

• Constant Field Values

ORG_APACHE_LOGGING_LOG4J_LOGGER

protected static final String ORG_APACHE_LOGGING_LOG4J_LOGGER

See Also:

• Constant Field Values

PRINTF_METHOD_NAME

protected static final String PRINTF_METHOD_NAME

See Also:

• Constant Field Values

LEVELS

protected static final Set<String> LEVELS

MESSAGE_FORMAT

protected static final MethodMatchers MESSAGE_FORMAT

STRING_FORMATTED

protected static final MethodMatchers STRING_FORMATTED

MESSAGE_FORMAT_PATTERN

protected static final Pattern MESSAGE_FORMAT_PATTERN

MESSAGE_FORMAT_PATTERN_PREDICATE

protected static final Predicate<String> MESSAGE_FORMAT_PATTERN_PREDICATE

Constructor Details

AbstractPrintfChecker

public AbstractPrintfChecker()

Method Details

getMethodInvocationMatchers

protected MethodMatchers getMethodInvocationMatchers()

Specified by:

getMethodInvocationMatchers in class AbstractMethodDetection

checkFormatting

protected final void checkFormatting(MethodInvocationTree mit,
 boolean isMessageFormat)

transposeArgumentArray

protected static Optional<List<ExpressionTree>> transposeArgumentArray(List<ExpressionTree> args)

handlePrintfFormat

protected abstract void handlePrintfFormat(MethodInvocationTree mit,
 String formatString,
 List<ExpressionTree> args)

handlePrintfFormatCatchingErrors

protected abstract void handlePrintfFormatCatchingErrors(MethodInvocationTree mit,
 String formatString,
 List<ExpressionTree> args)

handleMessageFormat

protected abstract void handleMessageFormat(MethodInvocationTree mit,
 String formatString,
 List<ExpressionTree> args)

handleOtherFormatTree

protected abstract void handleOtherFormatTree(MethodInvocationTree mit,
 ExpressionTree formatTree,
 List<ExpressionTree> args)

isNewArrayWithInitializers

protected static boolean isNewArrayWithInitializers(ExpressionTree expression)

cleanupDoubleQuote

protected static String cleanupDoubleQuote(String formatString)

getMessageFormatIndexes

protected static Set<Integer> getMessageFormatIndexes(String formatString,
 MethodInvocationTree mit)

getParameters

protected List<String> getParameters(String formatString,
 MethodInvocationTree mit)

reportMissingPrevious

protected void reportMissingPrevious(MethodInvocationTree mit)

getIndex

protected static Integer getIndex(String param)

cleanupLineSeparator

protected static void cleanupLineSeparator(List<String> params)

argIndexes

protected static Set<Integer> argIndexes(List<String> params)

checkArgumentNumber

protected boolean checkArgumentNumber(MethodInvocationTree mit,
 int nbReadParams,
 int nbArgs)

verifyParametersForErrors

protected void verifyParametersForErrors(MethodInvocationTree mit,
 List<ExpressionTree> args,
 List<String> params)