|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Objectcom.puppycrawl.tools.checkstyle.api.AutomaticBean
com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
com.puppycrawl.tools.checkstyle.api.Check
com.puppycrawl.tools.checkstyle.checks.usage.AbstractUsageCheck
Performs a usage check for fields, methods, parameters, variables.
| Constructor Summary | |
AbstractUsageCheck()
Constructs an AbstractUsageCheck. |
|
| Method Summary | |
void |
applyTo(java.util.Set aNodes)
Applies this check to a set of nodes. |
void |
beginTree(DetailAST aRootAST)
Called before the starting to process a tree. |
void |
finishTree(DetailAST aAST)
Called after finished processing a tree. |
protected com.puppycrawl.tools.checkstyle.checks.usage.transmogrify.ASTManager |
getASTManager()
Gets the manager for AST nodes. |
abstract java.lang.String |
getErrorKey()
Returns the key for the Checkstyle error message. |
java.lang.String |
getIgnoreFormat()
|
org.apache.regexp.RE |
getRegexp()
|
void |
logError(java.lang.Exception aException)
Logs an exception. |
abstract boolean |
mustCheckReferenceCount(DetailAST aAST)
Determines whether the reference count of an aAST is required. |
void |
setIgnoreFormat(java.lang.String aFormat)
Set the ignore format to the specified regular expression. |
void |
visitToken(DetailAST aAST)
Called to process a token. |
| Methods inherited from class com.puppycrawl.tools.checkstyle.api.Check |
destroy, getAcceptableTokens, getClassLoader, getDefaultTokens, getFileContents, getLines, getRequiredTokens, getTabWidth, getTokenNames, init, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens |
| Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter |
getMessageBundle, getSeverity, getSeverityLevel, log, log, log, log, log, log, log, log, log, setSeverity |
| Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean |
configure, contextualize, finishLocalSetup, getConfiguration, setupChild |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
public AbstractUsageCheck()
AbstractUsageCheck.
| Method Detail |
public void setIgnoreFormat(java.lang.String aFormat)
throws org.apache.commons.beanutils.ConversionException
aFormat - a String value
org.apache.commons.beanutils.ConversionException - unable to parse aFormatpublic org.apache.regexp.RE getRegexp()
public java.lang.String getIgnoreFormat()
public void beginTree(DetailAST aRootAST)
Check
beginTree in class CheckaRootAST - the root of the treeCheckpublic void visitToken(DetailAST aAST)
Check
visitToken in class CheckaAST - the token to processCheckpublic void finishTree(DetailAST aAST)
Check
finishTree in class CheckaAST - the root of the treeCheckpublic void logError(java.lang.Exception aException)
aException - the exception to log.public abstract java.lang.String getErrorKey()
public abstract boolean mustCheckReferenceCount(DetailAST aAST)
aAST - the node to check.
public void applyTo(java.util.Set aNodes)
aNodes - the nodes to check.protected com.puppycrawl.tools.checkstyle.checks.usage.transmogrify.ASTManager getASTManager()
|
Back to the Checkstyle Home Page | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||