|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.puppycrawl.tools.checkstyle.checks.j2ee.MethodChecker
public abstract class MethodChecker
Root class for method checks for a client Check.
Constructor Summary | |
---|---|
MethodChecker(AbstractJ2eeCheck aCheck)
Constructs a MethodChecker . |
Method Summary | |
---|---|
abstract 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. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public MethodChecker(AbstractJ2eeCheck aCheck)
MethodChecker
.
aCheck
- the client Check.Method Detail |
---|
protected AbstractJ2eeCheck getCheck()
public void checkMethods(DetailAST aAST)
aAST
- the AST for the component definition.public abstract void checkMethod(DetailAST aMethodAST)
aMethodAST
- the AST for the method definition.public void checkMethod(DetailAST aMethodAST, boolean aAllowFinal)
aMethodAST
- AST for the method definition.aAllowFinal
- true if the method may be final.protected void checkThrows(DetailAST aMethodAST, String aException)
aMethodAST
- the AST for the method definition.aException
- the name of the Exception to check.protected void checkNotThrows(DetailAST aMethodAST, String aException)
aMethodAST
- the AST for the method definition.aException
- the name of the Exception to check.protected void log(DetailAST aMethodAST, String aKey, Object[] aArgs)
aMethodAST
- the AST for the method definition.aKey
- key for message.aArgs
- message arguments.protected void logName(DetailAST aMethodAST, String aKey, Object[] aArgs)
aMethodAST
- the AST for the method definition.aKey
- key for message.aArgs
- message arguments.
|
Back to the Checkstyle Home Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |