概要 | パッケージ | クラス | 階層ツリー | 非推奨 API | 索引 | ヘルプ
openGion 5.0.0.0
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド

## org.opengion.fukurou.util
クラス FileUtil

    java.lang.Object
      org.opengion.fukurou.util.FileUtil

    public final class FileUtil

extends Object

FileUtil.java は、共通的に使用される File関連メソッドを集約した、クラスです。 全変数は、public static final 宣言されており、全メソッドは、public static synchronized 宣言されています。

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

メソッドの概要
`static File` | `checkFile(String dir, String filename)` 指定のファイル名が、実際に存在しているかどうかをチェックします。
`static File` | `checkFile(String dir, String filename, int count)` 指定のファイル名が、実際に存在しているかどうかをチェックします。
`static void` | `copy(File fromFile, File toFile)` ファイルのコピーを行います。
`static void` | `copy(File fromFile, File toFile, boolean changeCrLf)` ファイルのコピーを行います。
`static void` | `copy(String fromFile, String toFile)` ファイルのコピーを行います。
`static void` | `copy(String fromFile, String toFile, boolean changeCrLf)` ファイルのコピーを行います。
`static boolean` | `copyDirectry(File fromDirectry, File toDirectry)` 再帰処理でディレクトリをコピーします。
`static void` | `copyDirectry(String fromDirectry, String toDirectry)` 再帰処理でディレクトリのコピーを行います。
`static boolean` | `deleteFiles(File file)` 指定されたファイル及びディレクトを削除します。
`static BufferedReader` | `getBufferedReader(File file, String encode)` Fileオブジェクトとエンコードより BufferedReaderオブジェクトを作成します。
`static void` | `getFileList(File dir, boolean sort, List<String> list)` 指定されたディレクトリを基点としたファイル名(パスを含む)の一覧を返します。
`static PrintWriter` | `getLogWriter(String file)` ファイル名より、PrintWriterオブジェクトを作成する簡易メソッドです。
`static PrintWriter` | `getNonFlushPrintWriter(Writer writer)` PrintWriter を継承した、JspWriterなどの Writer 用のクラスを定義します。
`static PrintWriter` | `getPrintWriter(File file, String encode)` Fileオブジェクトとエンコードより PrintWriterオブジェクトを作成します。
`static PrintWriter` | `getPrintWriter(File file, String encode, boolean append)` Fileオブジェクトとエンコードより PrintWriterオブジェクトを作成します。
`static void` | `main(String[] args)` ファイルをコピーします。

クラス java.lang.Object から継承されたメソッド
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

メソッドの詳細

### getPrintWriter

    public static PrintWriter getPrintWriter(File file,
                                             String encode)

  Fileオブジェクトとエンコードより PrintWriterオブジェクトを作成します。

  パラメータ:
    `file` - File 出力するファイルオブジェクト
    `encode` - String ファイルのエンコード
  戻り値:
    PrintWriterオブジェクト
  例外:
    `RuntimeException` - 何らかのエラーが発生した場合

### getPrintWriter

    public static PrintWriter getPrintWriter(File file,
                                             String encode,
                                             boolean append)

  Fileオブジェクトとエンコードより PrintWriterオブジェクトを作成します。

  パラメータ:
    `file` - File 出力するファイルオブジェクト
    `encode` - String ファイルのエンコード
    `append` - boolean ファイルを追加モード(true)にするかどうか
  戻り値:
    PrintWriterオブジェクト
  例外:
    `RuntimeException` - 何らかのエラーが発生した場合

### getLogWriter

    public static PrintWriter getLogWriter(String file)

  ファイル名より、PrintWriterオブジェクトを作成する簡易メソッドです。 これは、ファイル名は、フルパスで、追加モードで、UTF-8 エンコードの ログファイルを出力する場合に使用します。 また、ファイル名に、"System.out" と、"System.err" を指定できます。 その場合は、標準出力、または、標準エラー出力に出力されます。 "System.out" と、"System.err" を指定した場合は、NonClosePrintWriter オブジェクトが返されます。これは、close() 処理が呼ばれても、何もしない クラスです。また、常に内部キャッシュの同じオブジェクトが返されます。

  パラメータ:
    `file` - String 出力するファイル名
  例外:
    `RuntimeException` - 何らかのエラーが発生した場合
    `IllegalArgumentException` - ファイル名が null の場合

### getNonFlushPrintWriter

    public static PrintWriter getNonFlushPrintWriter(Writer writer)

  PrintWriter を継承した、JspWriterなどの Writer 用のクラスを定義します。 例えば、JspWriterなどの JSP/Servlet等のフレームワークで使用される Writer では、flush や close 処理は、フレームワーク内で行われます。 その場合、通常のファイルと同じ用に、flush や close をアプリケーション側で 行うと、内部処理的に不整合が発生したり、最悪の場合エラーになります。 このクラスは、NonFlushPrintWriter クラスのオブジェクトを返します。 これは、通常の、new PrintWriter( Writer ) で、求めるのと、ほとんど同様の 処理を行いますが、close() と flush() メソッドが呼ばれても、何もしません。

  パラメータ:
    `writer` - Writer 出力するWriteオブジェクト(NonFlushPrintWriterクラス)

### getBufferedReader

    public static BufferedReader getBufferedReader(File file,
                                                   String encode)

  Fileオブジェクトとエンコードより BufferedReaderオブジェクトを作成します。

  パラメータ:
    `file` - File 入力するファイルオブジェクト
    `encode` - String ファイルのエンコード
  戻り値:
    BufferedReaderオブジェクト
  例外:
    `RuntimeException` - 何らかのエラーが発生した場合

### checkFile

    public static File checkFile(String dir,
                                 String filename)

  指定のファイル名が、実際に存在しているかどうかをチェックします。 存在しない場合は、２秒毎に、３回確認します。 それでも存在しない場合は、エラーを返します。 return されるFileオブジェクトは、正規の形式(CanonicalFile)です。

  パラメータ:
    `dir` - String
    `filename` - String
  戻り値:
    File (なければ null/あれば、CanonicalFile)

### checkFile

    public static File checkFile(String dir,
                                 String filename,
                                 int count)

  指定のファイル名が、実際に存在しているかどうかをチェックします。 存在しない場合は、２秒毎に、指定の回数分確認します。 それでも存在しない場合は、エラーを返します。 return されるFileオブジェクトは、正規の形式(CanonicalFile)です。

  パラメータ:
    `dir` - String
    `filename` - String
    `count` - int
  戻り値:
    File (なければ null/あれば、CanonicalFile)

### copy

    public static void copy(String fromFile,
                            String toFile)

  ファイルのコピーを行います。 このファイルコピーは、バイナリコピーです。

  パラメータ:
    `fromFile` - String
    `toFile` - String
  変更履歴:

    4.2.3.0 (2008/05/26) changeCrLf 属性対応

### copy

    public static void copy(String fromFile,
                            String toFile,
                            boolean changeCrLf)

  ファイルのコピーを行います。 このファイルコピーは、バイナリコピーです。 changeCrLf = true の場合は、バイナリファイルの 改行コードを CR+LF に統一します。また、UTF-8 の BOM(0xef,0xbb,0xbf) があれば、 取り除きます。

  パラメータ:
    `fromFile` - String
    `toFile` - String
    `changeCrLf` - boolean
  変更履歴:

    4.2.3.0 (2008/05/26) changeCrLf 属性対応

### copy

    public static void copy(File fromFile,
                            File toFile)

  ファイルのコピーを行います。 このファイルコピーは、バイナリコピーです。

  パラメータ:
    `fromFile` - File
    `toFile` - File
  変更履歴:

    4.2.3.0 (2008/05/26) changeCrLf 属性対応

### copy

    public static void copy(File fromFile,
                            File toFile,
                            boolean changeCrLf)

  ファイルのコピーを行います。 このファイルコピーは、バイナリコピーです。 changeCrLf = true の場合は、バイナリファイルの 改行コードを CR+LF に統一します。また、UTF-8 の BOM(0xef,0xbb,0xbf) があれば、 取り除きます。

  パラメータ:
    `fromFile` - File
    `toFile` - File
    `changeCrLf` - boolean
  変更履歴:

    4.2.3.0 (2008/05/26) changeCrLf 属性対応

### copyDirectry

    public static void copyDirectry(String fromDirectry,
                                    String toDirectry)

  再帰処理でディレクトリのコピーを行います。

  パラメータ:
    `fromDirectry` -
    `toDirectry` -
  変更履歴:

    4.3.0.0 (2008/07/24) 追加

### copyDirectry

    public static boolean copyDirectry(File fromDirectry,
                                       File toDirectry)

  再帰処理でディレクトリをコピーします。

  パラメータ:
    `fromDirectry` -
    `toDirectry` -
  戻り値:
    boolean 指定されたコピー元ディレクトリがディレクトリでなかったり存在しないときはfalseを返す。
  例外:
    `IOException`
  変更履歴:

    4.3.0.0 (2008/07/24) 追加

### deleteFiles

    public static boolean deleteFiles(File file)

  指定されたファイル及びディレクトを削除します。 ディレクトリの場合はサブフォルダ及びファイルも削除します。 １つでもファイルの削除に失敗した場合、その時点で処理を中断しfalseを返します。

  パラメータ:
    `file` -
  戻り値:
    ファイルの削除に成功したか

### getFileList

    public static void getFileList(File dir,
                                   boolean sort,
                                   List<String> list)

  指定されたディレクトリを基点としたファイル名(パスを含む)の一覧を返します。

  パラメータ:
    `dir` - 基点となるディレクトリ
    `sort` - ファイル名でソートするか
    `list` - ファイル名一覧を格納するList
  変更履歴:

    4.3.6.6 (2009/05/15) 新規作成

### main

    public static void main(String[] args)
                     throws Throwable

  ファイルをコピーします。
  引数に を指定します。 file1 を読み込み、file2 にコピーします。 file2 がすでに存在した場合は、削除されます。 file1 と file2 が同じ場合は、動作しません。

  パラメータ:
    `args` - 引数配列
  例外:
    `Throwable`
  変更履歴:

    4.0.0.0 (2007/11/28) メソッドの戻り値をチェックします。

概要 | パッケージ | クラス | 階層ツリー | 非推奨 API | 索引 | ヘルプ
| openGion 5.0.0.0
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド

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