LineLengthCheck

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> com >> puppycrawl >> tools >> checkstyle >> [ checks overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of com.puppycrawl.tools.checkstyle.checks.LineLengthCheck

SOURCE |

Download com.puppycrawl.tools.checkstyle.checks.LineLengthCheck

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.puppycrawl.tools.checkstyle.checks
Class LineLengthCheck

java.lang.Object
  com.puppycrawl.tools.checkstyle.api.AutomaticBean
      com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
          com.puppycrawl.tools.checkstyle.api.Check
              com.puppycrawl.tools.checkstyle.checks.LineLengthCheck

All Implemented Interfaces:: com.puppycrawl.tools.checkstyle.api.Configurable, com.puppycrawl.tools.checkstyle.api.Contextualizable

public class LineLengthCheck
extends com.puppycrawl.tools.checkstyle.api.Check

Checks for long lines.

Rationale: Long lines are hard to read in printouts or if developers have limited screen space for the source code, e.g. if the IDE displays additional information like project tree, class hierarchy, etc.

Note: Support for the special handling of imports in CheckStyle Version 2 has been dropped as it is a special case of regexp: The user can set the ignorePattern to "^import" and achieve the same effect.

The default maximum allowable line length is 80 characters. To change the maximum, set property max.

To ignore lines in the check, set property ignorePattern to a regular expression for the lines to ignore.

An example of how to configure the check is:

 <module name="LineLength"/>

An example of how to configure the check to accept lines up to 120 characters long is:

 <module name="LineLength">
    <property name="max" value="120"/>
 </module>

An example of how to configure the check to ignore lines that begin with " * ", followed by just one word, such as within a Javadoc comment, is:

 <module name="LineLength">
    <property name="ignorePattern" value="^ *\* *[^ ]+$"/>
 </module>

Field Summary

private org.apache.regexp.RE mIgnorePattern
          the regexp when long lines are ignored

private int mMax
          the maximum number of columns in a line

Fields inherited from class com.puppycrawl.tools.checkstyle.api.Check

Fields inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

Fields inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

Constructor Summary

LineLengthCheck()
          Creates a new LineLengthCheck instance.

Method Summary

void beginTree()


int[] getDefaultTokens()
          Returns the default token a check is interested in.

void setIgnorePattern(java.lang.String aFormat)
          Set the ignore pattern.

void setMax(int aLength)


Methods inherited from class com.puppycrawl.tools.checkstyle.api.Check

beginTree, destroy, finishTree, getAcceptableTokens, getClassLoader, getFileContents, getLines, getRequiredTokens, getTabWidth, getTokenNames, init, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens, visitToken

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

getMessageBundle, getSeverity, getSeverityLevel, log, log, log, log, log, log, setSeverity

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

configure, contextualize, finishLocalSetup, getConfiguration, setupChild

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

mMax

private int mMax

the maximum number of columns in a line

mIgnorePattern

private org.apache.regexp.RE mIgnorePattern

the regexp when long lines are ignored

Constructor Detail