[seasar-javadoc:517] Re: S2Container

[Koichi Kobayashi]

小林 (koichik) です．

Date:    Wed, 16 Aug 2006 01:56:03 +0900
From:    "Makoto Yonezawa" <stratosphire ＠ gmail.com>
To:      seasar-javadoc ＠ ml.seasar.org
Subject: [seasar-javadoc:516] Re: S2Container

> なんとかがんばって生きてます、米澤です。
> 落ち着いたと思ったら気のせいだったようです；_；

あと少しの辛抱．．． だよね？
頑張れ〜．

> #findComponents、#findAllComponents、#findLocalComponentsを書きました。
> つっこみお願いしますm_ _m
> それと、Defsの系の確認に、#findComponentDefsを書きました。
> 
> あと、クラスコメントも少し肉？を付けてみました。

ありがとうございます．

> #findComponents
(略)
>  * 検索の対象は現在のS2コンテナおよび、インクルードしているS2コンテナの階層全体です。
>  * キーに対応するコンポーネントが最初に見つかったS2コンテナを対象とします。

「対象」が 2 回出てくると戸惑うかもしれませんね．
前者は「範囲」にしましょうか．

>  * @return
>  *        キーが文字列の場合、名前が一致するコンポーネントを返します。
>  *        キーがクラスまたはインターフェースの場合、キーの型に代入可能なコンポーネントを返します。

「コンポーネントの配列を返します」で．
                ^^^^^^
>  *        キーに対応するコンポーネントが存在しない場合は空の配列を返します。

油断してましたが，昨日返事をした山本さんの MetaDefAware では
「空の配列」ではなく「要素数0の配列」でした．
表記を揃えた方がいいですね．
JDK の Javadoc では「長さ0の配列」が多いかも．

> #findAllComponents
(略)
>  * 検索の対象は現在のS2コンテナおよび、インクルードしているS2コンテナの階層全体です。

findComponents() 同様，「検索の範囲は」で．

>  * @return
>  *        キーが文字列の場合、名前が一致するコンポーネントを返します。
>  *        キーがクラスまたはインターフェースの場合、キーの型に代入可能なコンポーネントを返します。

同様に「コンポーネントの配列を返します」で．

> #findLocalComponents
(略)
>  * 検索の対象は現在のS2コンテナのみです。

同上．

>  * @return
>  *        キーが文字列の場合、名前が一致するコンポーネントを返します。
>  *        キーがクラスまたはインターフェースの場合、キーの型に代入可能なコンポーネントを返します。

同上．

> #findComponentDefs
(略)
>  * 検索の対象は現在のS2コンテナおよび、インクルードしているS2コンテナの階層全体です。

同上．

>  * @return
>  *        キーが文字列の場合、名前が一致するコンポーネント定義を返します。
>  *        キーがクラスまたはインターフェースの場合、キーの型に代入可能なコンポーネント定義を返します。

同上．


細かい点だけでした．
これでメソッドのコメントはほぼ完了ですね！！


> ＋＋＋＋＋＋＋＋＋＋＋＋＋＋＋＋＋＋＋＋＋＋＋＋＋＋＋＋＋＋＋＋＋＋＋＋＋＋＋＋＋＋＋＋＋＋＋＋＋＋＋＋＋＋＋
> 概要
> 
> S2コンテナはSeasarの基本的な部分です。
> DIを実現する機能を提供します。
> 依存性の少ないコンポーネントを扱う（管理する）ことができます。
> これにより、テスタビリティ、変更容易性、再利用性を向上させることが可能になります。

これは「S2 コンテナ」の説明であって，「S2Container」の
Javadoc に書く必要はないような．．．

> コンテナの構造
> #------------------#
> #(ヘッダ)
> #<components>(ルート)
> #
> #include diconファイルへのパス
> #
> #<component>（コンポーネント）
> #</component>
> #
> #<component>（コンポーネント）
> #</component>
> #
> #</components>

構造は是非書きたい内容ですが，あまり dicon に引きずられたくは
ないですね．
dicon を扱うのは XmlS2ContainerBuilder であって，S2Container は
dicon とは独立しているので．


ともあれ (JW)，もう一息頑張ってください！！


-- 
<component name="koichik">
    <property name="fullName">"Koichi Kobayashi"</property>
    <property name="email">"koichik ＠ improvement.jp"</property>
    <property name="blog">"http://d.hatena.ne.jp/koichik"</property>
</component>