com.puppycrawl.tools.checkstyle.checks.whitespace
Class NoWhitespaceBeforeCheck

java.lang.Object
  com.puppycrawl.tools.checkstyle.api.AutomaticBean
      com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
          com.puppycrawl.tools.checkstyle.api.Check
              com.puppycrawl.tools.checkstyle.checks.whitespace.NoWhitespaceBeforeCheck

All 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

Author:

Rick Giles, lkuehne

Constructor Summary

NoWhitespaceBeforeCheck()

Method Summary

int[]	getAcceptableTokens() The configurable token set.
int[]	getDefaultTokens() Returns the default token a check is interested in.
void	setAllowLineBreaks(boolean aAllowLineBreaks) Control whether whitespace is flagged at linebreaks.
void	visitToken(DetailAST aAST) Called to process a token.

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

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

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

getMessageBundle, getSeverity, getSeverityLevel, log, log, log, log, log, log, log, log, log, setSeverity

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

configure, contextualize, finishLocalSetup, getConfiguration, setupChild

Methods inherited from class java.lang.Object

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

Constructor Detail

NoWhitespaceBeforeCheck

public NoWhitespaceBeforeCheck()

Method Detail

getDefaultTokens

public int[] getDefaultTokens()

Description copied from class: Check

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 Check

Returns:

the default tokens

See Also:

Check

getAcceptableTokens

public int[] getAcceptableTokens()

Description copied from class: Check

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.

Overrides:

getAcceptableTokens in class Check

Returns:

the token set this check is designed for.

See Also:

Check

visitToken

public void visitToken(DetailAST aAST)

Description copied from class: Check

Called to process a token.

Overrides:

visitToken in class Check

Parameters:

aAST - the token to process

See Also:

Check

setAllowLineBreaks

public void setAllowLineBreaks(boolean aAllowLineBreaks)

Control whether whitespace is flagged at linebreaks.

Parameters:

aAllowLineBreaks - whether whitespace should be flagged at linebreaks.