ts.util.file
クラス FileOperation

java.lang.Object
  上位を拡張 ts.util.file.FileOperation

public final class FileOperation
extends java.lang.Object

ファイル操作クラス。
ファイルの一覧、コピー、削除、移動を実行するためのメソッドを用意する。

バージョン:
$Revision: 1.2 $, $Date: 2007/02/15 15:28:04 $
作成者:
佐藤隆之.

コンストラクタの概要
protected FileOperation()
          デフォルトコンストラクタ。
 
メソッドの概要
static void copy(java.io.File src, java.io.File dst)
          第1引数のファイルを第2引数のファイルにコピーする。
static void copyRecursive(java.io.File src, java.io.File dst)
          第1引数のファイルを第2引数のファイルにコピーする。
static java.io.File createTempDirectory(java.lang.String prefix, java.lang.String suffix, java.io.File dir)
          指定されたディレクトリの下に空のディレクトリをユニークな名前で生成する。
static java.io.File createTempFile(java.lang.String prefix, java.lang.String suffix, java.io.File dir)
          指定されたディレクトリの下に空のファイルをユニークな名前で生成する。
static void delete(java.io.File file)
          指定されたファイルを削除する。
static void deleteRecursive(java.io.File file)
          指定されたファイルを削除する。
static java.util.List<java.io.File> list(java.io.File baseDir)
          指定されたディレクトリ直下のファイルの一覧を取得する。
static java.util.List<java.io.File> listRecursive(java.io.File baseDir)
          指定されたディレクトリ以下の全てのファイルの一覧を取得する。
static void move(java.io.File src, java.io.File dst)
          第1引数のファイルを第2引数のファイルに移動する。
static void moveRecursive(java.io.File src, java.io.File dst)
          第1引数のファイルを第2引数のファイルに移動する。
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

FileOperation

protected FileOperation()
デフォルトコンストラクタ。

メソッドの詳細

list

public static java.util.List<java.io.File> list(java.io.File baseDir)
                                         throws java.io.FileNotFoundException,
                                                java.io.IOException
指定されたディレクトリ直下のファイルの一覧を取得する。
指定されたディレクトリが空の場合は、空のリストを返す。 引数がディレクトリではない場合は、引数を格納したリストを返す。 処理中にエラーが発生した場合は例外をスローする。

パラメータ:
baseDir - ベースディレクトリ。
戻り値:
ベースディレクトリ直下にあるファイルを格納したリスト。
例外:
java.io.FileNotFoundException - 指定されたディレクトリ又はファイルが 見つからない場合。
java.io.IOException - 処理中に入出力エラーが発生した場合。
java.lang.SecurityException - セキュリティマネージャによりファイルへの読込 アクセスが許可されない場合。
java.lang.AssertionError - 引数がヌルの場合(デバッグモードのみ)。

listRecursive

public static java.util.List<java.io.File> listRecursive(java.io.File baseDir)
                                                  throws java.io.FileNotFoundException,
                                                         java.io.IOException
指定されたディレクトリ以下の全てのファイルの一覧を取得する。
指定されたディレクトリ下にディレクトリがあれば、その下に格納されている ファイルも一覧に含めて返す。 指定されたディレクトリが空の場合は、空の配列を返す。 引数がディレクトリでない場合は、引数を格納したリストを返す。 処理中にエラーが発生した場合は例外をスローする。

パラメータ:
baseDir - ベースディレクトリ。
戻り値:
ベースオブジェクト直下にあるファイルのFile オブジェクトのリスト。
例外:
java.io.FileNotFoundException - 指定されたディレクトリ又はファイルが 見つからない場合。
java.io.IOException - 処理中に入出力エラーが発生した場合。
java.lang.SecurityException - セキュリティマネージャによりファイルへの読込 アクセスが許可されない場合。
java.lang.AssertionError - 引数がヌルの場合(デバッグモードのみ)。

delete

public static void delete(java.io.File file)
                   throws java.io.FileNotFoundException,
                          DirectoryNotEmptyException,
                          java.io.IOException
指定されたファイルを削除する。
指定されたファイルがディレクトリの場合、そのディレクトリが空ならば 削除は成功する。

パラメータ:
file - 削除対象のファイル。
例外:
java.io.FileNotFoundException - 指定されたファイルが見つからない場合。
DirectoryNotEmptyException - 指定されたファイルが空のディレクトリで ない場合。
java.io.IOException - 処理中に入出力エラーが発生した場合。
java.lang.SecurityException - セキュリティマネージャによりファイルへの読込 アクセス又は削除アクセスが許可されない場合。
java.lang.AssertionError - 引数がヌルの場合(デバッグモードのみ)。

deleteRecursive

public static void deleteRecursive(java.io.File file)
                            throws java.io.FileNotFoundException,
                                   java.io.IOException
指定されたファイルを削除する。
指定されたファイルがディレクトリの場合、そのディレクトリ以下の全ての ファイルを削除する。

パラメータ:
file - 削除対象のファイル。
例外:
java.io.FileNotFoundException - 指定されたファイルが見つからない場合。
java.io.IOException - 処理中に入出力エラーが発生した場合。
java.lang.SecurityException - セキュリティマネージャによりファイルへの読込 アクセス又は削除アクセスが許可されない場合。
java.lang.AssertionError - 引数がヌルの場合(デバッグモードのみ)。

copy

public static void copy(java.io.File src,
                        java.io.File dst)
                 throws java.io.FileNotFoundException,
                        DirectoryNotEmptyException,
                        FileAlreadyExistsException,
                        java.io.IOException
第1引数のファイルを第2引数のファイルにコピーする。
第1引数のファイルが存在しない場合は例外をスローする。 第2引数のファイルが既に存在する場合は例外をスローする。 第1引数のファイルがディレクトリの場合、そのディレクトリが空でない場合は 例外をスローする。

パラメータ:
src - コピー元のファイル。
dst - コピー先のファイル。
例外:
java.io.FileNotFoundException - コピー元のファイルが存在しない場合。
DirectoryNotEmptyException - コピー元のディレクトリが空でなかった 場合。
FileAlreadyExistsException - コピー先のファイルが既に存在している 場合。
java.io.IOException - 処理中に入出力エラーが発生した場合。
java.lang.SecurityException - セキュリティマネージャによりファイルへの読込 アクセス、存在確認アクセス、ディレクトリ生成、ファイル書込が 許可されない場合。
java.lang.AssertionError - 引数がヌルの場合(デバッグモードのみ)。

copyRecursive

public static void copyRecursive(java.io.File src,
                                 java.io.File dst)
                          throws java.io.FileNotFoundException,
                                 FileAlreadyExistsException,
                                 java.io.IOException
第1引数のファイルを第2引数のファイルにコピーする。
第1引数のファイルが存在しない場合は例外をスローする。 第2引数のファイルが既に存在する場合は例外をスローする。 第1引数のファイルがディレクトリの場合、そのディレクトリ以下のファイルも 全てコピーする。

パラメータ:
src - コピー元のファイル。
dst - コピー先のファイル。
例外:
java.io.FileNotFoundException - コピー元のファイルが存在しなかった場合。
FileAlreadyExistsException - コピー先のファイルが既に存在している 場合。
java.io.IOException - 処理中に入出力エラーが発生した場合。
java.lang.SecurityException - セキュリティマネージャによりファイルへの読込 アクセス、存在確認アクセス、ディレクトリ生成、ファイル書込が 許可されない場合。
java.lang.AssertionError - 引数がヌルの場合(デバッグモードのみ)。

move

public static void move(java.io.File src,
                        java.io.File dst)
                 throws FileAlreadyExistsException,
                        DirectoryNotEmptyException,
                        java.io.IOException
第1引数のファイルを第2引数のファイルに移動する。
第1引数のファイルが存在しない場合は例外をスローする。 第2引数のファイルが既に存在する場合は例外をスローする。 第1引数のファイルがディレクトリの場合、そのディレクトリが空でない場合は 例外をスローする。

パラメータ:
src - 移動元のファイル。
dst - 移動先のファイル。
例外:
java.io.FileNotFoundException - 移動元のファイルが存在しない場合。
DirectoryNotEmptyException - 移動元のディレクトリが空でなかった場合。
FileAlreadyExistsExcdeption - 移動先のファイルが既に存在している 場合。
java.io.IOException - 処理中に入出力エラーが発生した場合。
java.lang.SecurityException - セキュリティマネージャによりファイルへの読込 アクセス、又はファイル書込が許可されない場合。
java.lang.AssertionError - 引数がヌルの場合(デバッグモードのみ)。
FileAlreadyExistsException

moveRecursive

public static void moveRecursive(java.io.File src,
                                 java.io.File dst)
                          throws FileAlreadyExistsException,
                                 DirectoryNotEmptyException,
                                 java.io.IOException
第1引数のファイルを第2引数のファイルに移動する。
第1引数のファイルが存在しない場合は例外をスローする。 第2引数のファイルが既に存在する場合は例外をスローする。 第1引数のファイルがディレクトリの場合、そのディレクトリ以下のファイルも 全て移動する。

パラメータ:
src - 移動元のファイル。
dst - 移動先のファイル。
例外:
java.io.FileNotFoundException - 移動元のファイルが存在しない場合。
FileAlreadyExistsExcdeption - 移動先のファイルが既に存在している 場合。
java.io.IOException - 処理中に入出力エラーが発生した場合。
java.lang.SecurityException - セキュリティマネージャによりファイルへの読込 アクセス、又はファイル書込が許可されない場合。
java.lang.AssertionError - 引数がヌルの場合(デバッグモードのみ)。
FileAlreadyExistsException
DirectoryNotEmptyException

createTempFile

public static java.io.File createTempFile(java.lang.String prefix,
                                          java.lang.String suffix,
                                          java.io.File dir)
                                   throws java.lang.IllegalArgumentException,
                                          java.io.IOException
指定されたディレクトリの下に空のファイルをユニークな名前で生成する。
ファイル名には、指定された接頭語及び接尾語を使用する。 接頭語には3文字以上が必要である。 接尾語には、ヌルを含む任意の文字列が指定可能であり、ヌルが指定された場合は ".tmp"が使用される。
ディレクトリにヌルが指定された場合は、 システム依存の一時ファイルディレクトリが使用される。
このメソッドは内部でcreateTempFile(String,String,File)メソッドを呼び出している。

パラメータ:
prefix - ファイル名に使用される接頭語。
suffix - ファイル名に使用される接尾語。
dir - ファイルが生成されるディレクトリ。
戻り値:
新規に生成されたファイルのFileオブジェクト。
例外:
java.lang.IllegalArgumentException - 接頭語ご3文字に満たない場合。
java.io.IOException - ファイルが生成できなかった場合。
java.lang.SecurityException - セキュリティマネージャによりファイルの生成が が許可されない場合。
java.lang.AssertionError - 引数がヌルの場合(デバッグモードのみ)。
関連項目:
File.createTempFile(String, String, File)

createTempDirectory

public static java.io.File createTempDirectory(java.lang.String prefix,
                                               java.lang.String suffix,
                                               java.io.File dir)
                                        throws java.lang.IllegalArgumentException,
                                               java.io.IOException
指定されたディレクトリの下に空のディレクトリをユニークな名前で生成する。
ファイル名には、指定された接頭語及び接尾語を使用する。 接頭語には3文字以上が必要である。 接尾語には、ヌルを含む任意の文字列が指定可能であり、ヌルが指定された場合は ".tmp"が使用される。
ディレクトリにヌルが指定された場合は、 システム依存の一時ファイルディレクトリが使用される。
このメソッドは内部でcreateTempFile(String,String,File)メソッドを呼び出して、 ユニークなディレクトリ名を決定している。

パラメータ:
prefix - ファイル名に使用される接頭語。
suffix - ファイル名に使用される接尾語。
dir - ファイルが生成されるディレクトリ。
戻り値:
新規に生成されたディレクトリのFileオブジェクト。
例外:
java.lang.IllegalArgumentException - 接頭語ご3文字に満たない場合。
java.io.IOException - ディレクトリが生成できなかった場合。
java.lang.SecurityException - セキュリティマネージャによりディレクトリの生成が が許可されない場合。
java.lang.AssertionError - 引数がヌルの場合(デバッグモードのみ)。
関連項目:
File.createTempFile(String, String, File)


Copyright (C) SATOH Takayuki All Rights Reserved.