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

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

  • Field Details

    • MSG_WS_NOT_FOLLOWED

      public static final String MSG_WS_NOT_FOLLOWED
      A key is pointing to the warning message text in "messages.properties" file.
      See Also:

    • MSG_WS_TYPECAST

      public static final String MSG_WS_TYPECAST
      A key is pointing to the warning message text in "messages.properties" file.
      See Also:

  • Constructor Details

    • WhitespaceAfterCheck

      public WhitespaceAfterCheck()

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

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

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

    • 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, 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.