com.puppycrawl.tools.checkstyle.checks

クラス AbstractOptionCheck<T extends Enum<T>>

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.AbstractOptionCheck<T>

型パラメータ:

T - the type of the option.

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

Configurable, Contextualizable

直系の既知のサブクラス:

EmptyBlockCheck, EmptyForInitializerPadCheck, EmptyForIteratorPadCheck, ImportOrderCheck, LeftCurlyCheck, MethodParamPadCheck, OperatorWrapCheck, ParenPadCheck, RightCurlyCheck, TypecastParenPadCheck

public abstract class AbstractOptionCheck<T extends Enum<T>>
extends Check

Abstract class for checks with a parameter named option, where the option is identified by a Enum. The logic to convert from a string representation to the Enum is to String.trim() the string and convert using String.toUpperCase() and then look up using Enum.valueOf(java.lang.Class<T>, java.lang.String).

作成者:

Oliver Burn, Rick Giles

フィールドの概要

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

DEFAULT_ERROR_SCORE, DEFAULT_INFO_SCORE, DEFAULT_WARNING_SCORE, mScoring, mViolationSize

コンストラクタの概要

コンストラクタ

コンストラクタと説明
AbstractOptionCheck(T aDefault, Class<T> aOptionClass) Creates a new AbstractOptionCheck instance.

メソッドの概要

メソッド

修飾子とタイプ	メソッドと説明
T	getAbstractOption()
void	setOption(String aOption) Set the option to enforce.

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

beginTree, destroy, finishTree, getAcceptableTokens, getClassLoader, getDefaultTokens, 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

コンストラクタの詳細

AbstractOptionCheck

public AbstractOptionCheck(T aDefault,
                   Class<T> aOptionClass)

Creates a new AbstractOptionCheck instance.

パラメータ:

aDefault - the default option.

aOptionClass - the class for the option. Required due to a quirk in the Java language.

メソッドの詳細

setOption

public void setOption(String aOption)
               throws org.apache.commons.beanutils.ConversionException

Set the option to enforce.

パラメータ:

aOption - string to decode option from

例外:

org.apache.commons.beanutils.ConversionException - if unable to decode

getAbstractOption

public T getAbstractOption()

戻り値:

the AbstractOption set