public abstract class AbstractJavadocCheck extends Check
Modifier and Type | Field and Description |
---|---|
static String |
PARSE_ERROR_MESSAGE_KEY
Error message key for common javadoc errors.
|
static String |
UNRECOGNIZED_ANTLR_ERROR_MESSAGE_KEY
Unrecognized error from antlr parser.
|
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.
|
protected DetailAST |
getBlockCommentAst()
Getter for block comment in Java language syntax tree.
|
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.
|
boolean |
isCommentNodesRequired()
Defined final because all JavadocChecks require comment nodes.
|
void |
leaveJavadocToken(DetailNode ast)
Called after all the child nodes have been process.
|
abstract void |
visitJavadocToken(DetailNode ast)
Called to process a Javadoc token.
|
void |
visitToken(DetailAST blockCommentNode)
Called to process a token.
|
destroy, getAcceptableTokens, getClassLoader, getFileContents, getLine, getLines, getRequiredTokens, getTabWidth, getTokenNames, init, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens
getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, log, setId, setSeverity
configure, contextualize, finishLocalSetup, getConfiguration, setupChild
public static final String PARSE_ERROR_MESSAGE_KEY
public static final String UNRECOGNIZED_ANTLR_ERROR_MESSAGE_KEY
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 abstract 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 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 visitToken(DetailAST blockCommentNode)
Check
visitToken
in class Check
blockCommentNode
- the token to processprotected DetailAST getBlockCommentAst()
Copyright © 2001–2015. All rights reserved.