org.opengion.fukurou.util

## クラス FileString

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

-     public class FileString
      extends Object

       FileString は、ファイルを読み取って、そのまま String 文字列として返すクラスです。
       SQLを記述したファイルや、コマンドを記述したファイルを読み取って、コマンドラインからの
       入力として利用できます。

       ファイルは、一旦すべて読み取ってメモリ上で加工されます。
       パラメータ等の設定ファイルをイメージしている為、巨大なファイルの読み込みは出来ません。

  バージョン
    4.0
  作成者
    Kazuhiko Hasegawa
  導入されたバージョン:
    JDK5.0,

- - ### コンストラクタのサマリー

    コンストラクタ
    コンストラクタと説明
    `FileString()` デフォルトコンストラクター
    `FileString(String filename)` ファイル名と、エンコード名を指定して構築する コンストラクター
    `FileString(String filename, String encode)` ファイル名と、エンコード名を指定して構築する コンストラクター

  - ### メソッドのサマリー

    すべてのメソッド インスタンス・メソッド concreteメソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `String` | `getValue()` ファイルを読み取って、文字列を作成します。
    `String[]` | `getValues()` 改行コードで分割します。
    `String[]` | `getValues(String regex)` 指定された正規表現に一致する位置で分割します。
    `void` | `setEncode(String encode)` ファイルのエンコードを設定します。
    `void` | `setFilename(String filename)` ファイル名を設定します。

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

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

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

    - #### FileString

          public FileString()

      デフォルトコンストラクター
      変更履歴:

        6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor.

    - #### FileString

          public FileString(String filename)

      ファイル名と、エンコード名を指定して構築する コンストラクター
      パラメータ:
        `filename` - ファイル名
      変更履歴:

        6.4.5.1 (2016/04/28) 新規追加

    - #### FileString

          public FileString(String filename,
                            String encode)

      ファイル名と、エンコード名を指定して構築する コンストラクター
      パラメータ:
        `filename` - ファイル名
        `encode` - エンコード名
      変更履歴:

        6.4.5.1 (2016/04/28) 新規追加

  - ### メソッドの詳細

    - #### setFilename

          public void setFilename(String filename)

      ファイル名を設定します。 指定のファイルを読み取って、内部文字列に格納します。 なお、格納するタイミングは、#getValue() を最初に行ったときです。 ファイル名を再設定すると、内部のvalue は、クリアされます。
      パラメータ:
        `filename` - ファイル名

    - #### setEncode

          public void setEncode(String encode)

      ファイルのエンコードを設定します。 指定のファイルを読み取る場合のエンコードを指定します。 正確には、バイナリデータを読み取って、文字列に変換する場合に、 String( byte[],String ) コンストラクタの引数に使用します。 指定されていない場合は、String( byte[] ) コンストラクタで変換します。 エンコードを再設定すると、内部のvalue は、クリアされます。
      パラメータ:
        `encode` - エンコード名

    - #### getValue

          public String getValue()

      ファイルを読み取って、文字列を作成します。 データの読取が完全に出来なかったときには、途中までのデータを返します。 指定のエンコードが存在しない場合や、ファイルが存在しない場合は、 OgRuntimeException を throw します。
      戻り値:
        ファイルを読み取った文字列
      例外:
        `RuntimeException` - 指定のエンコードが存在しなかったとき。
      変更履歴:

        6.4.2.0 (2016/01/29) fukurou.util.StringUtil → fukurou.system.HybsConst に変更
        6.4.5.1 (2016/04/28) encode は初期化しているため、null はセットされません。

    - #### getValues

          public String[] getValues()

      改行コードで分割します。 処理は、#getValues( CR ) と同じになります。
      戻り値:
        ファイルを読み取った文字列を分割した配列
      変更履歴:

        6.4.5.1 (2016/04/28) StringTokenizerでの処理を、String#split(String) に変更

    - #### getValues

          public String[] getValues(String regex)

      指定された正規表現に一致する位置で分割します。 処理は、String#split( regex ) と同じになります。 例えば、";" を指定すれば、SQL を複数記述しておくことが可能になります。
      パラメータ:
        `regex` - 正規表現の区切り
      戻り値:
        ファイルを読み取った文字列を分割した配列
      変更履歴:

        6.4.5.1 (2016/04/28) StringTokenizerでの処理を、String#split(String) に変更

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