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 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>
-
-
Field Summary
Fields Modifier and Type Field Description private int
compileFlags
The flags to use with the regexp.private java.lang.String
format
The format string of the regexp.private java.lang.String
message
Custom message for report if illegal regexp found ignored if empty.static java.lang.String
MSG_KEY
A key is pointing to the warning message text in "messages.properties" file.private java.util.regex.Pattern
regexp
The regexp to match against.
-
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(java.lang.String format)
Set the format to the specified regular expression.void
setIgnoreCase(boolean caseInsensitive)
Set whether or not the match is case sensitive.void
setMessage(java.lang.String message)
Setter for message property.private void
updateRegexp()
void
visitToken(DetailAST ast)
Called to process a token.-
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck
beginTree, destroy, finishTree, getClassLoader, getFileContents, getLine, getLines, 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
-
-
-
-
Field Detail
-
MSG_KEY
public static final java.lang.String MSG_KEY
A key is pointing to the warning message text in "messages.properties" file.- See Also:
- Constant Field Values
-
message
private java.lang.String message
Custom message for report if illegal regexp found ignored if empty.
-
format
private java.lang.String format
The format string of the regexp.
-
regexp
private java.util.regex.Pattern regexp
The regexp to match against.
-
compileFlags
private int compileFlags
The flags to use with the regexp.
-
-
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(java.lang.String message)
Setter for message property.- Parameters:
message
- custom message which should be used to report about violations.
-
setFormat
public void setFormat(java.lang.String format)
Set the format to the specified regular expression.- Parameters:
format
- aString
value- Throws:
org.apache.commons.beanutils.ConversionException
- unable to parse format
-
setIgnoreCase
public void setIgnoreCase(boolean caseInsensitive)
Set whether or not the match is case sensitive.- Parameters:
caseInsensitive
- true if the match is case insensitive.
-
updateRegexp
private void updateRegexp()
-
-