|
||||||||||
| 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.AbstractFormatCheck
com.puppycrawl.tools.checkstyle.checks.coding.IllegalTokenTextCheck
public class IllegalTokenTextCheck
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 Summary | |
|---|---|
IllegalTokenTextCheck()
Instantiates a new instance. |
|
| Method Summary | |
|---|---|
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. |
| Methods inherited from class com.puppycrawl.tools.checkstyle.checks.AbstractFormatCheck |
|---|
getFormat, getRegexp, setCompileFlags, setFormat |
| Methods inherited from class com.puppycrawl.tools.checkstyle.api.Check |
|---|
destroy, finishTree, getClassLoader, getFileContents, getLines, getRequiredTokens, getTabWidth, getTokenNames, init, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens |
| Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter |
|---|
getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, log, setId, 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 IllegalTokenTextCheck()
| Method Detail |
|---|
public void beginTree(DetailAST aRootAST)
Check
beginTree in class CheckaRootAST - the root of the treepublic int[] getDefaultTokens()
Check
getDefaultTokens in class CheckTokenTypespublic int[] getAcceptableTokens()
Check
getAcceptableTokens in class CheckTokenTypespublic void visitToken(DetailAST aAST)
Check
visitToken in class CheckaAST - 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.
|
Back to the Checkstyle Home Page | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||