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

Class SeparatorWrapCheck

  • All Implemented Interfaces:
    Configurable, Contextualizable
    public class SeparatorWrapCheck
extends AbstractCheck

    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
    Since:
    5.8

    • Field Detail

      • MSG_LINE_PREVIOUS

        public static final java.lang.String MSG_LINE_PREVIOUS
        A key is pointing to the warning message text in "messages.properties" file.
        See Also:
        Constant Field Values

      • MSG_LINE_NEW

        public static final java.lang.String MSG_LINE_NEW
        A key is pointing to the warning message text in "messages.properties" file.
        See Also:
        Constant Field Values

    • Constructor Detail

      • SeparatorWrapCheck

        public SeparatorWrapCheck()

    • Method Detail

      • setOption

        public void setOption​(java.lang.String optionStr)
        Setter to specify policy on how to wrap lines.
        Parameters:
        optionStr - string to decode option from
        Throws:
        java.lang.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:
        TokenTypes

      • 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

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