com.puppycrawl.tools.checkstyle.checks.whitespace

Class WhitespaceAfterCheck

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.WhitespaceAfterCheck

All Implemented Interfaces:

Configurable, Contextualizable

public class WhitespaceAfterCheck
extends AbstractCheck

Checks that a token is followed by whitespace, with the exception that it does not check for whitespace after the semicolon of an empty for iterator. Use Check EmptyForIteratorPad to validate empty for iterators.

• Property tokens - tokens to check Type is java.lang.String[]. Validation type is tokenSet. Default value is: COMMA, SEMI, TYPECAST, LITERAL_IF, LITERAL_ELSE, LITERAL_WHILE, LITERAL_DO, LITERAL_FOR, DO_WHILE.

To configure the check:

 <module name="WhitespaceAfter"/>
 

Example:

  public void myTest() {
      if (foo) {              // OK
              //...
      } else if(bar) {        // violation
              //...
      }

      testMethod(foo, bar);   // OK
      testMethod(foo,bar);    // violation

      for (;;){}               // OK
      for(;;){}                // violation, space after 'for' is required
      }
 

To configure the check for whitespace only after COMMA and SEMI tokens:

 <module name="WhitespaceAfter">
   <property name="tokens" value="COMMA, SEMI"/>
 </module>
 

Example:

     public void myTest() {
         int a; int b;           // OK
         int a;int b;            // violation

         testMethod(foo, bar);   // OK
         testMethod(foo,bar);    // violation

         for(;;) {} // OK
     }
 

Parent is com.puppycrawl.tools.checkstyle.TreeWalker

Violation Message Keys:

• ws.notFollowed
• ws.typeCast

Since:

3.0

Nested Class Summary

Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

AutomaticBean.OutputStreamOptions

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MSG_WS_NOT_FOLLOWED A key is pointing to the warning message text in "messages.properties" file.
static java.lang.String	MSG_WS_TYPECAST A key is pointing to the warning message text in "messages.properties" file.

Constructor Summary

Constructors

Constructor and Description
WhitespaceAfterCheck()

Method Summary

Modifier and Type	Method and 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	isFollowedByWhitespace(DetailAST targetAST, java.lang.String line) Checks whether token is followed by a whitespace.
void	visitToken(DetailAST ast) Called to process a token.

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

beginTree, clearViolations, destroy, finishTree, getFileContents, 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.api.AutomaticBean

configure, contextualize, getConfiguration, setupChild

Methods inherited from class java.lang.Object

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

Field Detail

MSG_WS_NOT_FOLLOWED

public static final java.lang.String MSG_WS_NOT_FOLLOWED

A key is pointing to the warning message text in "messages.properties" file.

See Also:

Constant Field Values

MSG_WS_TYPECAST

public static final java.lang.String MSG_WS_TYPECAST

A key is pointing to the warning message text in "messages.properties" file.

See Also:

Constant Field Values

Constructor Detail

WhitespaceAfterCheck

public WhitespaceAfterCheck()

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 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

isFollowedByWhitespace

private static boolean isFollowedByWhitespace(DetailAST targetAST,
                                              java.lang.String line)

Checks whether token is followed by a whitespace.

Parameters:

targetAST - Ast token.

line - The line associated with the ast token.

Returns:

true if ast token is followed by a whitespace.