org.opengion.fukurou.util

## クラス FileInfo

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

-     public final class FileInfo
      extends Object

  FileInfo.java は、共通的に使用される File関連の情報管理を行うクラスです。 ファイルオブジェクトより、ファイル名、ファイル名(拡張子無し)、拡張子(ピリオド無)、 親パス の情報を、分割します。 また、一部のFileUtilのファイル属性を扱うメソッド類を移植してきました。 絶対パス は、File#getCanonicalPath() の値を設定します。 ../AAA/BBB/CCC.XLS というファイルオブジェクトに対して、 FILE : CCC.xls ファイル名 NAME : CCC 拡張子なしのファイル名 SUFIX : xls ピリオド無しの拡張子(小文字に統一) DIR : C:\tmp\BBB 親パス ファイル名と、拡張子は、File#getName() の結果から、一番最後に見つかった ピリオドで、前後を分割します。拡張子にはピリオドを含みません。 ピリオドがなければ、File#getName() の結果をファイル名に設定し、 拡張子は、空文字列を設定します。
  変更履歴:

    5.9.0.0 (2015/09/04) Ver.6からの逆移植

  機能分類
    ユーティリティ
  バージョン
    6.0
  作成者
    Kazuhiko Hasegawa
  導入されたバージョン:
    JDK8.0,

- - ### フィールドの概要

    フィールド
    修飾子とタイプ | フィールドと説明
    --- | ---
    `String` | `DIR` C:\tmp\BBB 親パス
    `String` | `FILE` CCC.xls ファイル名
    `static String[]` | `KEYS` ファイル情報のキー
    `String` | `NAME` CCC 拡張子なしのファイル名
    `String` | `SUFIX` xls ピリオド無しの拡張子(小文字に統一)

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

    コンストラクタ
    コンストラクタと説明
    `FileInfo(File file)` ファイルオブジェクトを引数に取るコンストラクター 絶対パス は、File#getCanonicalPath() の値を設定します。

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `static String` | `getNAME(File file)` ファイルオブジェクトから、名前部分のみを取得します。
    `static String` | `getNAME(String filename)` ファイル文字列から、名前部分のみを取得します。
    `static String` | `getSUFIX(File file)` ファイルオブジェクトから、拡張子(小文字に統一)のみを取得します。
    `static String` | `getSUFIX(String filename)` ファイル文字列から、拡張子(小文字に統一)のみを取得します。
    `String` | `getValue(String key)` キーに対応した値を返します。
    `static boolean` | `isSUFIX(File file, String... sufix)` ファイルオブジェクトから、指定の拡張子かどうかを判定します。
    `static boolean` | `isSUFIX(String filename, String... sufix)` ファイル文字列から、指定の拡張子かどうかを判定します。

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

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

- - ### フィールドの詳細

    - #### KEYS

          public static final String[] KEYS

      ファイル情報のキー

    - #### FILE

          public final String FILE

      CCC.xls ファイル名

    - #### NAME

          public final String NAME

      CCC 拡張子なしのファイル名

    - #### SUFIX

          public final String SUFIX

      xls ピリオド無しの拡張子(小文字に統一)

    - #### DIR

          public final String DIR

      C:\tmp\BBB 親パス

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

    - #### FileInfo

          public FileInfo(File file)

      ファイルオブジェクトを引数に取るコンストラクター 絶対パス は、File#getCanonicalPath() の値を設定します。 ../AAA/BBB/CCC.XLS というファイルオブジェクトに対して、 FILE : Fileオブジェクト File#getCanonicalFile() の値 FILE : CCC.xls ファイル名 NAME : CCC 拡張子なしのファイル名 SUFIX : xls ピリオド無しの拡張子(小文字に統一) DIR : C:\tmp\BBB 親パス ファイルオブジェクトは、File#getCanonicalFile(File) で、絶対パスに変換後、内部処理されます。 必要な情報は、final String に設定されるため、そこから情報を取得してください。
      パラメータ:
        `file` - ファイルオブジェクト
      変更履歴:

        6.2.0.0 (2015/02/27) 新規作成

  - ### メソッドの詳細

    - #### getValue

          public String getValue(String key)

      キーに対応した値を返します。 キーは、値が文字列の分だけです。
      パラメータ:
        `key` - ファイル情報のキー
      戻り値:
        ファイル情報の値(キーが未設定の場合はnull)
      例外:
        `NullPointerException` - key に null がセットされた場合
      変更履歴:

        6.2.0.0 (2015/02/27) 新規作成

    - #### getNAME

          public static String getNAME(File file)

      ファイルオブジェクトから、名前部分のみを取得します。 名前だけ取得したい場合の、簡易スタティックメソッドです。 ピリオドがない場合は、ファイル名を、先頭がピリオドの場合は、 ゼロ文字列です。 オブジェクトを作成しません。
      パラメータ:
        `file` - ファイルオブジェクト
      戻り値:
        ファイルの名称(引数がnullの場合はnull)
      変更履歴:

        6.2.3.0 (2015/05/01) 新規作成

    - #### getNAME

          public static String getNAME(String filename)

      ファイル文字列から、名前部分のみを取得します。 名前だけ取得したい場合の、簡易スタティックメソッドです。 ピリオドがない場合は、ファイル名を、先頭がピリオドの場合は、 ゼロ文字列です。
      パラメータ:
        `filename` - ファイル文字列
      戻り値:
        ファイルの名称(引数がnullの場合はnull)
      変更履歴:

        6.2.3.0 (2015/05/01) 新規作成

    - #### getSUFIX

          public static String getSUFIX(File file)

      ファイルオブジェクトから、拡張子(小文字に統一)のみを取得します。 拡張子だけ取得したい場合の、簡易スタティックメソッドです。 ピリオドがない場合は、ゼロ文字列を返します。 オブジェクトを作成しません。
      パラメータ:
        `file` - ファイルオブジェクト
      戻り値:
        ファイルの拡張子(小文字に統一,引数がnullの場合はnull)
      変更履歴:

        6.2.3.0 (2015/05/01) 新規作成

    - #### getSUFIX

          public static String getSUFIX(String filename)

      ファイル文字列から、拡張子(小文字に統一)のみを取得します。 拡張子だけ取得したい場合の、簡易スタティックメソッドです。 ピリオドがない場合は、ゼロ文字列を返します。
      パラメータ:
        `filename` - ファイル文字列
      戻り値:
        ファイルの拡張子(小文字に統一,引数がnullの場合はnull)
      変更履歴:

        6.2.3.0 (2015/05/01) 新規作成

    - #### isSUFIX

          public static boolean isSUFIX(File file,
                        String... sufix)

      ファイルオブジェクトから、指定の拡張子かどうかを判定します。 拡張子判定に特化した、簡易スタティックメソッドです。 引数の拡張子には、ピリオドは含めません。 比較する拡張子の大文字小文字は区別しません。
      パラメータ:
        `file` - ファイルオブジェクト
        `sufix` - 拡張子群
      戻り値:
        true:拡張子が含まれる/false:含まれない
      変更履歴:

        6.2.4.0 (2015/05/15) 新規作成

    - #### isSUFIX

          public static boolean isSUFIX(String filename,
                        String... sufix)

      ファイル文字列から、指定の拡張子かどうかを判定します。 拡張子判定に特化した、簡易スタティックメソッドです。 引数の拡張子には、ピリオドは含めません。 比較する拡張子の大文字小文字は区別しません。
      パラメータ:
        `filename` - ファイル文字列
        `sufix` - 拡張子群
      戻り値:
        true:拡張子が含まれる/false:含まれない
      変更履歴:

        6.2.4.0 (2015/05/15) 新規作成

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