org.opengion.fukurou.util

## クラス FileMap

- java.lang.Object
- - org.opengion.fukurou.util.FileMap

-     public final class FileMap
      extends Object

  FileMap は、ファイルを読み取って、キー情報から、ファイルへのリンクを作成するための 情報を返します。 ファイルそのものは、指定のディレクトリをすべて読み取り、拡張子以外の部分を、キーとして 登録します。(キーは大文字に統一されます。) 実際のファイルの拡張子は、リンク作成時の処理で付与されます。 例えば、HELPファイルを、XXXX.html や、XXXX.htm 、XXXX.pdf など、色々な形態で作成した 場合でも、キーとしては、XXXX で存在チェックをかけることができるようになります。 ファイルは、一旦すべて読み取ってメモリ上で管理されます。 ディレクトリの再読取が必要な場合は、オブジェクトを再作成する必要があります。
  バージョン
    4.0
  作成者
    Kazuhiko Hasegawa
  導入されたバージョン:
    JDK5.0,

- - ### コンストラクタの概要

    コンストラクタ
    コンストラクタと説明
    `FileMap(String dir)` 読み取るディレクトリを指定して、ファイルマップを構築します。
    `FileMap(String dir, Set<?> resourcePaths)` すでに読み取った Set オブジェクトを指定して、ファイルマップを構築します。

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `boolean` | `exists(String key)` 指定のキーのファイルが存在しているかどうかを返します。
    `String` | `getFilename(String key)` キーに対応したファイル名を返します。

    - ### クラスから継承されたメソッド java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### コンストラクタの詳細

    - #### FileMap

          public FileMap(String dir,
                 Set<?> resourcePaths)
                  throws IllegalArgumentException

      すでに読み取った Set オブジェクトを指定して、ファイルマップを構築します。 これは、ServletContext を利用した、META-INF/resources からの読み取り対応になります。 一覧を取得するのは、ServletContext 関連の実装が必要になるため、fukurou では java の一般的なオブジェクトである Set を処理するだけとします。 ファイル名は、dir を削除した残りで構築します。フォルダ階層を含みます。 Mapのキーは、フォルダ階層を含まない、ファイル名のみとします。 つまり、フォルダ階層を持ってリソースを用意しておいても、キーとしては、 ファイル名のみを使用します。
      パラメータ:
        `dir` - ディレクトリ
        `resourcePaths` - リソースパス
      例外:
        `IllegalArgumentException` - 引数の dir や、resourcePaths が、null の場合
      変更履歴:

        5.5.4.2 (2012/07/13) 新規作成

    - #### FileMap

          public FileMap(String dir)
                  throws IllegalArgumentException

      読み取るディレクトリを指定して、ファイルマップを構築します。 このディレクトリは、OSに対する物理アドレスになります。
      パラメータ:
        `dir` - ディレクトリ
      例外:
        `IllegalArgumentException` - 引数の dir が存在しないか、ディレクトリ出ない場合。
      変更履歴:

        5.5.4.2 (2012/07/13) makeFileMap() を直接コンストラクターとして使用

  - ### メソッドの詳細

    - #### exists

          public boolean exists(String key)

      指定のキーのファイルが存在しているかどうかを返します。 存在している場合は、true , 存在していない場合は、false になります。
      パラメータ:
        `key` - 指定のキー
      戻り値:
        存在しているかどうか(true:存在する/false:存在しない)
      例外:
        `IllegalArgumentException` - キーが指定されていません。

    - #### getFilename

          public String getFilename(String key)

      キーに対応したファイル名を返します。 指定のキーに対するファイル名が存在しない場合は、null を返します。
      パラメータ:
        `key` - 指定のキー
      戻り値:
        ファイル名(ディレクトリパスは含まず)

Webアプリケーションフレームワーク openGion
Copyright (c) 2009 The openGion Project.