public abstract class AbstractJavadocCheck extends AbstractCheck
Modifier and Type | Field and Description |
---|---|
static String |
MSG_JAVADOC_MISSED_HTML_CLOSE
Message key of error message.
|
static String |
MSG_JAVADOC_PARSE_RULE_ERROR
Parse error while rule recognition.
|
static String |
MSG_JAVADOC_WRONG_SINGLETON_TAG
Message key of error message.
|
static String |
MSG_KEY_PARSE_ERROR
Error message key for common javadoc errors.
|
static String |
MSG_KEY_UNRECOGNIZED_ANTLR_ERROR
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 MSG_JAVADOC_MISSED_HTML_CLOSE
"no viable alternative at input 'b \n *\n'"
and it is not
clear that error is about missed close HTML tag.public static final String MSG_JAVADOC_WRONG_SINGLETON_TAG
public static final String MSG_JAVADOC_PARSE_RULE_ERROR
public static final String MSG_KEY_PARSE_ERROR
public static final String MSG_KEY_UNRECOGNIZED_ANTLR_ERROR
public AbstractJavadocCheck()
public abstract int[] getDefaultJavadocTokens()
JavadocTokenTypes
public abstract void visitJavadocToken(DetailNode ast)
ast
- the token to processpublic void beginJavadocTree(DetailNode rootAst)
rootAst
- the root of the treepublic void finishJavadocTree(DetailNode rootAst)
rootAst
- the root of the treepublic void leaveJavadocToken(DetailNode ast)
ast
- the token leavingpublic final int[] getDefaultTokens()
getDefaultTokens
in class AbstractCheck
TokenTypes
public final boolean isCommentNodesRequired()
isCommentNodesRequired
in class AbstractCheck
public final void beginTree(DetailAST rootAST)
AbstractCheck
beginTree
in class AbstractCheck
rootAST
- the root of the treepublic final void finishTree(DetailAST rootAST)
AbstractCheck
finishTree
in class AbstractCheck
rootAST
- the root of the treepublic final void visitToken(DetailAST blockCommentNode)
AbstractCheck
visitToken
in class AbstractCheck
blockCommentNode
- the token to processprotected DetailAST getBlockCommentAst()
Copyright © 2001–2016. All rights reserved.