com.puppycrawl.tools.checkstyle.checks.sizes

Class LineLengthCheck

public class LineLengthCheck extends 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>
 

Author: Lars Kühne

Constructor Summary
LineLengthCheck()
Creates a new LineLengthCheck instance.
Method Summary
voidbeginTree(DetailAST aRootAST)
{@inheritDoc}
int[]getDefaultTokens()
{@inheritDoc}
voidsetIgnorePattern(String aFormat)
Set the ignore pattern.
voidsetMax(int aLength)

Constructor Detail

LineLengthCheck

public LineLengthCheck()
Creates a new LineLengthCheck instance.

Method Detail

beginTree

public void beginTree(DetailAST aRootAST)
{@inheritDoc}

getDefaultTokens

public int[] getDefaultTokens()
{@inheritDoc}

setIgnorePattern

public void setIgnorePattern(String aFormat)
Set the ignore pattern.

Parameters: aFormat a String value

Throws: ConversionException unable to parse aFormat

setMax

public void setMax(int aLength)

Parameters: aLength the maximum length of a line