New LogMessageExtractorCheck which writes out TXT report of all loggers

[yangtools.git] / common / checkstyle-logging / src / main / java / org / opendaylight / yangtools / checkstyle / LogMessagePlaceholderCountCheck.java

diff --git a/common/checkstyle-logging/src/main/java/org/opendaylight/yangtools/checkstyle/LogMessagePlaceholderCountCheck.java b/common/checkstyle-logging/src/main/java/org/opendaylight/yangtools/checkstyle/LogMessagePlaceholderCountCheck.java
index bb28bccf07c8b7c59073829bc74b02bd5e965450..7c0ceec95000facc9a8cec0a8119f8b75adc0eca 100644 (file)
--- a/common/checkstyle-logging/src/main/java/org/opendaylight/yangtools/checkstyle/LogMessagePlaceholderCountCheck.java
+++ b/common/checkstyle-logging/src/main/java/org/opendaylight/yangtools/checkstyle/LogMessagePlaceholderCountCheck.java
@@ -8,35 +8,25 @@
 
 package org.opendaylight.yangtools.checkstyle;
 
-import com.puppycrawl.tools.checkstyle.api.Check;
 import com.puppycrawl.tools.checkstyle.api.DetailAST;
 import com.puppycrawl.tools.checkstyle.api.TokenTypes;
 
-public class LogMessagePlaceholderCountCheck extends Check {
+public class LogMessagePlaceholderCountCheck extends AbstractLogMessageCheck {
 
     private static final String LOG_MESSAGE = "Log message placeholders count is incorrect.";
     private static final String PLACEHOLDER = "{}";
     private static final String EXCEPTION_TYPE = "Exception";
 
     @Override
-    public int[] getDefaultTokens() {
-        return new int[]{TokenTypes.METHOD_CALL};
-    }
-
-    @Override
-    public void visitToken(DetailAST aAST) {
-        final String methodName = CheckLoggingUtil.getMethodName(aAST);
-        if(CheckLoggingUtil.isLogMethod(methodName)) {
-            final String logMessage = aAST.findFirstToken(TokenTypes.ELIST).getFirstChild().getFirstChild().getText();
-            int placeholdersCount = placeholdersCount(logMessage);
-            int argumentsCount = aAST.findFirstToken(TokenTypes.ELIST).getChildCount(TokenTypes.EXPR) - 1;
-            final String lastArg = aAST.findFirstToken(TokenTypes.ELIST).getLastChild().getFirstChild().getText();
-            if(hasCatchBlockParentWithArgument(lastArg, aAST) || hasMethodDefinitionWithExceptionArgument(lastArg, aAST)) {
-                argumentsCount--;
-            }
-            if(placeholdersCount > argumentsCount) {
-                log(aAST.getLineNo(), LOG_MESSAGE);
-            }
+    protected void visitLogMessage(DetailAST ast, String logMessage) {
+        int placeholdersCount = placeholdersCount(logMessage);
+        int argumentsCount = ast.findFirstToken(TokenTypes.ELIST).getChildCount(TokenTypes.EXPR) - 1;
+        final String lastArg = ast.findFirstToken(TokenTypes.ELIST).getLastChild().getFirstChild().getText();
+        if (hasCatchBlockParentWithArgument(lastArg, ast) || hasMethodDefinitionWithExceptionArgument(lastArg, ast)) {
+            argumentsCount--;
+        }
+        if (placeholdersCount > argumentsCount) {
+            log(ast.getLineNo(), LOG_MESSAGE);
         }
     }
 
@@ -44,48 +34,46 @@ public class LogMessagePlaceholderCountCheck extends Check {
         return (message.length() - message.replace(PLACEHOLDER, "").length()) / PLACEHOLDER.length();
     }
 
-    private boolean hasCatchBlockParentWithArgument(final String argumentName, final DetailAST aAST) {
-        DetailAST parent = aAST.getParent();
-        while(parent != null && parent.getType() != TokenTypes.LITERAL_CATCH) {
+    private boolean hasCatchBlockParentWithArgument(final String argumentName, final DetailAST ast) {
+        DetailAST parent = ast.getParent();
+        while (parent != null && parent.getType() != TokenTypes.LITERAL_CATCH) {
             parent = parent.getParent();
         }
-        if(parent != null) {
-            if(parent.findFirstToken(TokenTypes.PARAMETER_DEF) != null &&
-                    parent.findFirstToken(TokenTypes.PARAMETER_DEF).findFirstToken(TokenTypes.IDENT).getText().equals(argumentName)) {
-                return true;
-            }
+        if (parent != null && parent.findFirstToken(TokenTypes.PARAMETER_DEF) != null
+                && parent.findFirstToken(TokenTypes.PARAMETER_DEF).findFirstToken(TokenTypes.IDENT).getText()
+                        .equals(argumentName)) {
+            return true;
         }
         return false;
     }
 
-    private boolean hasMethodDefinitionWithExceptionArgument(final String argumentName, final DetailAST aAST) {
-        DetailAST parent = aAST.getParent();
-        while(parent != null && parent.getType() != TokenTypes.METHOD_DEF) {
+    private boolean hasMethodDefinitionWithExceptionArgument(final String argumentName, final DetailAST ast) {
+        DetailAST parent = ast.getParent();
+        while (parent != null && parent.getType() != TokenTypes.METHOD_DEF) {
             parent = parent.getParent();
         }
-        if(parent != null) {
-            if(parent.findFirstToken(TokenTypes.PARAMETERS).findFirstToken(TokenTypes.PARAMETER_DEF) != null) {
-                DetailAST paramDef = parent.findFirstToken(TokenTypes.PARAMETERS).getFirstChild();
-                while(paramDef != null) {
-                    if(paramDef.getType() == TokenTypes.PARAMETER_DEF) {
-                        final String paramName = paramDef.findFirstToken(TokenTypes.IDENT).getText();
-                        if(paramName.equals(argumentName) && isExceptionType(paramDef)) {
-                            return true;
-                        }
+        if (parent != null && parent.findFirstToken(TokenTypes.PARAMETERS).findFirstToken(TokenTypes.PARAMETER_DEF)
+                != null) {
+            DetailAST paramDef = parent.findFirstToken(TokenTypes.PARAMETERS).getFirstChild();
+            while (paramDef != null) {
+                if (paramDef.getType() == TokenTypes.PARAMETER_DEF) {
+                    final String paramName = paramDef.findFirstToken(TokenTypes.IDENT).getText();
+                    if (paramName.equals(argumentName) && isExceptionType(paramDef)) {
+                        return true;
                     }
-                    paramDef = paramDef.getNextSibling();
                 }
+                paramDef = paramDef.getNextSibling();
             }
         }
         return false;
     }
 
     private boolean isExceptionType(final DetailAST parameterDef) {
-        if(parameterDef != null) {
+        if (parameterDef != null) {
             final DetailAST type = parameterDef.findFirstToken(TokenTypes.TYPE);
-            if(type != null && type.findFirstToken(TokenTypes.IDENT) != null) {
+            if (type != null && type.findFirstToken(TokenTypes.IDENT) != null) {
                 final String argumentType = type.findFirstToken(TokenTypes.IDENT).getText();
-                if(argumentType.contains(EXCEPTION_TYPE)) {
+                if (argumentType.contains(EXCEPTION_TYPE)) {
                     return true;
                 }
             }