public abstract class AbstractJavadocCheck extends Check
Constructor and Description |
---|
AbstractJavadocCheck() |
Modifier and Type | Method and Description |
---|---|
void |
beginJavadocTree(DetailNode rootAst)
Called before the starting to process a tree.
|
void |
beginTree(DetailAST rootAST)
Called before the starting to process a tree.
|
void |
finishJavadocTree(DetailNode rootAst)
Called after finished processing a tree.
|
void |
finishTree(DetailAST rootAST)
Called after finished processing a tree.
|
int[] |
getAcceptableTokens()
Defined final to not allow JavadocChecks to change acceptable tokens.
|
protected DetailAST |
getBlockCommentAst() |
abstract int[] |
getDefaultJavadocTokens()
Returns the default token types a check is interested in.
|
int[] |
getDefaultTokens()
Defined final to not allow JavadocChecks to change default tokens.
|
int[] |
getRequiredTokens()
Defined final to not allow JavadocChecks to change required tokens.
|
boolean |
isCommentNodesRequired()
Defined final because all JavadocChecks require comment nodes.
|
void |
leaveJavadocToken(DetailNode ast)
Called after all the child nodes have been process.
|
void |
leaveToken(DetailAST ast)
Called after all the child nodes have been process.
|
void |
visitJavadocToken(DetailNode ast)
Called to process a Javadoc token.
|
void |
visitToken(DetailAST blockCommentAst)
Called to process a token.
|
destroy, getClassLoader, getFileContents, getLine, getLines, getTabWidth, getTokenNames, init, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens
getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, log, setId, setSeverity
configure, contextualize, finishLocalSetup, getConfiguration, setupChild
public AbstractJavadocCheck()
public abstract int[] getDefaultJavadocTokens()
JavadocTokenTypes
public void beginJavadocTree(DetailNode rootAst)
rootAst
- the root of the treepublic void finishJavadocTree(DetailNode rootAst)
rootAst
- the root of the treepublic void visitJavadocToken(DetailNode ast)
ast
- the token to processpublic void leaveJavadocToken(DetailNode ast)
ast
- the token leavingpublic final int[] getDefaultTokens()
getDefaultTokens
in class Check
TokenTypes
public final int[] getAcceptableTokens()
getAcceptableTokens
in class Check
TokenTypes
public final int[] getRequiredTokens()
getRequiredTokens
in class Check
TokenTypes
public final boolean isCommentNodesRequired()
isCommentNodesRequired
in class Check
public final void beginTree(DetailAST rootAST)
Check
public final void finishTree(DetailAST rootAST)
Check
finishTree
in class Check
rootAST
- the root of the treepublic final void leaveToken(DetailAST ast)
Check
leaveToken
in class Check
ast
- the token leavingpublic final void visitToken(DetailAST blockCommentAst)
Check
visitToken
in class Check
blockCommentAst
- the token to processprotected DetailAST getBlockCommentAst()
Copyright © 2001–2015. All rights reserved.