Package nablarch.core.util
Class FileUtil
java.lang.Object
nablarch.core.util.FileUtil
ファイルの取り扱いに関するユーティリティクラス。
-
Method Summary
Modifier and TypeMethodDescriptionstatic void
closeQuietly
(Closeable... closeables) リソースを解放する。static void
ファイルをコピーする。static boolean
deleteFile
(File file) ファイルを削除する。static String
extractSuffix
(String fileName) ファイル名から拡張子を抽出する。static InputStream
getClasspathResource
(String path) クラスパス上のリソースを取得する。static URL
クラスパス上のURLを取得する。static InputStream
getResource
(String url) リソースを取得する。static URL
getResourceURL
(String url) URLを取得する。static File[]
ディレクトリ配下のファイルおよびディレクトリを検索し、名前で昇順ソートした結果の配列を返す。static void
ファイルを移動する。
-
Method Details
-
closeQuietly
リソースを解放する。 例外が発生した場合は何もせず、次のリソース解放を行う。- Parameters:
closeables
- リソース解放を行うクラス
-
getResource
リソースを取得する。 ファイルパスまたはクラスパス上のリソースを取得する。
引数に指定するURLのフォーマットは下記の通り。<スキーム名>:<リソースのパス>
URLの指定例を下記に示す。//ファイルパスの場合 FileUtil.getResource("file:/var/log/log.properties"); //クラスパスの場合 FileUtil.getResource("classpath:nablarch/core/log/log.properties");
- Parameters:
url
- URL- Returns:
- リソースのストリーム
- Throws:
IllegalArgumentException
- リソースを取得できなかった場合FileNotFoundException
- リソースファイルが見つからなかった場合
-
getResourceURL
URLを取得する。 ファイルパスまたはクラスパス上のURLを取得する。
引数に指定するURLのフォーマットは下記の通り。<スキーム名>:<リソースのパス>
URLの指定例を下記に示す。//ファイルパスの場合 FileUtil.getResourceURL("file:/var/log/log.properties"); //クラスパスの場合 FileUtil.getResourceURL("classpath:nablarch/core/log/log.properties");
- Parameters:
url
- URL文字列- Returns:
- リソースのURL
- Throws:
IllegalArgumentException
- URLがnull
または不正だった場合
-
getClasspathResource
クラスパス上のリソースを取得する。 以下に例を示す。FileUtil.getClasspathResource("nablarch/core/log/log.properties");
- Parameters:
path
- クラスパス- Returns:
- リソースのストリーム
- Throws:
IllegalArgumentException
- クラスパス及びクラスパスから取得するURLがnull
または、リソースが見つからない場合
-
getClasspathResourceURL
クラスパス上のURLを取得する。 以下に例を示す。FileUtil.getClasspathResource("nablarch/core/log/log.properties");
- Parameters:
path
- リソースのパス- Returns:
- リソースのURL
- Throws:
IllegalArgumentException
- クラスパスがnull
だった場合
-
listFiles
ディレクトリ配下のファイルおよびディレクトリを検索し、名前で昇順ソートした結果の配列を返す。 ファイル名にはワイルドカード("*")を指定できる。
ディレクトリは、絶対パスまたは相対パスで指定する。
ディレクトリがnull
だった場合、引数のファイル名を元に構築したFileオブジェクトを持つ要素が1つの配列が返される。- Parameters:
dir
- ディレクトリ(null指定の場合、指定なし)name
- ファイル名- Returns:
- 検索結果の配列
- Throws:
NullPointerException
- ファイル名がnull
だった場合
-
deleteFile
ファイルを削除する。- Parameters:
file
- 削除するファイル- Returns:
- ファイルが削除に成功した場合は
true
、失敗した場合はfalse
を返却する。ファイルが存在しない場合はtrue
を返却する。 - Throws:
IllegalArgumentException
- 削除するファイルがnull
だった場合
-
extractSuffix
ファイル名から拡張子を抽出する。 以下の仕様に当てはまる場合は、空文字列を返す。- ファイル名の先頭がドット
- ファイル名の末尾がドット
- 拡張子にドットがない
- 拡張子が英数字以外
- Parameters:
fileName
- ファイル名- Returns:
- 拡張子
- Throws:
IllegalArgumentException
- ファイル名がnull
だった場合
-
move
ファイルを移動する。 移動先に同名のファイルが存在していた場合、上書きする。- Parameters:
src
- 移動元ファイルdest
- 移動先ファイル- Throws:
IllegalArgumentException
- 移動元ファイルまたは移動先ファイルがnull
の場合RuntimeException
- コピー元のファイルが削除できなかった場合
-
copy
ファイルをコピーする。 コピー先に同名のファイルが存在していた場合、上書きする。- Parameters:
src
- コピー元ファイルdest
- コピー先ファイル- Throws:
IllegalArgumentException
- コピー元ファイルまたはコピー先ファイルがnull
の場合RuntimeException
- コピーに失敗した場合
-