Package com.puppycrawl.tools.checkstyle.checks.whitespace

Class NoWhitespaceBeforeCheck

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.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 linebreaks are allowed) all characters on the line before are whitespace. To allow linebreaks before a token, set property allowLineBreaks to true. No check occurs before semicolons in empty for loop initializers or conditions.

• Property allowLineBreaks - Control whether whitespace is allowed if the token is at a linebreak. Type is boolean. Default value is false.
• Property tokens - tokens to check Type is java.lang.String[]. Validation type is tokenSet. Default value is: COMMA, SEMI, POST_INC, POST_DEC, ELLIPSIS, LABELED_STAT.

Parent is com.puppycrawl.tools.checkstyle.TreeWalker

Violation Message Keys:

• ws.preceded

Since:

3.0

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 boolean	allowLineBreaks	Control whether whitespace is allowed if the token is at a linebreak.
static final String	MSG_KEY	A key is pointing to the warning message text in "messages.properties" file.

Constructor Summary

Constructors

Constructor	Description
NoWhitespaceBeforeCheck()

Method Summary

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	isInEmptyForInitializerOrCondition(DetailAST semicolonAst)	Checks that semicolon is in empty for initializer or condition.
void	setAllowLineBreaks(boolean allowLineBreaks)	Setter to control whether whitespace is allowed if the token is at a linebreak.
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, isCommentNodesRequired, 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

Methods inherited from class java.lang.Object

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

Field Details

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

allowLineBreaks

private boolean allowLineBreaks

Control whether whitespace is allowed if the token is at a linebreak.

Constructor Details

NoWhitespaceBeforeCheck

public NoWhitespaceBeforeCheck()

Method Details

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

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

isInEmptyForInitializerOrCondition

private static boolean isInEmptyForInitializerOrCondition(DetailAST semicolonAst)

Checks that semicolon is in empty for initializer or condition.

Parameters:

semicolonAst - DetailAST of semicolon.

Returns:

true if semicolon is in empty for initializer or condition.

setAllowLineBreaks

public void setAllowLineBreaks(boolean allowLineBreaks)

Setter to control whether whitespace is allowed if the token is at a linebreak.

Parameters:

allowLineBreaks - whether whitespace should be flagged at line breaks.

Since:

3.0