[seasar-javadoc:845] Re: ClassPathResourceResolver

[Koichi Kobayashi]

小林 (koichik) です．

Date:    Sat, 17 Mar 2007 13:10:23 +0900
From:    "Tsuyoshi Yamamoto" <[E-MAIL ADDRESS DELETED]>
To:      [E-MAIL ADDRESS DELETED]
Subject: [seasar-javadoc:840] Re: ClassPathResourceResolver

> 修正したソースをお送りしますので、ご確認お願いします。

ありがとうございます！！

■クラスコメント

>  * コンテキストクラスローダから、指定されたリソースを読み込む{@link InputStream}を生成します。

「InputStreamを生成します」だとメソッドの説明になって
しまってる感があるので，「ResourceResolverの実装です」
みたいな表現がいいですね．

>  * このクラスでは、リソース読み込みの際に{@link org.seasar.framework.env.Env#adjustPath(String)}を利用して、<a

「このクラスでは」は「このクラスは」の方がいいかなぁ．

「<a」で改行されてるのはフォーマッタのせい？
一応，句読点の後にスペースを入れるのがお約束で，
そうすればもうちょっと適切に改行してくれると思います．

>  * href="http://s2container.seasar.org/ja/conditionalInclude.html#implicit">暗黙的な条件インクルード</a>を実現します。<code>WEB-INF/classes</code>以下に配置されたenv.txtに記述された内容を元に、読み込む<code>.dicon</code>ファイルを変更します。

env.txt が WEB-INF/classes にあるとは限らないので，
ここは「クラスパスに配置された」とかで．

>  * 絶対パス・相対パスでリソースを指定した際には、コンテキストクラスローダから取得した<code>URL</code>オブジェクトを元に、リソースを読み込みます。また、絶対パス・相対パス以外にも、以下のようにURL形式でパスを指定することも可能です。

っと，「絶対パス」の指定って意味がないので，ここは
相対パスだけでいいです．
/ で始まるパスを指定しても，ファイルシステムのルートからの
パスとして扱われるわけではないので，絶対パスとは言えません．
あくまでもクラスパスに設定されているディレクトリからの
相対パスか，Jar ファイル内のエントリとして解釈されます．

それから，パスの形式が二種類あることを示してから個別に
説明した方がいいかも．

■getInputStream(final String path)

>      * 指定されたパスのリソースを読み取る<code>InputStream</code>を返します。

ResourceResolver#getInputStream() の Javadoc では
「InputStream」ではなく「入力ストリーム」なので，
揃えてください．

>      * パスを表すURLオブジェクトを生成できない場合には<code>null</code>を返します。

「URLオブジェクトを生成できない」はメソッドの中の話であって，
このメソッドを利用する人向けの説明としては「入力ストリームを
生成できない」の方がよさげ．

■getURL(final String path)

>      * <code>URL</code>オブジェクトの生成の際には、暗黙的条件インクルードによる読みこみ対象<code>.dicon</code>ファイルを変更します。

「暗黙的条件インクルードによる」は「〜により」かなぁ．
でないと「変更します」につながらないような．
むしろ，「暗黙的条件インクルードをサポートするために」
とか．

■toURL(final String path)

>      * 物理パス・論理パスが指定された場合には、コンテキストクラスローダから取得した<code>URL</code>オブジェクトを返します。コロンを含むパスの場合には、URL形式でパスが指定されたと判定し、新規に生成した<code>URL</code>オブジェクトを返します。

なぜいきなり「物理パス・論理パス」？ (^^;


-- 
<component name="koichik">
    <property name="fullName">"Koichi Kobayashi"</property>
    <property name="email">"[E-MAIL ADDRESS DELETED]"</property>
    <property name="blog">"http://d.hatena.ne.jp/koichik"</property>
</component>