com.puppycrawl.tools.checkstyle.checks.sizes

Class LineLengthCheck

Implemented Interfaces:
Configurable, Contextualizable

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

void
beginTree(DetailAST aRootAST)
int[]
getDefaultTokens()
void
setIgnorePattern(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, getDefaultTokens, 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

getId, getMessageBundle, getSeverity, getSeverityLevel, log, log, log, log, log, log, log, log, log, log, log, setId, setSeverity

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

configure, contextualize, finishLocalSetup, getConfiguration, setupChild

Constructor Details

LineLengthCheck

public LineLengthCheck()
Creates a new LineLengthCheck instance.

Method Details

beginTree

public void beginTree(DetailAST aRootAST)
Overrides:
beginTree in interface Check

getDefaultTokens

public int[] getDefaultTokens()
Overrides:
getDefaultTokens in interface Check

setIgnorePattern

public void setIgnorePattern(String aFormat)
            throws ConversionException
Set the ignore pattern.
Parameters:
aFormat - a String value

setMax

public void setMax(int aLength)
Parameters:
aLength - the maximum length of a line