2 * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
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
9 package org.opendaylight.yangtools.checkstyle;
11 import com.google.common.collect.Lists;
12 import com.puppycrawl.tools.checkstyle.api.DetailAST;
13 import com.puppycrawl.tools.checkstyle.api.FullIdent;
14 import com.puppycrawl.tools.checkstyle.api.TokenTypes;
15 import com.puppycrawl.tools.checkstyle.utils.CheckUtils;
16 import java.util.List;
17 import org.slf4j.Logger;
19 public final class CheckLoggingUtil {
21 public static final String LOGGER_TYPE_NAME = Logger.class.getSimpleName();
22 public static final String LOGGER_TYPE_FULL_NAME = Logger.class.getName();
23 public static final String LOGGER_VAR_NAME = "LOG";
24 private static final List<String> LOG_METHODS =
25 Lists.newArrayList("LOG.debug", "LOG.info", "LOG.error", "LOG.warn", "LOG.trace");
27 private CheckLoggingUtil() {
28 throw new UnsupportedOperationException("Utility class should not be instantiated!");
31 public static String getTypeName(final DetailAST ast) {
32 final FullIdent ident = CheckUtils.createFullType(ast.findFirstToken(TokenTypes.TYPE));
33 return ident.getText();
36 public static boolean isLoggerType(final DetailAST ast) {
37 final String typeName = getTypeName(ast);
38 return typeName.equals(LOGGER_TYPE_FULL_NAME) || typeName.equals(LOGGER_TYPE_NAME);
41 public static String getVariableName(final DetailAST ast) {
42 DetailAST identifier = ast.findFirstToken(TokenTypes.IDENT);
43 return identifier.getText();
46 public static boolean isAFieldVariable(final DetailAST ast) {
47 return ast.getParent().getType() == TokenTypes.OBJBLOCK;
50 public static String getMethodName(final DetailAST ast) {
51 if (ast.getFirstChild().getLastChild() != null) {
52 return ast.getFirstChild().getFirstChild().getText() + "." + ast.getFirstChild().getLastChild().getText();
54 return ast.getFirstChild().getText();
57 public static boolean isLogMethod(final String methodName) {
58 return LOG_METHODS.contains(methodName);
61 public static String getClassName(final DetailAST ast) {
62 DetailAST parent = ast.getParent();
63 while (parent.getType() != TokenTypes.CLASS_DEF && parent.getType() != TokenTypes.ENUM_DEF) {
64 parent = parent.getParent();
66 return parent.findFirstToken(TokenTypes.IDENT).getText();