com.puppycrawl.tools.checkstyle.checks.sizes

クラス LineLengthCheck

java.lang.Object

com.puppycrawl.tools.checkstyle.api.AutomaticBean

com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

com.puppycrawl.tools.checkstyle.api.Check

com.puppycrawl.tools.checkstyle.checks.sizes.LineLengthCheck

すべての実装されたインタフェース:

Configurable, Contextualizable

public class LineLengthCheck
extends Check

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.

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>
 

作成者:

Lars Kühne

フィールドの概要

クラスから継承されたフィールド com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

DEFAULT_ERROR_SCORE, DEFAULT_INFO_SCORE, DEFAULT_WARNING_SCORE, mScoring, mViolationSize

コンストラクタの概要

コンストラクタ

コンストラクタと説明
LineLengthCheck() Creates a new LineLengthCheck instance.

メソッドの概要

メソッド

修飾子とタイプ	メソッドと説明
void	beginTree(DetailAST aRootAST) Called before the starting to process a tree.
int[]	getDefaultTokens() Returns the default token a check is interested in.
void	setIgnorePattern(String aFormat) Set the ignore pattern.
void	setMax(int aLength)

クラスから継承されたメソッド com.puppycrawl.tools.checkstyle.api.Check

destroy, finishTree, getAcceptableTokens, getClassLoader, getFileContents, getLines, getRequiredTokens, getTabWidth, getTokenNames, init, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens, visitToken

クラスから継承されたメソッド com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

calculateScore, getCustomMessages, getErrorScore, getId, getInfoScore, getMessageBundle, getScore, getScoring, getSeverity, getSeverityLevel, getWarningScore, log, setErrorScore, setId, setInfoScore, setScore, setScoring, setSeverity, setWarningScore

クラスから継承されたメソッド com.puppycrawl.tools.checkstyle.api.AutomaticBean

configure, contextualize, finishLocalSetup, getConfiguration, setupChild

クラスから継承されたメソッド java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

LineLengthCheck

public LineLengthCheck()

Creates a new LineLengthCheck instance.

メソッドの詳細

getDefaultTokens

public int[] getDefaultTokens()

クラスからコピーされた説明: Check

Returns the default token a check is interested in. Only used if the configuration for a check does not define the tokens.

定義:

getDefaultTokens クラス内 Check

戻り値:

the default tokens

関連項目:

TokenTypes

beginTree

public void beginTree(DetailAST aRootAST)

クラスからコピーされた説明: Check

Called before the starting to process a tree. Ideal place to initialise information that is to be collected whilst processing a tree.

オーバーライド:

beginTree クラス内 Check

パラメータ:

aRootAST - the root of the tree

setMax

public void setMax(int aLength)

パラメータ:

aLength - the maximum length of a line

setIgnorePattern

public void setIgnorePattern(String aFormat)
                      throws org.apache.commons.beanutils.ConversionException

Set the ignore pattern.

パラメータ:

aFormat - a String value

例外:

org.apache.commons.beanutils.ConversionException - unable to parse aFormat