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>
Constructor and Description |
---|
FileLengthCheck() |
Modifier and Type | Method and Description |
---|---|
void |
beginTree(DetailAST aRootAST)
Called before the starting to process a tree.
|
int[] |
getDefaultTokens()
Returns the default token a check is interested in.
|
void |
setMax(int aLength) |
destroy, finishTree, getAcceptableTokens, getClassLoader, getFileContents, getLines, getRequiredTokens, getTabWidth, getTokenNames, init, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens, visitToken
getId, getMessageBundle, getSeverity, getSeverityLevel, log, log, log, log, log, log, log, log, log, setId, setSeverity
configure, contextualize, finishLocalSetup, getConfiguration, setupChild
public int[] getDefaultTokens()
getDefaultTokens
in class Check
TokenTypes
public void beginTree(DetailAST aRootAST)
public void setMax(int aLength)
aLength
- the maximum length of a Java source file