common/checkstyle-logging/src/main/java/org/opendaylight/yangtools/checkstyle/LoggerFactoryClassParameterCheck.java

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8
   9 package org.opendaylight.yangtools.checkstyle;
  10
  11 import com.puppycrawl.tools.checkstyle.api.AbstractCheck;
  12 import com.puppycrawl.tools.checkstyle.api.DetailAST;
  13 import com.puppycrawl.tools.checkstyle.api.TokenTypes;
  14 import java.util.Optional;
  15
  16 public class LoggerFactoryClassParameterCheck extends AbstractCheck {
  17
  18     private static final String LOG_MESSAGE = "LoggerFactory.getLogger Class argument is incorrect.";
  19     private static final String METHOD_NAME = "LoggerFactory.getLogger";
  20     private static final int[] TOKENS = { TokenTypes.METHOD_CALL };
  21
  22     @Override
  23     public int[] getDefaultTokens() {
  24         return TOKENS;
  25     }
  26
  27     @Override
  28     public int[] getAcceptableTokens() {
  29         return TOKENS;
  30     }
  31
  32     @Override
  33     public int[] getRequiredTokens() {
  34         return TOKENS;
  35     }
  36
  37     @Override
  38     public void visitToken(final DetailAST ast) {
  39         final String methodName = CheckLoggingUtil.getMethodName(ast);
  40         if (methodName.equals(METHOD_NAME)) {
  41             final String className = CheckLoggingUtil.getClassName(ast);
  42             final Optional<String> optLoggerArgument = getFirstArgument(ast);
  43             if (optLoggerArgument.isPresent()) {
  44                 if (!optLoggerArgument.get().equals(className)) {
  45                     log(ast.getLineNo(), LOG_MESSAGE);
  46                 }
  47             } else {
  48                 log(ast.getLineNo(),
  49                         String.format("Invalid parameter in \"getLogger\" method call in class: %s", className));
  50             }
  51         }
  52     }
  53
  54     protected Optional<String> getFirstArgument(final DetailAST ast) {
  55         final DetailAST findFirstToken = ast.findFirstToken(TokenTypes.ELIST);
  56         if (findFirstToken != null) {
  57             DetailAST childToken = findFirstToken.getFirstChild();
  58             if (childToken != null) {
  59                 childToken = childToken.getFirstChild();
  60                 if (childToken != null) {
  61                     childToken = childToken.getFirstChild();
  62                     if (childToken != null) {
  63                         return Optional.of(childToken.getText());
  64                     }
  65                 }
  66             }
  67         }
  68         return Optional.empty();
  69     }
  70
  71 }