com.puppycrawl.tools.checkstyle.checks.j2ee

Class MethodChecker

public abstract class MethodChecker extends Object

Root class for method checks for a client Check.

Author: Rick Giles

Constructor Summary
MethodChecker(AbstractJ2eeCheck aCheck)
Constructs a MethodChecker.
Method Summary
abstract voidcheckMethod(DetailAST aMethodAST)
Checks whether a method satisfies component requirements.
voidcheckMethod(DetailAST aMethodAST, boolean aAllowFinal)
Checks whether a method satisfies public, non-static, and final requirements.
voidcheckMethods(DetailAST aAST)
Checks that the methods of a component satisfy requirements.
protected voidcheckNotThrows(DetailAST aMethodAST, String aException)
Checks that the throws clause of a method definition does no include an Exception.
protected voidcheckThrows(DetailAST aMethodAST, String aException)
Checks that the throws clause of a method definition includes an Exception.
protected AbstractJ2eeCheckgetCheck()
Gets the client Check.
protected voidlog(DetailAST aMethodAST, String aKey, Object[] aArgs)
Logs an error message for a method.
protected voidlogName(DetailAST aMethodAST, String aKey, Object[] aArgs)
Logs an error message for a method, including the method name.

Constructor Detail

MethodChecker

public MethodChecker(AbstractJ2eeCheck aCheck)
Constructs a MethodChecker.

Parameters: aCheck the client Check.

Method Detail

checkMethod

public abstract void checkMethod(DetailAST aMethodAST)
Checks whether a method satisfies component requirements.

Parameters: aMethodAST the AST for the method definition.

checkMethod

public void checkMethod(DetailAST aMethodAST, boolean aAllowFinal)
Checks whether a method satisfies public, non-static, and final requirements.

Parameters: aMethodAST AST for the method definition. aAllowFinal true if the method may be final.

checkMethods

public void checkMethods(DetailAST aAST)
Checks that the methods of a component satisfy requirements.

Parameters: aAST the AST for the component definition.

checkNotThrows

protected void checkNotThrows(DetailAST aMethodAST, String aException)
Checks that the throws clause of a method definition does no include an Exception.

Parameters: aMethodAST the AST for the method definition. aException the name of the Exception to check.

checkThrows

protected void checkThrows(DetailAST aMethodAST, String aException)
Checks that the throws clause of a method definition includes an Exception.

Parameters: aMethodAST the AST for the method definition. aException the name of the Exception to check.

getCheck

protected AbstractJ2eeCheck getCheck()
Gets the client Check.

Returns: the client Check.

log

protected void log(DetailAST aMethodAST, String aKey, Object[] aArgs)
Logs an error message for a method.

Parameters: aMethodAST the AST for the method definition. aKey key for message. aArgs message arguments.

logName

protected void logName(DetailAST aMethodAST, String aKey, Object[] aArgs)
Logs an error message for a method, including the method name.

Parameters: aMethodAST the AST for the method definition. aKey key for message. aArgs message arguments.