common/checkstyle-logging/src/main/java/org/opendaylight/yangtools/checkstyle/LogMessageConcatenationCheck.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
  15 public class LogMessageConcatenationCheck extends AbstractCheck {
  16
  17     private static final String LOG_MESSAGE = "Log message contains string concatenation.";
  18     private static final int[] TOKENS = { TokenTypes.METHOD_CALL };
  19
  20     @Override
  21     public int[] getDefaultTokens() {
  22         return TOKENS;
  23     }
  24
  25     @Override
  26     public int[] getAcceptableTokens() {
  27         return TOKENS;
  28     }
  29
  30     @Override
  31     public int[] getRequiredTokens() {
  32         return TOKENS;
  33     }
  34
  35     @Override
  36     public void visitToken(final DetailAST ast) {
  37         final String methodName = CheckLoggingUtil.getMethodName(ast);
  38         if (CheckLoggingUtil.isLogMethod(methodName)) {
  39             DetailAST plus = ast.findFirstToken(TokenTypes.ELIST).getFirstChild().findFirstToken(TokenTypes.PLUS);
  40             if (plus != null) {
  41                 while (plus.getChildCount(TokenTypes.PLUS) != 0) {
  42                     plus = plus.findFirstToken(TokenTypes.PLUS);
  43                 }
  44                 if (plus.getChildCount(TokenTypes.STRING_LITERAL) != 2) {
  45                     log(ast.getLineNo(), LOG_MESSAGE);
  46                 }
  47             }
  48         }
  49     }
  50 }