com.puppycrawl.tools.checkstyle.checks.whitespace

Class NoWhitespaceBeforeCheck

Implemented Interfaces:
Configurable, Contextualizable

public class NoWhitespaceBeforeCheck
extends Check

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.

By default the check will check the following operators: SEMI, POST_DEC, POST_INC. 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 linebreaks before a DOT token is:

 <module name="NoWhitespaceBefore">
     <property name="tokens" value="DOT"/>
     <property name="allowLineBreaks" value="true"/>
 </module>
 
Version:
1.0
Authors:
Rick Giles
lkuehne

Method Summary

int[]
getAcceptableTokens()
int[]
getDefaultTokens()
void
setAllowLineBreaks(boolean aAllowLineBreaks)
Control whether whitespace is flagged at linebreaks.
void
visitToken(DetailAST aAST)

Methods inherited from class com.puppycrawl.tools.checkstyle.api.Check

beginTree, destroy, finishTree, getAcceptableTokens, getClassLoader, getDefaultTokens, getFileContents, getLines, getRequiredTokens, getTabWidth, getTokenNames, init, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens, visitToken

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

getId, getMessageBundle, getSeverity, getSeverityLevel, log, log, log, log, log, log, log, log, log, log, log, setId, setSeverity

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

configure, contextualize, finishLocalSetup, getConfiguration, setupChild

Method Details

getAcceptableTokens

public int[] getAcceptableTokens()
Overrides:
getAcceptableTokens in interface Check

getDefaultTokens

public int[] getDefaultTokens()
Overrides:
getDefaultTokens in interface Check

setAllowLineBreaks

public void setAllowLineBreaks(boolean aAllowLineBreaks)
Control whether whitespace is flagged at linebreaks.
Parameters:
aAllowLineBreaks - whether whitespace should be flagged at linebreaks.

visitToken

public void visitToken(DetailAST aAST)
Overrides:
visitToken in interface Check