LaContainer (Lasta Di 0.6.0-RC2 API)

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

MetaDefAware

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

LaContainerImpl, ThreadSafeLaContainerImpl
```
public interface LaContainer
extends MetaDefAware
```
DIとAOPをサポートしたS2コンテナのインターフェースです。
S2Containerの役割について

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

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

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

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

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

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

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

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

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

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

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

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

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

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

コンテナへの登録、コンテナからのコンポーネント取得、検索などを行うコンポーネントを管理する機能
コンテナの初期化、終了処理、コンテナの階層化、階層化されたコンテナへのアクセスなどコンテナを管理する機能
作成者:

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

メソッドのサマリー

All Methods Instance Methods Abstract Methods
修飾子とタイプ	メソッドと説明
`void`	`addParent(LaContainer parent)`
`void`	`destroy()`
`ComponentDef[]`	`findAllComponentDefs(Object componentKey)` 指定されたキーに対応する複数のコンポーネント定義を検索して返します。
`Object[]`	`findAllComponents(Object componentKey)`
`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)` `outerComponent`のクラスをキーとして登録された `コンポーネント定義`に従って、必要なコンポーネントのインジェクションを実行します。
`void`	`injectDependency(Object outerComponent, Class<?> componentClass)` `componentClass`をキーとして登録された `コンポーネント定義`に従って、必要なコンポーネントのインジェクションを実行します。
`void`	`injectDependency(Object outerComponent, String componentName)` `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
```
    outerComponentのクラスをキーとして登録された コンポーネント定義に従って、必要なコンポーネントのインジェクションを実行します。アスペクト、コンストラクタ・インジェクションは適用できません。
    コンポーネント定義のインスタンス定義は outerでなくてはなりません。
    
    パラメータ:
    
    outerComponent - 外部コンポーネント
    
    例外:
    
    ClassUnmatchRuntimeException - 適合するコンポーネント定義が見つからない場合
  - injectDependency
```
void injectDependency(Object outerComponent,
                      Class<?> componentClass)
               throws ClassUnmatchRuntimeException
```
    componentClassをキーとして登録された コンポーネント定義に従って、必要なコンポーネントのインジェクションを実行します。アスペクト、コンストラクタ・インジェクションは適用できません。
    コンポーネント定義のインスタンス定義は outerでなくてはなりません。
    
    パラメータ:
    
    outerComponent - 外部コンポーネント
    
    componentClass - コンポーネント定義のキー (クラス)
    
    例外:
    
    ClassUnmatchRuntimeException - 適合するコンポーネント定義が見つからない場合
  - injectDependency
```
void injectDependency(Object outerComponent,
                      String componentName)
               throws ClassUnmatchRuntimeException
```
    componentNameをキーとして登録された コンポーネント定義に従って、インジェクションを実行します。アスペクト、コンストラクタ・インジェクションは適用できません。
    コンポーネント定義のインスタンス定義は outerでなくてはなりません。
    
    パラメータ:
    
    outerComponent - 外部コンポーネント
    
    componentName - コンポーネント定義のキー (名前)
    
    例外:
    
    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)
```
    指定されたキーに対応する複数のコンポーネント定義を検索して返します。
    検索の範囲は現在のS2コンテナおよび、インクルードしているS2コンテナの階層全体です。キーに対応するコンポーネントが最初に見つかったS2コンテナとその子孫コンテナの全てを対象とします。対象になるS2コンテナ全体から、キーに対応する全てのコンポーネント定義を配列で返します。
    
    パラメータ:
    
    componentKey - コンポーネント定義を取得するためのキー
    
    戻り値:
    
    キーに対応するコンポーネント定義の配列を返します。キーに対応するコンポーネント定義が存在しない場合は長さ0の配列を返します。
    
    関連項目:
    
    findComponentDefs(java.lang.Object), findLocalComponentDefs(java.lang.Object)
  - findLocalComponentDefs
```
ComponentDef[] findLocalComponentDefs(Object componentKey)
```
    指定されたキーに対応する複数のコンポーネント定義を検索して返します。
    検索の範囲は現在のS2コンテナのみです。現在のS2コンテナから、キーに対応する全てのコンポーネント定義を配列で返します。
    
    パラメータ:
    
    componentKey - コンポーネント定義を取得するためのキー
    
    戻り値:
    
    キーに対応するコンポーネント定義の配列を返します。キーに対応するコンポーネント定義が存在しない場合は長さ0の配列を返します。
    
    関連項目:
    
    findComponentDefs(java.lang.Object), findAllComponentDefs(java.lang.Object)
  - 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)
```
  - 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)
```

インタフェース LaContainer

S2Containerの役割について

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

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

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

メソッドのサマリー

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

メソッドの詳細

getComponent

findComponents

findAllComponents

findLocalComponents

injectDependency

injectDependency

injectDependency

register

register

register

register

register

registerByClass

getComponentDefSize

getComponentDef

getComponentDef

findComponentDefs

findAllComponentDefs

findLocalComponentDefs

hasComponentDef

hasDescendant

getDescendant

registerDescendant

include

getChildSize

getChild

getParentSize

getParent

addParent

init

destroy

registerMap

getNamespace

setNamespace

isInitializeOnCreate

setInitializeOnCreate

getPath

setPath

getRoot

setRoot

getExternalContext

setExternalContext

getExternalContextComponentDefRegister

setExternalContextComponentDefRegister

getClassLoader

setClassLoader