com.puppycrawl.tools.checkstyle.checks.j2ee
Class MethodChecker
java.lang.Object
com.puppycrawl.tools.checkstyle.checks.j2ee.MethodChecker
public abstract class MethodChecker
extends java.lang.Object
Root class for method checks for a client Check.
- Rick Giles
void | checkMethod(DetailAST aMethodAST) - Checks whether a method satisfies component requirements.
|
void | checkMethod(DetailAST aMethodAST, boolean aAllowFinal) - Checks whether a method satisfies public, non-static, and final
requirements.
|
void | checkMethods(DetailAST aAST) - Checks that the methods of a component satisfy requirements.
|
protected void | checkNotThrows(DetailAST aMethodAST, String aException) - Checks that the throws clause of a method definition does no include an
Exception.
|
protected void | checkThrows(DetailAST aMethodAST, String aException) - Checks that the throws clause of a method definition includes an
Exception.
|
protected AbstractJ2eeCheck | getCheck() - Gets the client Check.
|
protected void | log(DetailAST aMethodAST, String aKey, Object[] aArgs) - Logs an error message for a method.
|
protected void | logName(DetailAST aMethodAST, String aKey, Object[] aArgs) - Logs an error message for a method, including the method name.
|
MethodChecker
public MethodChecker(AbstractJ2eeCheck aCheck)
Constructs a MethodChecker
.
aCheck
- the client Check.
checkMethod
public void checkMethod(DetailAST aMethodAST)
Checks whether a method satisfies component requirements.
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.
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.
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.
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.
aMethodAST
- the AST for the method definition.aException
- the name of the Exception to check.
getCheck
protected AbstractJ2eeCheck getCheck()
Gets the client Check.
- the client Check.
log
protected void log(DetailAST aMethodAST,
String aKey,
Object[] aArgs)
Logs an error message for a method.
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.
aMethodAST
- the AST for the method definition.aKey
- key for message.aArgs
- message arguments.