[seasar-javadoc:788] Re: PathResolver

Koichi Kobayashi koichik @ improvement.jp
2007年 1月 31日 (水) 00:00:17 JST


小林 (koichik) です.

Date:    Mon, 29 Jan 2007 07:14:21 +0900
From:    "Jundo Ishikawa" <jundo.ishikawa @ gmail.com>
To:      seasar-javadoc @ ml.seasar.org
Subject: [seasar-javadoc:787] Re: PathResolver

>  やはり、どう解釈するかは実装次第なのですよね。

そうなります.そのためのエクステンションポイントなので.

>  私としては、論理パスの方がしっくりきたので変更しました。あと、コンテキ
> ストのあたりも書き換えてあります。

ありがとうございます.
以下,コメントです.

■クラスコメント

>  * 論理パスから物理(リアル)パスを取得するためのインターフェースです。

どうせなら,「(リアル)」はなくてもいいかも.

>  * パスリゾルバに指定する論理パスとは、 設定ファイルのincludeに指定されたパスを指し、 物理パスは、 {@link ResourceResolver}に渡されるパスを指します。

ここは <dl> を使って

<dl>
<dt>論理パス</dt>
<dd>コンテナの生成時や、インクルード時に指定されたパス名です。</dd>
<dt>物理パス</dt>
<dd>{@link ResourceResolver}に渡されるパスです。</dd>
</dl>

って感じでどうでしょう?

■resolvePath(String context, String path)

>      * コンテキストとしてそのパスをインクルードしている設定ファイルの物理パスを設定することで、 そのコンテキストにおける論理パスの解決を行います。
>      * ルートコンテナの様にインクルードしている設定ファイルがない場合は、 コンテキストに<code>null</code>を指定します。

これはコンテキストの使い方の一例であって,実装クラスが
このようにしなくてはいけないというものではないので,
ちょっと紛らわしい感じがします.

それから,「指定します」は微妙かも.
指定をするのは利用者ですが,Javadoc は利用者を主語として
書くわけではないような.
そんなわけで (どんなわけで?),

<code>path</code>がインクルードで指定されたパスの場合、
<code>context</code>はインクルード先となるコンテナの
設定ファイルの物理パスです.
ルートコンテナの作成時などインクルード先のコンテナがない場合や、
インクルード先のコンテナが設定ファイルを持っていない場合は、
<code>context</code>は<code>null</code>です.

みたいな.


-- 
<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>



seasar-javadoc メーリングリストの案内