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

Class NoLineWrapCheck

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

    Checks that chosen statements are not line-wrapped. By default, this Check restricts wrapping import and package statements, but it's possible to check any statement.

    To configure the check to force no line-wrapping in package and import statements (default values): 

     <module name="NoLineWrap"/>

    Examples of line-wrapped statements (bad case): 

     package com.puppycrawl. // violation
     tools.checkstyle.checks;

 import com.puppycrawl.tools. // violation
     checkstyle.api.AbstractCheck;

 import static java.math. // violation
     BigInteger.ZERO;

    Examples: 

     package com.puppycrawl.tools.checkstyle. // violation
   checks.whitespace;

 import java.lang.Object; // OK
 import java.lang. // violation
   Integer;

 import static java.math. // violation
   BigInteger.TEN;
 
     package com.puppycrawl.tools.checkstyle.checks.coding; // OK

 import java.lang. // violation
   Boolean;

 import static java.math.BigInteger.ONE; // OK

    To configure the check to force no line-wrapping only in import statements: 

     <module name="NoLineWrap">
   <property name="tokens" value="IMPORT"/>
 </module>

    Example: 

     package com.puppycrawl. // OK
   tools.checkstyle.checks;

 import java.io.*; // OK
 import java.lang. // violation
  Boolean;

 import static java.math. // OK
 BigInteger.ZERO;

    To configure the check to force no line-wrapping only in class, method and constructor definitions: 

     <module name="NoLineWrap">
   <property name="tokens" value="CLASS_DEF, METHOD_DEF, CTOR_DEF"/>
 </module>

    Example: 

     public class // violation, class definition not wrapped in a single-line
   Foo {

   public Foo() { // OK
   }

   public static void // violation, method definition not wrapped in a single-line
     doSomething() {
   }
 }

 public class Bar { // OK

   public // violation, constructor definition not wrapped in a single-line
     Bar() {
   }

   public int fun() { // OK
   }
 }

    Examples of not line-wrapped statements (good case): 

     import com.puppycrawl.tools.checkstyle.api.AbstractCheck;
 import static java.math.BigInteger.ZERO;

    Parent is com.puppycrawl.tools.checkstyle.TreeWalker

    Violation Message Keys:

    • no.line.wrap
    Since:
    5.8