Class NoLineWrapCheck

java.lang.Object
com.puppycrawl.tools.checkstyle.api.AutomaticBean
com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
com.puppycrawl.tools.checkstyle.api.AbstractCheck
com.puppycrawl.tools.checkstyle.checks.whitespace.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

  • Field Details

    • MSG_KEY

      public static final String MSG_KEY
      A key is pointing to the warning message text in "messages.properties" file.
      See Also:

  • Constructor Details

    • NoLineWrapCheck

      public NoLineWrapCheck()

  • Method Details

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

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

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

    • visitToken

      public void visitToken(DetailAST ast)
      Description copied from class: AbstractCheck
      Called to process a token.
      Overrides:
      visitToken in class AbstractCheck
      Parameters:
      ast - the token to process