common/checkstyle-logging/src/main/java/org/opendaylight/yangtools/checkstyle/LoggerMustBeSlf4jCheck.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 static org.opendaylight.yangtools.checkstyle.CheckLoggingUtil.LOGGER_TYPE_FULL_NAME;
  12 import static org.opendaylight.yangtools.checkstyle.CheckLoggingUtil.LOGGER_TYPE_NAME;
  13
  14 import com.puppycrawl.tools.checkstyle.api.AbstractCheck;
  15 import com.puppycrawl.tools.checkstyle.api.DetailAST;
  16 import com.puppycrawl.tools.checkstyle.api.TokenTypes;
  17
  18 public class LoggerMustBeSlf4jCheck extends AbstractCheck {
  19
  20     private static final String LOG_MESSAGE = "Logger must be slf4j.";
  21     private static final String SLF4J = "slf4j";
  22     private static final int[] TOKENS = { TokenTypes.VARIABLE_DEF, TokenTypes.IMPORT };
  23
  24     @Override
  25     public int[] getDefaultTokens() {
  26         return TOKENS;
  27     }
  28
  29     @Override
  30     public int[] getAcceptableTokens() {
  31         return TOKENS;
  32     }
  33
  34     @Override
  35     public int[] getRequiredTokens() {
  36         return TOKENS;
  37     }
  38
  39     @Override
  40     public void visitToken(final DetailAST ast) {
  41         if (ast.getType() == TokenTypes.VARIABLE_DEF) {
  42             if (CheckLoggingUtil.isAFieldVariable(ast)) {
  43                 final String typeName = CheckLoggingUtil.getTypeName(ast);
  44                 if (typeName.contains("." + LOGGER_TYPE_NAME) && !typeName.equals(LOGGER_TYPE_FULL_NAME)) {
  45                     log(ast.getLineNo(), LOG_MESSAGE);
  46                 }
  47             }
  48         } else if (ast.getType() == TokenTypes.IMPORT) {
  49             final DetailAST typeToken = ast.getFirstChild().findFirstToken(TokenTypes.IDENT);
  50             if (typeToken != null) {
  51                 final String importType = typeToken.getText();
  52                 if (CheckLoggingUtil.LOGGER_TYPE_NAME.equals(importType)) {
  53                     final String importIdent = ast.getFirstChild().getFirstChild().getLastChild().getText();
  54                     if (!importIdent.equals(SLF4J)) {
  55                         log(ast.getLineNo(), LOG_MESSAGE);
  56                     }
  57                 }
  58             }
  59         }
  60     }
  61 }