public class LineLengthCheck extends Check
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>
Constructor and Description |
---|
LineLengthCheck()
Creates a new
LineLengthCheck instance. |
Modifier and Type | Method and Description |
---|---|
void |
beginTree(DetailAST rootAST)
Called before the starting to process a tree.
|
int[] |
getDefaultTokens()
Returns the default token a check is interested in.
|
void |
setIgnorePattern(String format)
Set the ignore pattern.
|
void |
setMax(int length) |
destroy, finishTree, getAcceptableTokens, getClassLoader, getFileContents, getLine, getLines, getRequiredTokens, getTabWidth, getTokenNames, init, isCommentNodesRequired, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens, visitToken
getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, log, setId, setSeverity
configure, contextualize, finishLocalSetup, getConfiguration, setupChild
public LineLengthCheck()
LineLengthCheck
instance.public int[] getDefaultTokens()
Check
getDefaultTokens
in class Check
TokenTypes
public void beginTree(DetailAST rootAST)
Check
public void setMax(int length)
length
- the maximum length of a linepublic void setIgnorePattern(String format) throws org.apache.commons.beanutils.ConversionException
format
- a String
valueorg.apache.commons.beanutils.ConversionException
- unable to parse formatCopyright © 2001–2015. All rights reserved.