Conform to our own Checkstyle rules in checkstyle-logging utility

This seems like a sensible start, to make even our own Checkstyle custom
rules code conform to our other Checkstyle rules? ;-)

Change-Id: I746aba394590e3bf6df873be10ac6e4e87e6ea87
Signed-off-by: Michael Vorburger <vorburger@redhat.com>

diff --git a/common/checkstyle-logging/src/main/java/org/opendaylight/yangtools/checkstyle/CheckLoggingUtil.java b/common/checkstyle-logging/src/main/java/org/opendaylight/yangtools/checkstyle/CheckLoggingUtil.java
index 17e98a547e36bad0485a933d80ee6769affaff12..1c5a6e970c43d7565599a8b72f49425c673113fb 100644 (file)
--- a/common/checkstyle-logging/src/main/java/org/opendaylight/yangtools/checkstyle/CheckLoggingUtil.java
+++ b/common/checkstyle-logging/src/main/java/org/opendaylight/yangtools/checkstyle/CheckLoggingUtil.java
@@ -30,38 +30,38 @@ public final class CheckLoggingUtil {
         throw new UnsupportedOperationException("Utility class should not be instantiated!");
     }
 
-    public static String getTypeName(final DetailAST aAST) {
-        final FullIdent ident = CheckUtils.createFullType(aAST.findFirstToken(TokenTypes.TYPE));
+    public static String getTypeName(final DetailAST ast) {
+        final FullIdent ident = CheckUtils.createFullType(ast.findFirstToken(TokenTypes.TYPE));
         return ident.getText();
     }
 
-    public static boolean isLoggerType(final DetailAST aAST) {
-        final String typeName = getTypeName(aAST);
+    public static boolean isLoggerType(final DetailAST ast) {
+        final String typeName = getTypeName(ast);
         return typeName.equals(LOGGER_TYPE_FULL_NAME) || typeName.equals(LOGGER_TYPE_NAME);
     }
 
-    public static String getVariableName(final DetailAST aAST) {
-        DetailAST identifier = aAST.findFirstToken(TokenTypes.IDENT);
+    public static String getVariableName(final DetailAST ast) {
+        DetailAST identifier = ast.findFirstToken(TokenTypes.IDENT);
         return identifier.getText();
     }
 
-    public static boolean isAFieldVariable(final DetailAST aAST) {
-        return aAST.getParent().getType() == TokenTypes.OBJBLOCK;
+    public static boolean isAFieldVariable(final DetailAST ast) {
+        return ast.getParent().getType() == TokenTypes.OBJBLOCK;
     }
 
-    public static String getMethodName(final DetailAST aAST) {
-        if (aAST.getFirstChild().getLastChild() != null) {
-            return aAST.getFirstChild().getFirstChild().getText() + "." + aAST.getFirstChild().getLastChild().getText();
+    public static String getMethodName(final DetailAST ast) {
+        if (ast.getFirstChild().getLastChild() != null) {
+            return ast.getFirstChild().getFirstChild().getText() + "." + ast.getFirstChild().getLastChild().getText();
         }
-        return aAST.getFirstChild().getText();
+        return ast.getFirstChild().getText();
     }
 
     public static boolean isLogMethod(final String methodName) {
         return LOG_METHODS.contains(methodName);
     }
 
-    public static String getClassName(final DetailAST aAST) {
-        DetailAST parent = aAST.getParent();
+    public static String getClassName(final DetailAST ast) {
+        DetailAST parent = ast.getParent();
         while (parent.getType() != TokenTypes.CLASS_DEF && parent.getType() != TokenTypes.ENUM_DEF) {
             parent = parent.getParent();
         }

diff --git a/common/checkstyle-logging/src/main/java/org/opendaylight/yangtools/checkstyle/LogMessageConcatenationCheck.java b/common/checkstyle-logging/src/main/java/org/opendaylight/yangtools/checkstyle/LogMessageConcatenationCheck.java
index d078ba7e306dec9e1acb2632451f07058dd3dc01..650a704c68ad02587c36140aefaffd953bb59ea0 100644 (file)
--- a/common/checkstyle-logging/src/main/java/org/opendaylight/yangtools/checkstyle/LogMessageConcatenationCheck.java
+++ b/common/checkstyle-logging/src/main/java/org/opendaylight/yangtools/checkstyle/LogMessageConcatenationCheck.java
@@ -22,16 +22,16 @@ public class LogMessageConcatenationCheck extends Check {
     }
 
     @Override
-    public void visitToken(DetailAST aAST) {
-        final String methodName = CheckLoggingUtil.getMethodName(aAST);
-        if(CheckLoggingUtil.isLogMethod(methodName)) {
-            DetailAST plus = aAST.findFirstToken(TokenTypes.ELIST).getFirstChild().findFirstToken(TokenTypes.PLUS);
+    public void visitToken(DetailAST ast) {
+        final String methodName = CheckLoggingUtil.getMethodName(ast);
+        if (CheckLoggingUtil.isLogMethod(methodName)) {
+            DetailAST plus = ast.findFirstToken(TokenTypes.ELIST).getFirstChild().findFirstToken(TokenTypes.PLUS);
             if (plus != null) {
                 while (plus.getChildCount(TokenTypes.PLUS) != 0) {
                     plus = plus.findFirstToken(TokenTypes.PLUS);
                 }
                 if (plus.getChildCount(TokenTypes.STRING_LITERAL) != 2) {
-                    log(aAST.getLineNo(), LOG_MESSAGE);
+                    log(ast.getLineNo(), LOG_MESSAGE);
                 }
             }
         }

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 4735b1b1e4980b0a9a88b422fbc4b880fe8bc87f..1adf5408f24868142a8a85d2b79253ef5cd96dd2 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
@@ -24,19 +24,19 @@ public class LogMessagePlaceholderCountCheck extends Check {
     }
 
     @Override
-    public void visitToken(DetailAST aAST) {
-        final String methodName = CheckLoggingUtil.getMethodName(aAST);
+    public void visitToken(DetailAST ast) {
+        final String methodName = CheckLoggingUtil.getMethodName(ast);
         if (CheckLoggingUtil.isLogMethod(methodName)) {
-            final String logMessage = aAST.findFirstToken(TokenTypes.ELIST).getFirstChild().getFirstChild().getText();
+            final String logMessage = ast.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)) {
+            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(aAST.getLineNo(), LOG_MESSAGE);
+                log(ast.getLineNo(), LOG_MESSAGE);
             }
         }
     }
@@ -45,28 +45,28 @@ 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 && parent.findFirstToken(TokenTypes.PARAMETER_DEF) != null &&
-                parent.findFirstToken(TokenTypes.PARAMETER_DEF).findFirstToken(TokenTypes.IDENT).getText().equals
-                        (argumentName)) {
+        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 && parent.findFirstToken(TokenTypes.PARAMETERS).findFirstToken(TokenTypes.PARAMETER_DEF)
                 != null) {
             DetailAST paramDef = parent.findFirstToken(TokenTypes.PARAMETERS).getFirstChild();
-            while(paramDef != null) {
+            while (paramDef != null) {
                 if (paramDef.getType() == TokenTypes.PARAMETER_DEF) {
                     final String paramName = paramDef.findFirstToken(TokenTypes.IDENT).getText();
                     if (paramName.equals(argumentName) && isExceptionType(paramDef)) {

diff --git a/common/checkstyle-logging/src/main/java/org/opendaylight/yangtools/checkstyle/LoggerDeclarationsCountCheck.java b/common/checkstyle-logging/src/main/java/org/opendaylight/yangtools/checkstyle/LoggerDeclarationsCountCheck.java
index 51bbe3e06e10ab27b1424cf36ff080abe208a724..304572d476178c56cc2db7c166f91677dc07f4ec 100644 (file)
--- a/common/checkstyle-logging/src/main/java/org/opendaylight/yangtools/checkstyle/LoggerDeclarationsCountCheck.java
+++ b/common/checkstyle-logging/src/main/java/org/opendaylight/yangtools/checkstyle/LoggerDeclarationsCountCheck.java
@@ -25,19 +25,19 @@ public class LoggerDeclarationsCountCheck extends Check {
     }
 
     @Override
-    public void visitToken(DetailAST aAST) {
-        if (CheckLoggingUtil.isLoggerType(aAST) && isAFieldVariable(aAST)) {
-            final String className = CheckLoggingUtil.getClassName(aAST);
-            if(this.prevClassName.equals(className)) {
-                log(aAST.getLineNo(), LOG_MESSAGE);
+    public void visitToken(DetailAST ast) {
+        if (CheckLoggingUtil.isLoggerType(ast) && isAFieldVariable(ast)) {
+            final String className = CheckLoggingUtil.getClassName(ast);
+            if (this.prevClassName.equals(className)) {
+                log(ast.getLineNo(), LOG_MESSAGE);
             }
             this.prevClassName = className;
         }
     }
 
     @Override
-    public void finishTree(DetailAST aRootAST) {
-        super.finishTree(aRootAST);
+    public void finishTree(DetailAST rootAST) {
+        super.finishTree(rootAST);
         this.prevClassName = "";
     }
 

diff --git a/common/checkstyle-logging/src/main/java/org/opendaylight/yangtools/checkstyle/LoggerFactoryClassParameterCheck.java b/common/checkstyle-logging/src/main/java/org/opendaylight/yangtools/checkstyle/LoggerFactoryClassParameterCheck.java
index 4fb0af6ece05053a4b54b68e5e2fb548b2f3d051..5be0e18f467b25ecc09a667b8538a5b8a1d72967 100644 (file)
--- a/common/checkstyle-logging/src/main/java/org/opendaylight/yangtools/checkstyle/LoggerFactoryClassParameterCheck.java
+++ b/common/checkstyle-logging/src/main/java/org/opendaylight/yangtools/checkstyle/LoggerFactoryClassParameterCheck.java
@@ -23,18 +23,18 @@ public class LoggerFactoryClassParameterCheck extends Check {
     }
 
     @Override
-    public void visitToken(DetailAST aAST) {
-        final String methodName = CheckLoggingUtil.getMethodName(aAST);
-        if(methodName.equals(METHOD_NAME)) {
-            final String className = CheckLoggingUtil.getClassName(aAST);
+    public void visitToken(DetailAST ast) {
+        final String methodName = CheckLoggingUtil.getMethodName(ast);
+        if (methodName.equals(METHOD_NAME)) {
+            final String className = CheckLoggingUtil.getClassName(ast);
             try {
-                final String token = aAST.findFirstToken(TokenTypes.ELIST).getFirstChild().getFirstChild()
+                final String token = ast.findFirstToken(TokenTypes.ELIST).getFirstChild().getFirstChild()
                     .getFirstChild().getText();
                 if (!token.equals(className)) {
-                    log(aAST.getLineNo(), LOG_MESSAGE);
+                    log(ast.getLineNo(), LOG_MESSAGE);
                 }
             } catch (NullPointerException e) {
-                log(aAST.getLineNo(), String.format("Invalid parameter in \"getLogger\" method call in class: %s",
+                log(ast.getLineNo(), String.format("Invalid parameter in \"getLogger\" method call in class: %s",
                     className));
             }
         }

diff --git a/common/checkstyle-logging/src/main/java/org/opendaylight/yangtools/checkstyle/LoggerMustBeSlf4jCheck.java b/common/checkstyle-logging/src/main/java/org/opendaylight/yangtools/checkstyle/LoggerMustBeSlf4jCheck.java
index a8a25f5448f84bfa8d80a12dec8dbef6e3419b44..46d0d17c3eec5dfac2644d8db1eeb058e2f2094a 100644 (file)
--- a/common/checkstyle-logging/src/main/java/org/opendaylight/yangtools/checkstyle/LoggerMustBeSlf4jCheck.java
+++ b/common/checkstyle-logging/src/main/java/org/opendaylight/yangtools/checkstyle/LoggerMustBeSlf4jCheck.java
@@ -26,22 +26,22 @@ public class LoggerMustBeSlf4jCheck extends Check {
     }
 
     @Override
-    public void visitToken(DetailAST aAST) {
-        if (aAST.getType() == TokenTypes.VARIABLE_DEF) {
-            if (CheckLoggingUtil.isAFieldVariable(aAST)) {
-                final String typeName = CheckLoggingUtil.getTypeName(aAST);
+    public void visitToken(DetailAST ast) {
+        if (ast.getType() == TokenTypes.VARIABLE_DEF) {
+            if (CheckLoggingUtil.isAFieldVariable(ast)) {
+                final String typeName = CheckLoggingUtil.getTypeName(ast);
                 if (typeName.contains("." + LOGGER_TYPE_NAME) && !typeName.equals(LOGGER_TYPE_FULL_NAME)) {
-                    log(aAST.getLineNo(), LOG_MESSAGE);
+                    log(ast.getLineNo(), LOG_MESSAGE);
                 }
             }
-        } else if (aAST.getType() == TokenTypes.IMPORT) {
-            final DetailAST typeToken = aAST.getFirstChild().findFirstToken(TokenTypes.IDENT);
+        } else if (ast.getType() == TokenTypes.IMPORT) {
+            final DetailAST typeToken = ast.getFirstChild().findFirstToken(TokenTypes.IDENT);
             if (typeToken != null) {
                 final String importType = typeToken.getText();
                 if (CheckLoggingUtil.LOGGER_TYPE_NAME.equals(importType)) {
-                    final String importIdent = aAST.getFirstChild().getFirstChild().getLastChild().getText();
+                    final String importIdent = ast.getFirstChild().getFirstChild().getLastChild().getText();
                     if (!importIdent.equals(SLF4J)) {
-                        log(aAST.getLineNo(), LOG_MESSAGE);
+                        log(ast.getLineNo(), LOG_MESSAGE);
                     }
                 }
             }

diff --git a/common/checkstyle-logging/src/main/java/org/opendaylight/yangtools/checkstyle/LoggerVariableModifiersCheck.java b/common/checkstyle-logging/src/main/java/org/opendaylight/yangtools/checkstyle/LoggerVariableModifiersCheck.java
index 126041b47fe8ff4da5b34c95a40f4d42da68591b..2076d44381510160f748dbce6863381beae12fa4 100644 (file)
--- a/common/checkstyle-logging/src/main/java/org/opendaylight/yangtools/checkstyle/LoggerVariableModifiersCheck.java
+++ b/common/checkstyle-logging/src/main/java/org/opendaylight/yangtools/checkstyle/LoggerVariableModifiersCheck.java
@@ -22,17 +22,17 @@ public class LoggerVariableModifiersCheck extends Check {
     }
 
     @Override
-    public void visitToken(DetailAST aAST) {
-        if (CheckLoggingUtil.isAFieldVariable(aAST) && CheckLoggingUtil.isLoggerType(aAST)
-                && !hasPrivatStaticFinalModifier(aAST)) {
-            log(aAST.getLineNo(), LOG_MESSAGE);
+    public void visitToken(DetailAST ast) {
+        if (CheckLoggingUtil.isAFieldVariable(ast) && CheckLoggingUtil.isLoggerType(ast)
+                && !hasPrivatStaticFinalModifier(ast)) {
+            log(ast.getLineNo(), LOG_MESSAGE);
         }
     }
 
-    private boolean hasPrivatStaticFinalModifier(DetailAST aAST) {
-        DetailAST modifiers = aAST.findFirstToken(TokenTypes.MODIFIERS);
-        if (modifiers != null && modifiers.branchContains(TokenTypes.LITERAL_PRIVATE) && modifiers.branchContains
-                    (TokenTypes.LITERAL_STATIC) && modifiers.branchContains(TokenTypes.FINAL)) {
+    private boolean hasPrivatStaticFinalModifier(DetailAST ast) {
+        DetailAST modifiers = ast.findFirstToken(TokenTypes.MODIFIERS);
+        if (modifiers != null && modifiers.branchContains(TokenTypes.LITERAL_PRIVATE)
+                && modifiers.branchContains(TokenTypes.LITERAL_STATIC) && modifiers.branchContains(TokenTypes.FINAL)) {
             return true;
         }
         return false;

diff --git a/common/checkstyle-logging/src/main/java/org/opendaylight/yangtools/checkstyle/LoggerVariableNameCheck.java b/common/checkstyle-logging/src/main/java/org/opendaylight/yangtools/checkstyle/LoggerVariableNameCheck.java
index 6e69da05880c0762b7ce52a185db85bca624571b..8d7243c7da65c809e528ae23c21505295734495a 100644 (file)
--- a/common/checkstyle-logging/src/main/java/org/opendaylight/yangtools/checkstyle/LoggerVariableNameCheck.java
+++ b/common/checkstyle-logging/src/main/java/org/opendaylight/yangtools/checkstyle/LoggerVariableNameCheck.java
@@ -24,10 +24,10 @@ public class LoggerVariableNameCheck extends Check {
     }
 
     @Override
-    public void visitToken(DetailAST aAST) {
-        if (CheckLoggingUtil.isAFieldVariable(aAST) && CheckLoggingUtil.isLoggerType(aAST)
-                && !LOGGER_VAR_NAME.equals(CheckLoggingUtil.getVariableName(aAST))) {
-            log(aAST.getLineNo(), LOG_MESSAGE);
+    public void visitToken(DetailAST ast) {
+        if (CheckLoggingUtil.isAFieldVariable(ast) && CheckLoggingUtil.isLoggerType(ast)
+                && !LOGGER_VAR_NAME.equals(CheckLoggingUtil.getVariableName(ast))) {
+            log(ast.getLineNo(), LOG_MESSAGE);
         }
     }