Conform to our own Checkstyle rules in checkstyle-logging utility
[yangtools.git] / common / checkstyle-logging / src / main / java / org / opendaylight / yangtools / checkstyle / CheckLoggingUtil.java
index 0747a85e0adb7ca07f3a5d69d181d519f8f9a258..1c5a6e970c43d7565599a8b72f49425c673113fb 100644 (file)
@@ -16,53 +16,53 @@ import com.google.common.collect.Lists;
 import com.puppycrawl.tools.checkstyle.api.DetailAST;
 import com.puppycrawl.tools.checkstyle.api.FullIdent;
 import com.puppycrawl.tools.checkstyle.api.TokenTypes;
-import com.puppycrawl.tools.checkstyle.checks.CheckUtils;
+import com.puppycrawl.tools.checkstyle.utils.CheckUtils;
 
-public class CheckLoggingUtil {
+public final class CheckLoggingUtil {
 
     public static final String LOGGER_TYPE_NAME = Logger.class.getSimpleName();
     public static final String LOGGER_TYPE_FULL_NAME = Logger.class.getName();
     public static final String LOGGER_VAR_NAME = "LOG";
-    private static final List<String> LOG_METHODS = Lists.newArrayList("debug", "info", "error", "warn", "trace");
+    private static final List<String> LOG_METHODS =
+            Lists.newArrayList("LOG.debug", "LOG.info", "LOG.error", "LOG.warn", "LOG.trace");
 
-    private CheckLoggingUtil() {}
+    private 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);
-        if(typeName.equals(LOGGER_TYPE_FULL_NAME) || typeName.equals(LOGGER_TYPE_NAME)) {
-            return true;
-        }
-        return false;
+    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().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();
-        while(parent.getType() != TokenTypes.CLASS_DEF && parent.getType() != TokenTypes.ENUM_DEF) {
+    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();
         }
         return parent.findFirstToken(TokenTypes.IDENT).getText();