FileLengthCheck (checkstyle 8.36.1 API)

java.lang.Object
- com.puppycrawl.tools.checkstyle.api.AutomaticBean
- - com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
  - - com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
    - - com.puppycrawl.tools.checkstyle.checks.sizes.FileLengthCheck

All Implemented Interfaces:

Configurable, Contextualizable, FileSetCheck
```
public class FileLengthCheck
extends AbstractFileSetCheck
```
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.
- Property max - Specify the maximum number of lines allowed. Type is int. Default value is 2000.
- Property fileExtensions - Specify the file type extension of files to process. Type is java.lang.String[]. Default value is "".
To configure the check:
```
 <module name="FileLength"/>
 
```
To configure the check to accept files with up to 1500 lines:
```
 <module name="FileLength">
   <property name="max" value="1500"/>
 </module>
 
```
Parent is com.puppycrawl.tools.checkstyle.Checker

Violation Message Keys:
- maxLen.file
Since:

5.0

Nested Class Summary
- Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean
  AutomaticBean.OutputStreamOptions

Field Summary

Fields
Modifier and Type Field Description

static java.lang.String MSG_KEY
A key is pointing to the warning message text in "messages.properties" file.

Constructor Summary

Constructors
Constructor Description

FileLengthCheck()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`processFiltered(java.io.File file, FileText fileText)`	Called to process a file that matches the specified file extensions.
`void`	`setMax(int length)`	Setter to specify the maximum number of lines allowed.

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
addMessages, beginProcessing, destroy, finishProcessing, fireErrors, getFileContents, getFileExtensions, getMessageDispatcher, getMessages, getTabWidth, init, log, log, process, setFileContents, setFileExtensions, setMessageDispatcher, setTabWidth

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
finishLocalSetup, getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, setId, setSeverity

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean
configure, contextualize, getConfiguration, setupChild

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.puppycrawl.tools.checkstyle.api.Configurable
configure

Methods inherited from interface com.puppycrawl.tools.checkstyle.api.Contextualizable
contextualize

- Field Detail
  - MSG_KEY
```
public static final java.lang.String MSG_KEY
```
    A key is pointing to the warning message text in "messages.properties" file.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - FileLengthCheck
```
public FileLengthCheck()
```
- Method Detail
  - processFiltered
```
protected void processFiltered(java.io.File file,
                               FileText fileText)
```
    Description copied from class: AbstractFileSetCheck
    
    Called to process a file that matches the specified file extensions.
    
    Specified by:
    
    processFiltered in class AbstractFileSetCheck
    
    Parameters:
    
    file - the file to be processed
    
    fileText - the contents of the file.
  - setMax
```
public void setMax(int length)
```
    Setter to specify the maximum number of lines allowed.
    
    Parameters:
    
    length - the maximum length of a Java source file