com.puppycrawl.tools.checkstyle.api

クラス AutomaticBean

java.lang.Object

com.puppycrawl.tools.checkstyle.api.AutomaticBean

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

Configurable, Contextualizable

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

AbstractViolationReporter, Checker, DefaultLogger, SeverityMatchFilter, SuppressionCommentFilter, SuppressionFilter, SuppressWithNearbyCommentFilter, XMLLogger

public class AutomaticBean
extends Object
implements Configurable, Contextualizable

A Java Bean that implements the component lifecycle interfaces by calling the bean's setters for all configuration attributes.

作成者:

lkuehne

コンストラクタの概要

コンストラクタ

コンストラクタと説明
AutomaticBean()

メソッドの概要

メソッド

修飾子とタイプ	メソッドと説明
void	configure(Configuration aConfiguration) Implements the Configurable interface using bean introspection.
void	contextualize(Context aContext) Implements the Contextualizable interface using bean introspection.
protected void	finishLocalSetup() Provides a hook to finish the part of this component's setup that was not handled by the bean introspection.
protected Configuration	getConfiguration() Returns the configuration that was used to configure this component.
protected void	setupChild(Configuration aChildConf) Called by configure() for every child of this component's Configuration.

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

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

コンストラクタの詳細

AutomaticBean

public AutomaticBean()

メソッドの詳細

configure

public final void configure(Configuration aConfiguration)
                     throws CheckstyleException

Implements the Configurable interface using bean introspection. Subclasses are allowed to add behaviour. After the bean based setup has completed first the method finishLocalSetup is called to allow completion of the bean's local setup, after that the method setupChild is called for each child Configuration of aConfiguration.

定義:

configure インタフェース内 Configurable

パラメータ:

aConfiguration - the configuration to use.

例外:

CheckstyleException - if there is a configuration error.

関連項目:

Configurable

contextualize

public final void contextualize(Context aContext)
                         throws CheckstyleException

Implements the Contextualizable interface using bean introspection.

定義:

contextualize インタフェース内 Contextualizable

パラメータ:

aContext - the context.

例外:

CheckstyleException - if there is a contextualization error.

関連項目:

Contextualizable

getConfiguration

protected final Configuration getConfiguration()

Returns the configuration that was used to configure this component.

戻り値:

the configuration that was used to configure this component.

finishLocalSetup

protected void finishLocalSetup()
                         throws CheckstyleException

Provides a hook to finish the part of this component's setup that was not handled by the bean introspection.

The default implementation does nothing.

例外:

CheckstyleException - if there is a configuration error.

setupChild

protected void setupChild(Configuration aChildConf)
                   throws CheckstyleException

Called by configure() for every child of this component's Configuration.

The default implementation does nothing.

パラメータ:

aChildConf - a child of this component's Configuration

例外:

CheckstyleException - if there is a configuration error.

関連項目:

Configuration.getChildren()