common/checkstyle-logging/src/main/java/org/opendaylight/yangtools/checkstyle/LoggerDeclarationsCountCheck.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.isAFieldVariable;
  12
  13 import com.puppycrawl.tools.checkstyle.api.AbstractCheck;
  14 import com.puppycrawl.tools.checkstyle.api.DetailAST;
  15 import com.puppycrawl.tools.checkstyle.api.TokenTypes;
  16
  17 public class LoggerDeclarationsCountCheck extends AbstractCheck {
  18
  19     private static final String LOG_MESSAGE = "Logger might be declared only once.";
  20     private static final int[] TOKENS = { TokenTypes.VARIABLE_DEF };
  21
  22     private String prevClassName = "";
  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 (CheckLoggingUtil.isLoggerType(ast) && isAFieldVariable(ast)) {
  42             final String className = CheckLoggingUtil.getClassName(ast);
  43             if (this.prevClassName.equals(className)) {
  44                 log(ast.getLineNo(), LOG_MESSAGE);
  45             }
  46             this.prevClassName = className;
  47         }
  48     }
  49
  50     @Override
  51     public void finishTree(final DetailAST rootAST) {
  52         super.finishTree(rootAST);
  53         this.prevClassName = "";
  54     }
  55 }