org.lastaflute.di.core

インタフェース LaContainer

すべてのスーパーインタフェース:

MetaDefAware

既知の実装クラスのリスト:

LaContainerImpl, ThreadSafeLaContainerImpl

public interface LaContainer
extends MetaDefAware

DIとAOPをサポートしたS2コンテナのインターフェースです。

S2Containerの役割について

コンポーネントの管理を行う機能を提供します。 コンポーネントとは１つかまたそれ以上のクラスで構成されるJavaオブジェクトです。 S2コンテナはコンポーネントの生成、コンポーネントの初期化、コンポーネントの取得を提供します。 コンポーネントを取得するキーには、コンポーネント名、コンポーネントのクラス、またはコンポーネントが実装するインターフェースを指定することができます。

S2コンテナのインスタンス階層について

S2コンテナ全体は複数のコンテナにより階層化されています。 一つのコンテナは複数のコンテナをインクルードすることができます。 複数のコンテナが同一のコンテナをインクルードすることができます。

インクルードの参照範囲についてのイメージを示します。

コンテナの検索順についてのイメージを示します。

S2コンテナのインジェクションの種類について

S2コンテナは3種類のインジェクションをサポートします。

コンストラクタ・インジェクション

コンストラクタ引数を利用してコンポーネントをセットします。

セッター・インジェクション

セッターメソッドを利用してコンポーネントをセットします。

メソッド・インジェクション

任意のメソッドを利用してコンポーネントをセットします。

S2Containerが持つメソッドの分類について

コンテナへの登録、コンテナからのコンポーネント取得、検索などを行うコンポーネントを管理する機能

• getComponent
• getComponentDefSize
• getComponentDef
• findComponents
• findAllComponents
• findLocalComponents
• findComponentDefs
• findAllComponentDefs
• findLocalComponentDefs
• hasComponentDef
• register
• injectDependency

コンテナの初期化、終了処理、コンテナの階層化、階層化されたコンテナへのアクセスなどコンテナを管理する機能

• getNamespace
• setNamespace
• getPath getPath getPath
• setPath setPath setPath
• getClassLoader
• setClassLoader
• init
• destroy
• getExternalContext
• setExternalContext
• getExternalContextComponentDefRegister
• setExternalContextComponentDefRegister
• hasDescendant
• getDescendant
• registerDescendant
• include
• getChildSize
• getChild
• getParentSize
• getParent
• addParent
• getRoot
• setRoot
• registerMap

作成者:

modified by jflute (originated in Seasar), vestige & SeasarJavaDoc Committers

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	addParent(LaContainer parent)
void	destroy()
ComponentDef[]	findAllComponentDefs(Object componentKey)
Object[]	findAllComponents(Object componentKey)
LaContainer	findChild(String namespace)
ComponentDef[]	findComponentDefs(Object componentKey)
Object[]	findComponents(Object componentKey)
ComponentDef[]	findLocalComponentDefs(Object componentKey)
Object[]	findLocalComponents(Object componentKey)
LaContainer	getChild(int index)
int	getChildSize()
ClassLoader	getClassLoader()
<COMPONENT> COMPONENT	getComponent(Object componentKey)
ComponentDef	getComponentDef(int index)
ComponentDef	getComponentDef(Object componentKey)
int	getComponentDefSize()
LaContainer	getDescendant(String path)
ExternalContext	getExternalContext()
ExternalContextComponentDefRegister	getExternalContextComponentDefRegister()
String	getNamespace()
LaContainer	getParent(int index)
int	getParentSize()
String	getPath()
LaContainer	getRoot()
boolean	hasComponentDef(Object componentKey)
boolean	hasDescendant(String path)
void	include(LaContainer child)
void	init()
void	injectDependency(Object outerComponent)
void	injectDependency(Object outerComponent, Class<?> componentClass)
void	injectDependency(Object outerComponent, String componentName)
boolean	isInitializeOnCreate()
void	register(Class<?> componentClass)
void	register(Class<?> componentClass, String componentName)
void	register(ComponentDef componentDef)
void	register(Object component)
void	register(Object component, String componentName)
void	registerByClass(ComponentDef componentDef)
void	registerDescendant(LaContainer descendant)
void	registerMap(Object key, ComponentDef componentDef, LaContainer container)
void	setClassLoader(ClassLoader classLoader)
void	setExternalContext(ExternalContext externalContext)
void	setExternalContextComponentDefRegister(ExternalContextComponentDefRegister externalContextComponentDefRegister)
void	setInitializeOnCreate(boolean initializeOnCreate)
void	setNamespace(String namespace)
void	setPath(String path)
void	setRoot(LaContainer root)

インタフェースから継承されたメソッド org.lastaflute.di.core.meta.MetaDefAware

addMetaDef, getMetaDef, getMetaDef, getMetaDefs, getMetaDefSize

メソッドの詳細

getComponent

<COMPONENT> COMPONENT getComponent(Object componentKey)
                            throws ComponentNotFoundRuntimeException,
                                   TooManyRegistrationRuntimeException,
                                   CyclicReferenceRuntimeException

例外:

ComponentNotFoundRuntimeException

TooManyRegistrationRuntimeException

CyclicReferenceRuntimeException

findComponents

Object[] findComponents(Object componentKey)
                 throws CyclicReferenceRuntimeException

例外:

CyclicReferenceRuntimeException

findAllComponents

Object[] findAllComponents(Object componentKey)
                    throws CyclicReferenceRuntimeException

例外:

CyclicReferenceRuntimeException

findLocalComponents

Object[] findLocalComponents(Object componentKey)
                      throws CyclicReferenceRuntimeException

パラメータ:

componentKey - The key of the component. (NotNull)

戻り値:

The array of found components. (NotNull: if not found, returns empty)

例外:

CyclicReferenceRuntimeException

injectDependency

void injectDependency(Object outerComponent)
               throws ClassUnmatchRuntimeException

例外:

ClassUnmatchRuntimeException

injectDependency

void injectDependency(Object outerComponent,
                      Class<?> componentClass)
               throws ClassUnmatchRuntimeException

例外:

ClassUnmatchRuntimeException

injectDependency

void injectDependency(Object outerComponent,
                      String componentName)
               throws ClassUnmatchRuntimeException

例外:

ClassUnmatchRuntimeException

register

void register(Object component)

register

void register(Object component,
              String componentName)

register

void register(Class<?> componentClass)

register

void register(Class<?> componentClass,
              String componentName)

register

void register(ComponentDef componentDef)

registerByClass

void registerByClass(ComponentDef componentDef)

getComponentDefSize

int getComponentDefSize()

getComponentDef

ComponentDef getComponentDef(int index)

getComponentDef

ComponentDef getComponentDef(Object componentKey)
                      throws ComponentNotFoundRuntimeException

例外:

ComponentNotFoundRuntimeException

findComponentDefs

ComponentDef[] findComponentDefs(Object componentKey)

findAllComponentDefs

ComponentDef[] findAllComponentDefs(Object componentKey)

findLocalComponentDefs

ComponentDef[] findLocalComponentDefs(Object componentKey)

hasComponentDef

boolean hasComponentDef(Object componentKey)

hasDescendant

boolean hasDescendant(String path)

getDescendant

LaContainer getDescendant(String path)
                   throws ContainerNotRegisteredRuntimeException

例外:

ContainerNotRegisteredRuntimeException

registerDescendant

void registerDescendant(LaContainer descendant)

include

void include(LaContainer child)

findChild

LaContainer findChild(String namespace)

getChildSize

int getChildSize()

getChild

LaContainer getChild(int index)

getParentSize

int getParentSize()

getParent

LaContainer getParent(int index)

addParent

void addParent(LaContainer parent)

init

void init()

destroy

void destroy()

registerMap

void registerMap(Object key,
                 ComponentDef componentDef,
                 LaContainer container)

getNamespace

String getNamespace()

setNamespace

void setNamespace(String namespace)

isInitializeOnCreate

boolean isInitializeOnCreate()

setInitializeOnCreate

void setInitializeOnCreate(boolean initializeOnCreate)

getPath

String getPath()

setPath

void setPath(String path)

getRoot

LaContainer getRoot()

setRoot

void setRoot(LaContainer root)

getExternalContext

ExternalContext getExternalContext()

setExternalContext

void setExternalContext(ExternalContext externalContext)

getExternalContextComponentDefRegister

ExternalContextComponentDefRegister getExternalContextComponentDefRegister()

setExternalContextComponentDefRegister

void setExternalContextComponentDefRegister(ExternalContextComponentDefRegister externalContextComponentDefRegister)

getClassLoader

ClassLoader getClassLoader()

setClassLoader

void setClassLoader(ClassLoader classLoader)