Class EmptyForInitializerPadCheck

All Implemented Interfaces:
Configurable, Contextualizable

public class EmptyForInitializerPadCheck extends AbstractCheck

Checks the padding of an empty for initializer; that is whether a white space is required at an empty for initializer, or such white space is forbidden. No check occurs if there is a line wrap at the initializer, as in

 for (
     ; i < j; i++, j--)
  
  • Property option - Specify policy on how to pad an empty for iterator. Type is com.puppycrawl.tools.checkstyle.checks.whitespace.PadOption. Default value is nospace.

To configure the check:

 <module name="EmptyForInitializerPad"/>
 

To configure the check to require white space at an empty for iterator:

 <module name="EmptyForInitializerPad">
   <property name="option" value="space"/>
 </module>
 

Parent is com.puppycrawl.tools.checkstyle.TreeWalker

Violation Message Keys:

  • ws.notPreceded
  • ws.preceded
Since:
3.4
  • Field Details

    • MSG_PRECEDED

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

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

    • EmptyForInitializerPadCheck

      public EmptyForInitializerPadCheck()
  • Method Details

    • setOption

      public void setOption(String optionStr)
      Setter to specify policy on how to pad an empty for iterator.
      Parameters:
      optionStr - string to decode option from
      Throws:
      IllegalArgumentException - if unable to decode
    • 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