Class AvoidEscapedUnicodeCharactersCheck
- 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.AvoidEscapedUnicodeCharactersCheck
-
- All Implemented Interfaces:
Configurable
,Contextualizable
public class AvoidEscapedUnicodeCharactersCheck extends AbstractCheck
Restrict using Unicode escapes (such as
\u221e
). It is possible to allow using escapes for non-printable(control) characters. Also, this check can be configured to allow using escapes if trail comment is present. By the option it is possible to allow using escapes if literal contains only them. By the option it is possible to allow using escapes for space literals.Examples of using Unicode:
String unitAbbrev = "μs"; // Best: perfectly clear even without a comment. String unitAbbrev = "\u03bcs"; // Poor: the reader has no idea what this is.
An example of how to configure the check is:
<module name="AvoidEscapedUnicodeCharacters"/>
An example of non-printable(control) characters.
return '\ufeff' + content; // byte order mark
An example of how to configure the check to allow using escapes for non-printable(control) characters:
<module name="AvoidEscapedUnicodeCharacters"> <property name="allowEscapesForControlCharacters" value="true"/> </module>
Example of using escapes with trail comment:
String unitAbbrev = "\u03bcs"; // Greek letter mu, "s"
An example of how to configure the check to allow using escapes if trail comment is present:
<module name="AvoidEscapedUnicodeCharacters"> <property name="allowByTailComment" value="true"/> </module>
Example of using escapes if literal contains only them:
String unitAbbrev = "\u03bc\u03bc\u03bc";
An example of how to configure the check to allow escapes if literal contains only them:
<module name="AvoidEscapedUnicodeCharacters"> <property name="allowIfAllCharactersEscaped" value="true"/> </module>
An example of how to configure the check to allow non-printable escapes:
<module name="AvoidEscapedUnicodeCharacters"> <property name="allowNonPrintableEscapes" value="true"/> </module>
- Author:
- maxvetrenko
-
-
Constructor Summary
Constructors Constructor Description AvoidEscapedUnicodeCharactersCheck()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
beginTree(DetailAST rootAST)
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.int[]
getRequiredTokens()
The tokens that this check must be registered for.void
setAllowByTailComment(boolean allow)
Set allowByTailComment.void
setAllowEscapesForControlCharacters(boolean allow)
Set allowIfAllCharactersEscaped.void
setAllowIfAllCharactersEscaped(boolean allow)
Set allowIfAllCharactersEscaped.void
setAllowNonPrintableEscapes(boolean allow)
Set allowSpaceEscapes.void
visitToken(DetailAST ast)
Called to process a token.-
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck
destroy, finishTree, getClassLoader, getFileContents, getLine, getLines, getTabWidth, getTokenNames, init, isCommentNodesRequired, 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 String MSG_KEY
A key is pointing to the warning message text in "messages.properties" file.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
AvoidEscapedUnicodeCharactersCheck
public AvoidEscapedUnicodeCharactersCheck()
-
-
Method Detail
-
setAllowEscapesForControlCharacters
public final void setAllowEscapesForControlCharacters(boolean allow)
Set allowIfAllCharactersEscaped.- Parameters:
allow
- user's value.
-
setAllowByTailComment
public final void setAllowByTailComment(boolean allow)
Set allowByTailComment.- Parameters:
allow
- user's value.
-
setAllowIfAllCharactersEscaped
public final void setAllowIfAllCharactersEscaped(boolean allow)
Set allowIfAllCharactersEscaped.- Parameters:
allow
- user's value.
-
setAllowNonPrintableEscapes
public final void setAllowNonPrintableEscapes(boolean allow)
Set allowSpaceEscapes.- Parameters:
allow
- user's value.
-
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
-
beginTree
public void beginTree(DetailAST rootAST)
Description copied from class:AbstractCheck
Called before the starting to process a tree. Ideal place to initialize information that is to be collected whilst processing a tree.- Overrides:
beginTree
in classAbstractCheck
- Parameters:
rootAST
- the root of the tree
-
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
-
-