Class NoWhitespaceBeforeCheck
- 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.whitespace.NoWhitespaceBeforeCheck
-
- All Implemented Interfaces:
Configurable
,Contextualizable
public class NoWhitespaceBeforeCheck extends AbstractCheck
Checks that there is no whitespace before a token. More specifically, it checks that it is not preceded with whitespace, or (if line breaks are allowed) all characters on the line before are whitespace. To allow line breaks before a token, set property allowLineBreaks to true.
By default the check will check the following operators:
COMMA
,SEMI
,POST_DEC
,POST_INC
,ELLIPSIS
.DOT
is also an acceptable token in a configuration of this check.An example of how to configure the check is:
<module name="NoWhitespaceBefore"/>
An example of how to configure the check to allow line breaks before a
DOT
token is:<module name="NoWhitespaceBefore"> <property name="tokens" value="DOT"/> <property name="allowLineBreaks" value="true"/> </module>
-
-
Field Summary
Fields Modifier and Type Field Description private boolean
allowLineBreaks
Whether whitespace is allowed if the AST is at a linebreak.static java.lang.String
MSG_KEY
A key is pointing to the warning message text in "messages.properties" file.
-
Constructor Summary
Constructors Constructor Description NoWhitespaceBeforeCheck()
-
Method Summary
All Methods Static 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.private static boolean
isInEmptyForInitializer(DetailAST semicolonAst)
Checks that semicolon is in empty for initializer.void
setAllowLineBreaks(boolean allowLineBreaks)
Control whether whitespace is flagged at line breaks.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, 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 java.lang.String MSG_KEY
A key is pointing to the warning message text in "messages.properties" file.- See Also:
- Constant Field Values
-
allowLineBreaks
private boolean allowLineBreaks
Whether whitespace is allowed if the AST is at a linebreak.
-
-
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
-
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
-
isInEmptyForInitializer
private static boolean isInEmptyForInitializer(DetailAST semicolonAst)
Checks that semicolon is in empty for initializer.- Parameters:
semicolonAst
- DetailAST of semicolon.- Returns:
- true if semicolon is in empty for initializer.
-
setAllowLineBreaks
public void setAllowLineBreaks(boolean allowLineBreaks)
Control whether whitespace is flagged at line breaks.- Parameters:
allowLineBreaks
- whether whitespace should be flagged at line breaks.
-
-