com.puppycrawl.tools.checkstyle.checks.coding

Class IllegalTokenTextCheck

java.lang.Object

com.puppycrawl.tools.checkstyle.api.AutomaticBean

com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

com.puppycrawl.tools.checkstyle.api.AbstractCheck

com.puppycrawl.tools.checkstyle.checks.coding.IllegalTokenTextCheck

All Implemented Interfaces:

Configurable, Contextualizable

public class IllegalTokenTextCheck
extends AbstractCheck

Checks specified tokens text for matching an illegal pattern. By default no tokens are specified.

• Property format - Define the RegExp for illegal pattern. Type is java.lang.String. Default value is "^$" (empty).
• Property ignoreCase - Control whether to ignore case when matching. Type is boolean. Default value is false.
• Property message - Define the message which is used to notify about violations; if empty then the default message is used. Type is java.lang.String. Default value is "".
• Property tokens - tokens to check Type is int[]. Default value is: empty.

To configure the check to forbid String literals containing "a href":

 <module name="IllegalTokenText">
   <property name="tokens" value="STRING_LITERAL"/>
   <property name="format" value="a href"/>
 </module>
 

Example:

 public void myTest() {
     String test = "a href"; // violation
     String test2 = "A href"; // OK, case is sensitive
 }
 

To configure the check to forbid String literals containing "a href" for the ignoreCase mode:

 <module name="IllegalTokenText">
   <property name="tokens" value="STRING_LITERAL"/>
   <property name="format" value="a href"/>
   <property name="ignoreCase" value="true"/>
 </module>
 

Example:

 public void myTest() {
     String test = "a href"; // violation
     String test2 = "A href"; // violation, case is ignored
 }
 

To configure the check to forbid leading zeros in an integer literal, other than zero and a hex literal:

 <module name="IllegalTokenText">
   <property name="tokens" value="NUM_INT,NUM_LONG"/>
   <property name="format" value="^0[^lx]"/>
   <property name="ignoreCase" value="true"/>
 </module>
 

Example:

 public void myTest() {
     int test1 = 0; // OK
     int test2 = 0x111; // OK
     int test3 = 0X111; // OK, case is ignored
     int test4 = 010; // violation
     long test5 = 0L; // OK
     long test6 = 010L; // violation
 }
 

Parent is com.puppycrawl.tools.checkstyle.TreeWalker

Violation Message Keys:

• illegal.token.text

Since:

3.2

Nested Class Summary

Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

AutomaticBean.OutputStreamOptions

Field Summary

Fields

Modifier and Type	Field and Description
static String	MSG_KEY A key is pointing to the warning message text in "messages.properties" file.

Constructor Summary

Constructors

Constructor and Description
IllegalTokenTextCheck()

Method Summary

Modifier and Type	Method and Description
int[]	getAcceptableTokens() The configurable token set.
int[]	getDefaultTokens() Returns the default token a check is interested in.
int[]	getRequiredTokens() The tokens that this check must be registered for.
boolean	isCommentNodesRequired() Whether comment nodes are required or not.
void	setFormat(String format) Setter to define the RegExp for illegal pattern.
void	setIgnoreCase(boolean caseInsensitive) Setter to control whether to ignore case when matching.
void	setMessage(String message) Setter to define the message which is used to notify about violations; if empty then the default message is used.
void	visitToken(DetailAST ast) Called to process a token.

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

beginTree, clearMessages, destroy, finishTree, getFileContents, getLine, getLines, getMessages, getTabWidth, getTokenNames, init, leaveToken, log, log, log, setFileContents, setTabWidth, setTokens

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

finishLocalSetup, getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, setId, setSeverity

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

configure, contextualize, getConfiguration, setupChild

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MSG_KEY

public static final String MSG_KEY

A key is pointing to the warning message text in "messages.properties" file.

See Also:

Constant Field Values

Constructor Detail

IllegalTokenTextCheck

public IllegalTokenTextCheck()

Method Detail

getDefaultTokens

public int[] getDefaultTokens()

Description copied from class: AbstractCheck

Returns the default token a check is interested in. Only used if the configuration for a check does not define the tokens.

Specified by:

getDefaultTokens in class AbstractCheck

Returns:

the default tokens

See Also:

TokenTypes

getAcceptableTokens

public int[] getAcceptableTokens()

Description copied from class: AbstractCheck

The configurable token set. Used to protect Checks against malicious users who specify an unacceptable token set in the configuration file. The default implementation returns the check's default tokens.

Specified by:

getAcceptableTokens in class AbstractCheck

Returns:

the token set this check is designed for.

See Also:

TokenTypes

getRequiredTokens

public int[] getRequiredTokens()

Description copied from class: AbstractCheck

The tokens that this check must be registered for.

Specified by:

getRequiredTokens in class AbstractCheck

Returns:

the token set this must be registered for.

See Also:

TokenTypes

isCommentNodesRequired

public boolean isCommentNodesRequired()

Description copied from class: AbstractCheck

Whether comment nodes are required or not.

Overrides:

isCommentNodesRequired in class AbstractCheck

Returns:

false as a default value.

visitToken

public void visitToken(DetailAST ast)

Description copied from class: AbstractCheck

Called to process a token.

Overrides:

visitToken in class AbstractCheck

Parameters:

ast - the token to process

setMessage

public void setMessage(String message)

Setter to define the message which is used to notify about violations; if empty then the default message is used.

Parameters:

message - custom message which should be used to report about violations.

setFormat

public void setFormat(String format)

Setter to define the RegExp for illegal pattern.

Parameters:

format - a String value

setIgnoreCase

public void setIgnoreCase(boolean caseInsensitive)

Setter to control whether to ignore case when matching.

Parameters:

caseInsensitive - true if the match is case insensitive.