com.puppycrawl.tools.checkstyle.checks.coding

Class IllegalTokenTextCheck

Implemented Interfaces:
Configurable, Contextualizable

public class IllegalTokenTextCheck
extends GenericIllegalRegexpCheck

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>
 

Author:
Rick Giles

Method Summary

void
beginTree(DetailAST aRootAST)
int[]
getAcceptableTokens()
void
visitToken(DetailAST aAST)

Methods inherited from class com.puppycrawl.tools.checkstyle.checks.GenericIllegalRegexpCheck

beginTree, getDefaultTokens, getMessage, getRegexp, setIgnoreCase, setIgnoreComments, setMessage

Methods inherited from class com.puppycrawl.tools.checkstyle.checks.AbstractFormatCheck

getFormat, getRegexp, setFormat

Methods inherited from class com.puppycrawl.tools.checkstyle.api.Check

beginTree, destroy, finishTree, getAcceptableTokens, getClassLoader, getDefaultTokens, getFileContents, getLines, getRequiredTokens, getTabWidth, getTokenNames, init, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens, visitToken

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

getMessageBundle, getSeverity, getSeverityLevel, log, log, log, log, log, log, log, log, log, log, log, setSeverity

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

configure, contextualize, finishLocalSetup, getConfiguration, setupChild

Method Details

beginTree

public void beginTree(DetailAST aRootAST)
Overrides:
beginTree in interface GenericIllegalRegexpCheck

See Also:
Check


getAcceptableTokens

public int[] getAcceptableTokens()
Overrides:
getAcceptableTokens in interface Check

See Also:
Check


visitToken

public void visitToken(DetailAST aAST)
Overrides:
visitToken in interface Check

See Also:
Check