Class SeparatorWrapCheck

Checks line wrapping with separators.

• Property option - Specify policy on how to wrap lines. Type is com.puppycrawl.tools.checkstyle.checks.whitespace.WrapOption. Default value is eol.
• Property tokens - tokens to check Type is java.lang.String[]. Validation type is tokenSet. Default value is: DOT, COMMA.

To configure the check:

 <module name="SeparatorWrap"/>
 

Example:

 import java.io.
          IOException; // OK

 class Test {

   String s;

   public void foo(int a,
                     int b) { // OK
   }

   public void bar(int p
                     , int q) { // violation, separator comma on new line
     if (s
           .isEmpty()) { // violation, separator dot on new line
     }
   }

 }
 

To configure the check for METHOD_REF at new line:

 <module name="SeparatorWrap">
   <property name="tokens" value="METHOD_REF"/>
   <property name="option" value="nl"/>
 </module>
 

Example:

 import java.util.Arrays;

 class Test2 {

   String[] stringArray = {"foo", "bar"};

   void fun() {
     Arrays.sort(stringArray, String::
       compareToIgnoreCase);  // violation, separator method reference on same line
     Arrays.sort(stringArray, String
       ::compareTo);  // OK
   }

 }
 

To configure the check for comma at the new line:

 <module name="SeparatorWrap">
   <property name="tokens" value="COMMA"/>
   <property name="option" value="nl"/>
 </module>
 

Example:

 class Test3 {

   String s;

   int a,
     b;  // violation, separator comma on same line

   public void foo(int a,
                      int b) {  // violation, separator comma on the same line
     int r
       , t; // OK
   }

   public void bar(int p
                     , int q) {  // OK
   }

 }
 

Parent is com.puppycrawl.tools.checkstyle.TreeWalker

Violation Message Keys:

• line.new
• line.previous