Class IllegalTokenTextCheck
- java.lang.Object
-
- com.puppycrawl.tools.checkstyle.AbstractAutomaticBean
-
- 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 isjava.util.regex.Pattern
. Default value is"^$"
. -
Property
ignoreCase
- Control whether to ignore case when matching. Type isboolean
. Default value isfalse
. -
Property
message
- Define the message which is used to notify about violations; if empty then the default message is used. Type isjava.lang.String
. Default value is""
. -
Property
tokens
- tokens to check Type isjava.lang.String[]
. Validation type istokenSet
. Default value is:""
.
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.AbstractAutomaticBean
AbstractAutomaticBean.OutputStreamOptions
-
-
Field Summary
Fields Modifier and Type Field Description private Pattern
format
Define the RegExp for illegal pattern.private String
formatString
The format string of the regexp.private boolean
ignoreCase
Control whether to ignore case when matching.private String
message
Define the message which is used to notify about violations; if empty then the default message is used.static String
MSG_KEY
A key is pointing to the warning message text in "messages.properties" file.
-
Constructor Summary
Constructors Constructor Description IllegalTokenTextCheck()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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.private void
updateRegexp()
void
visitToken(DetailAST ast)
Called to process a token.-
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck
beginTree, clearViolations, destroy, finishTree, getFileContents, getFilePath, getLine, getLineCodePoints, getLines, getTabWidth, getTokenNames, getViolations, 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.AbstractAutomaticBean
configure, contextualize, getConfiguration, setupChild
-
-
-
-
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
-
message
private String message
Define the message which is used to notify about violations; if empty then the default message is used.
-
formatString
private String formatString
The format string of the regexp.
-
ignoreCase
private boolean ignoreCase
Control whether to ignore case when matching.
-
-
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 classAbstractCheck
- 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 classAbstractCheck
- 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 classAbstractCheck
- 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 classAbstractCheck
- 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 classAbstractCheck
- 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.- Since:
- 3.2
-
setFormat
public void setFormat(String format)
Setter to define the RegExp for illegal pattern.- Parameters:
format
- aString
value- Since:
- 3.2
-
setIgnoreCase
public void setIgnoreCase(boolean caseInsensitive)
Setter to control whether to ignore case when matching.- Parameters:
caseInsensitive
- true if the match is case-insensitive.- Since:
- 3.2
-
updateRegexp
private void updateRegexp()
-
-