org.opendaylight.yangtools.checkstyle

Class CheckLoggingUtil

java.lang.Object

org.opendaylight.yangtools.checkstyle.CheckLoggingUtil

public final class CheckLoggingUtil
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	LOGGER_TYPE_FULL_NAME
static String	LOGGER_TYPE_NAME
static String	LOGGER_VAR_NAME

Method Summary

Modifier and Type	Method and Description
static String	getClassName(com.puppycrawl.tools.checkstyle.api.DetailAST ast) Returns the name of the closest enclosing class of the point by the passed-in abstract syntax tree (AST).
static String	getMethodName(com.puppycrawl.tools.checkstyle.api.DetailAST ast) Returns the name the method (and the enclosing class) at a given point specified by the passed-in abstract syntax tree (AST).
static String	getTypeName(com.puppycrawl.tools.checkstyle.api.DetailAST ast)
static String	getVariableName(com.puppycrawl.tools.checkstyle.api.DetailAST ast)
static boolean	isAFieldVariable(com.puppycrawl.tools.checkstyle.api.DetailAST ast)
static boolean	isLoggerType(com.puppycrawl.tools.checkstyle.api.DetailAST ast)
static boolean	isLogMethod(String methodName)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOGGER_TYPE_NAME

public static final String LOGGER_TYPE_NAME

LOGGER_TYPE_FULL_NAME

public static final String LOGGER_TYPE_FULL_NAME

LOGGER_VAR_NAME

public static final String LOGGER_VAR_NAME

See Also:

Constant Field Values

Method Detail

getTypeName

public static String getTypeName(com.puppycrawl.tools.checkstyle.api.DetailAST ast)

isLoggerType

public static boolean isLoggerType(com.puppycrawl.tools.checkstyle.api.DetailAST ast)

getVariableName

public static String getVariableName(com.puppycrawl.tools.checkstyle.api.DetailAST ast)

isAFieldVariable

public static boolean isAFieldVariable(com.puppycrawl.tools.checkstyle.api.DetailAST ast)

getMethodName

public static String getMethodName(com.puppycrawl.tools.checkstyle.api.DetailAST ast)

Returns the name the method (and the enclosing class) at a given point specified by the passed-in abstract syntax tree (AST).

Parameters:

ast - an abstract syntax tree (AST) pointing to method call

Returns:

the name of the method being called

isLogMethod

public static boolean isLogMethod(String methodName)

getClassName

public static String getClassName(com.puppycrawl.tools.checkstyle.api.DetailAST ast)

Returns the name of the closest enclosing class of the point by the passed-in abstract syntax tree (AST).

Parameters:

ast - an abstract syntax tree (AST)

Returns:

the name of the closest enclosign class