Class SingleSpaceSeparatorCheck

  • All Implemented Interfaces:
    Configurable, Contextualizable

    public class SingleSpaceSeparatorCheck
    extends AbstractCheck

    Checks that non-whitespace characters are separated by no more than one whitespace. Separating characters by tabs or multiple spaces will be reported. Currently the check doesn't permit horizontal alignment. To inspect whitespaces before and after comments, set the property validateComments to true.

    Setting validateComments to false will ignore cases like:

     int i;  // Multiple whitespaces before comment tokens will be ignored.
     private void foo(int  /* whitespaces before and after block-comments will be
     ignored */  i) {
     

    Sometimes, users like to space similar items on different lines to the same column position for easier reading. This feature isn't supported by this check, so both braces in the following case will be reported as violations.

     public long toNanos(long d)  { return d;             }  // 2 violations
     public long toMicros(long d) { return d / (C1 / C0); }
     

    Check have following options:

    • validateComments - Boolean when set to true, whitespaces surrounding comments will be ignored. Default value is false.

    To configure the check:

     <module name="SingleSpaceSeparator"/>
     

    To configure the check so that it validates comments:

     <module name="SingleSpaceSeparator">
     <property name="validateComments" value="true"/>
     </module>
     
    Author:
    Robert Whitebit, Richard Veach