Class LineLengthCheck
- java.lang.Object
-
- com.puppycrawl.tools.checkstyle.AbstractAutomaticBean
-
- com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
-
- com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
-
- com.puppycrawl.tools.checkstyle.checks.sizes.LineLengthCheck
-
- All Implemented Interfaces:
Configurable
,Contextualizable
,FileSetCheck
public class LineLengthCheck extends AbstractFileSetCheck
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.
-
The calculation of the length of a line takes into account the number of
expanded spaces for a tab character (
'\t'
). The default number of spaces is8
. To specify a different number of spaces, the user can setChecker
propertytabWidth
which applies to all Checks, includingLineLength
; or can set propertytabWidth
forLineLength
alone. -
By default, package and import statements (lines matching pattern
^(package|import) .*
) are not verified by this check. -
Trailing comments are taken into consideration while calculating the line length.
import java.util.regex.Pattern; // The length of this comment will be taken into consideration
In the example above the length of the import statement is just 31 characters but total length will be 94 characters.
-
Property
fileExtensions
- Specify the file extensions of the files to process. Type isjava.lang.String[]
. Default value is""
. -
Property
ignorePattern
- Specify pattern for lines to ignore. Type isjava.util.regex.Pattern
. Default value is"^(package|import) .*"
. -
Property
max
- Specify the maximum line length allowed. Type isint
. Default value is80
.
Parent is
com.puppycrawl.tools.checkstyle.Checker
Violation Message Keys:
-
maxLineLen
- Since:
- 3.0
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.AbstractAutomaticBean
AbstractAutomaticBean.OutputStreamOptions
-
-
Field Summary
Fields Modifier and Type Field Description private static int
DEFAULT_MAX_COLUMNS
Default maximum number of columns in a line.private Pattern
ignorePattern
Specify pattern for lines to ignore.private int
max
Specify the maximum line length allowed.static String
MSG_KEY
A key is pointing to the warning message text in "messages.properties" file.
-
Constructor Summary
Constructors Constructor Description LineLengthCheck()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
processFiltered(File file, FileText fileText)
Called to process a file that matches the specified file extensions.void
setIgnorePattern(Pattern pattern)
Setter to specify pattern for lines to ignore.void
setMax(int length)
Setter to specify the maximum line length allowed.-
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
addViolations, beginProcessing, destroy, finishProcessing, fireErrors, getFileContents, getFileExtensions, getMessageDispatcher, getTabWidth, getViolations, 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.AbstractAutomaticBean
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 String MSG_KEY
A key is pointing to the warning message text in "messages.properties" file.- See Also:
- Constant Field Values
-
DEFAULT_MAX_COLUMNS
private static final int DEFAULT_MAX_COLUMNS
Default maximum number of columns in a line.- See Also:
- Constant Field Values
-
max
private int max
Specify the maximum line length allowed.
-
ignorePattern
private Pattern ignorePattern
Specify pattern for lines to ignore.
-
-
Constructor Detail
-
LineLengthCheck
public LineLengthCheck()
-
-
Method Detail
-
processFiltered
protected void processFiltered(File file, FileText fileText)
Description copied from class:AbstractFileSetCheck
Called to process a file that matches the specified file extensions.- Specified by:
processFiltered
in classAbstractFileSetCheck
- Parameters:
file
- the file to be processedfileText
- the contents of the file.
-
setMax
public void setMax(int length)
Setter to specify the maximum line length allowed.- Parameters:
length
- the maximum length of a line- Since:
- 3.0
-
setIgnorePattern
public final void setIgnorePattern(Pattern pattern)
Setter to specify pattern for lines to ignore.- Parameters:
pattern
- a pattern.- Since:
- 3.0
-
-