概要 | パッケージ | クラス | 階層ツリー | 非推奨 API | 索引 | ヘルプ
openGion 5.1.6.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 boolean` | `changeCrLfcopy(File fromFile, File toFile)` ファイルのバイナリコピーを行います。
`static File` | `checkFile(String dir, String filename)` 指定のファイル名が、実際に存在しているかどうかをチェックします。
`static File` | `checkFile(String dir, String filename, int count)` 指定のファイル名が、実際に存在しているかどうかをチェックします。
`static boolean` | `copy(File fromFile, File toFile)` ファイルのバイナリコピーを行います。
`static boolean` | `copy(File fromFile, File toFile, boolean keepTimeStamp)` ファイルのバイナリコピーを行います。
`static boolean` | `copy(InputStream input, OutputStream output)` 入出力ストリーム間でデータの転送を行います。
`static boolean` | `copy(String fromFile, String toFile)` ファイルのバイナリコピーを行います。
`static boolean` | `copy(String fromFile, String toFile, boolean keepTimeStamp)` ファイルのバイナリコピーを行います。
`static boolean` | `copyDirectry(File fromDir, File toDir)` 再帰処理でディレクトリをコピーします。
`static boolean` | `copyDirectry(File fromDir, File toDir, boolean keepTimeStamp)` 再帰処理でディレクトリをコピーします。
`static boolean` | `copyDirectry(String fromDir, String toDir)` 再帰処理でディレクトリのコピーを行います。
`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 boolean copy(String fromFile,
                               String toFile)

  ファイルのバイナリコピーを行います。 copy( File,File,false ) を呼び出します。

  パラメータ:
    `fromFile` - String
    `toFile` - String
  戻り値:
    boolean true:正常 / false:異常
  関連項目:
    `copy( File,File,boolean )`
  変更履歴:

    5.1.6.0 (2010/05/01) 戻り値に、true/false 指定します。

### copy

    public static boolean copy(String fromFile,
                               String toFile,
                               boolean keepTimeStamp)

  ファイルのバイナリコピーを行います。 copy( File,File,boolean ) を呼び出します。 第３引数の、keepTimeStamp=true で、コピー元のファイルのタイムスタンプを、 コピー先にもセットします。

  パラメータ:
    `fromFile` - String
    `toFile` - String
    `keepTimeStamp` - boolean
  戻り値:
    boolean true:正常 / false:異常
  関連項目:
    `copy( File,File,boolean )`
  変更履歴:

    5.1.6.0 (2010/05/01) 戻り値に、true/false 指定します。

### copy

    public static boolean copy(File fromFile,
                               File toFile)

  ファイルのバイナリコピーを行います。 copy( File,File,false ) を呼び出します。

  パラメータ:
    `fromFile` - File
    `toFile` - File
  戻り値:
    boolean true:正常 / false:異常
  関連項目:
    `copy( File,File,boolean )`
  変更履歴:

    5.1.6.0 (2010/05/01) 戻り値に、true/false 指定します。

### copy

    public static boolean copy(File fromFile,
                               File toFile,
                               boolean keepTimeStamp)

  ファイルのバイナリコピーを行います。 第３引数の、keepTimeStamp=true で、コピー元のファイルのタイムスタンプを、 コピー先にもセットします。 toFile が、ディレクトリの場合は、fromFile のファイル名をそのままコピーします。 fromFile がディレクトリの場合は、エラーにします。 copyDirectry( File,Fileboolean )を使用してください。（自動処理はしていません）

  パラメータ:
    `fromFile` - File
    `toFile` - File
    `keepTimeStamp` - boolean
  関連項目:
    `copyDirectry( File,File,boolean )`
  変更履歴:

    5.1.6.0 (2010/05/01) 新規追加

### changeCrLfcopy

    public static boolean changeCrLfcopy(File fromFile,
                                         File toFile)

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

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

    5.1.6.0 (2010/05/01) 新規追加

### copy

    public static boolean copy(InputStream input,
                               OutputStream output)

  入出力ストリーム間でデータの転送を行います。 ここでは、すでに作成されたストリームに基づき、データの入出力を行います。 よって、先にフォルダ作成や、存在チェック、ファイルの削除などの必要な処理は 済まして置いてください。 また、このメソッド内で、ストリームのクロース処理は行っていません。

  パラメータ:
    `input` - InputStream 入力ストリーム
    `output` - OutputStream 出力ストリーム
  戻り値:
    boolean true:正常 / false:異常
  変更履歴:

    5.1.6.0 (2010/05/01) 新規追加

### copyDirectry

    public static boolean copyDirectry(String fromDir,
                                       String toDir)

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

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

    4.3.0.0 (2008/07/24) 追加
    5.1.6.0 (2010/05/01) 戻り値に、true/false 指定します。

### copyDirectry

    public static boolean copyDirectry(File fromDir,
                                       File toDir)

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

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

    4.3.0.0 (2008/07/24) 追加
    5.1.6.0 (2010/05/01) 内部処理を若干変更します。

### copyDirectry

    public static boolean copyDirectry(File fromDir,
                                       File toDir,
                                       boolean keepTimeStamp)

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

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

    4.3.0.0 (2008/07/24) 追加
    5.1.6.0 (2010/05/01) 内部処理を若干変更します。

### 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 は、file2_backup にコピーします。 file1 が、ディレクトリの場合は、ディレクトリごとコピーします。 encode1、encode2 を指定すると、エンコード変換しながらコピーになります。 この場合は、ファイル同士のコピーのみになります。

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

    4.0.0.0 (2007/11/28) メソッドの戻り値をチェックします。
    5.1.6.0 (2010/05/01) 引数の並び順、処理を変更します。

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

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