com.puppycrawl.tools.checkstyle.checks.sizes

Class FileLengthCheck

Implemented Interfaces:
Configurable, Contextualizable

public class FileLengthCheck
extends Check

Checks for long source files.

Rationale: If a source file becomes very long it is hard to understand. Therefore long classes should usually be refactored into several individual classes that focus on a specific task.

The default maximum file length is 2000 lines. To change the maximum number of lines, set property max.

An example of how to configure the check is:

 <module name="FileLength"/>
 

An example of how to configure the check so that it accepts files with at most 1500 lines is:

 <module name="FileLength">
    <property name="max" value="1500"/>
 </module>
 
Author:
Lars K?hne

Method Summary

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

Method Details

beginTree

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

getDefaultTokens

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

setMax

public void setMax(int aLength)
Parameters:
aLength - the maximum length of a Java source file