Package com.puppycrawl.tools.checkstyle.checks.whitespace

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

    Example: 

     for ( ; i < 1; i++ );  // violation semicolon is preceded with whitespace
 for (; i < 2; i++ );   // ok
 for (;i<2;i++);        // ok
 for ( ;i<2;i++);       // violation semicolon is preceded with whitespace
 for (
       ; i < 2; i++ );  // ok

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

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

    Example: 

     for ( ; i < 2; i++ );   // ok
 for (; i < 2; i++ );    // violation semicolon is not preceded with whitespace
 for (;i<2;i++);         // violation semicolon is not preceded with whitespace
 for ( ;i<2;i++);        // ok
 for (
       ; i < 2; i++ );   // ok

    Parent is com.puppycrawl.tools.checkstyle.TreeWalker

    Violation Message Keys:

    • ws.notPreceded
    • ws.preceded
    Since:
    3.4

    • Method Detail

      • setOption

        public void setOption​(java.lang.String optionStr)
        Setter to specify policy on how to pad an empty for iterator.
        Parameters:
        optionStr - string to decode option from
        Throws:
        java.lang.IllegalArgumentException - if unable to decode

      • 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