public class IllegalTokenTextCheck extends AbstractFormatCheck
Checks for illegal token text.
An example of how to configure the check to forbid String literals
containing "a href"
is:
<module name="IllegalTokenText"> <property name="tokens" value="STRING_LITERAL"/> <property name="format" value="a href"/> </module>
An example of how to configure the check to forbid leading zeros in an integer literal, other than zero and a hex literal is:
<module name="IllegalTokenText"> <property name="tokens" value="NUM_INT,NUM_LONG"/> <property name="format" value="^0[^lx]"/> <property name="ignoreCase" value="true"/> </module>
Constructor and Description |
---|
IllegalTokenTextCheck()
Instantiates a new instance.
|
Modifier and Type | Method and Description |
---|---|
void |
beginTree(DetailAST aRootAST)
Called before the starting to process a tree.
|
int[] |
getAcceptableTokens()
The configurable token set.
|
int[] |
getDefaultTokens()
Returns the default token a check is interested in.
|
String |
getMessage()
Getter for message property.
|
void |
setIgnoreCase(boolean aCaseInsensitive)
Set whether or not the match is case sensitive.
|
void |
setMessage(String aMessage)
Setter for message property.
|
void |
visitToken(DetailAST aAST)
Called to process a token.
|
getFormat, getRegexp, setCompileFlags, setFormat
destroy, finishTree, getClassLoader, getFileContents, 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 IllegalTokenTextCheck()
public void beginTree(DetailAST aRootAST)
Check
public int[] getDefaultTokens()
Check
getDefaultTokens
in class Check
TokenTypes
public int[] getAcceptableTokens()
Check
getAcceptableTokens
in class Check
TokenTypes
public void visitToken(DetailAST aAST)
Check
visitToken
in class Check
aAST
- the token to processpublic void setMessage(String aMessage)
aMessage
- custom message which should be used
to report about violations.public String getMessage()
public void setIgnoreCase(boolean aCaseInsensitive)
aCaseInsensitive
- true if the match is case insensitive.Copyright © 2001–2015. All rights reserved.