nablarch.core.util

クラス FileUtil

java.lang.Object

nablarch.core.util.FileUtil

@Published(tag="architect")
public final class FileUtil
extends java.lang.Object

ファイルの取り扱いに関するユーティリティクラス。

メソッドのサマリー

修飾子とタイプ	メソッドと説明
static void	closeQuietly(java.io.Closeable... closeables) リソースを解放する。
static void	copy(java.io.File src, java.io.File dest) ファイルをコピーする。
static boolean	deleteFile(java.io.File file) ファイルを削除する。
static java.lang.String	extractSuffix(java.lang.String fileName) ファイル名から拡張子を抽出する。
static java.io.InputStream	getClasspathResource(java.lang.String path) クラスパス上のリソースを取得する。
static java.net.URL	getClasspathResourceURL(java.lang.String path) クラスパス上のURLを取得する。
static java.io.InputStream	getResource(java.lang.String url) リソースを取得する。
static java.net.URL	getResourceURL(java.lang.String url) URLを取得する。
static java.io.File[]	listFiles(java.lang.String dir, java.lang.String name) ディレクトリ配下のファイルおよびディレクトリを検索し、名前で昇順ソートした結果の配列を返す。
static void	move(java.io.File src, java.io.File dest) ファイルを移動する。

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

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

メソッドの詳細

closeQuietly

public static void closeQuietly(java.io.Closeable... closeables)

リソースを解放する。

例外が発生した場合は何もせず、次のリソース解放を行う。

パラメータ:

closeables - リソース解放を行うクラス

getResource

public static java.io.InputStream getResource(java.lang.String url)
                                       throws java.lang.IllegalArgumentException

リソースを取得する。

ファイルパスまたはクラスパス上のリソースを取得する。
引数に指定するURLのフォーマットは下記の通り。

     <スキーム名>:<リソースのパス>
 

URLの指定例を下記に示す。

 //ファイルパスの場合
 FileUtil.getResource("file:/var/log/log.properties");

 //クラスパスの場合
 FileUtil.getResource("classpath:nablarch/core/log/log.properties");
 

パラメータ:

url - URL

戻り値:

リソースのストリーム

例外:

java.lang.IllegalArgumentException - リソースを取得できなかった場合

java.io.FileNotFoundException - リソースファイルが見つからなかった場合

getResourceURL

public static java.net.URL getResourceURL(java.lang.String url)

URLを取得する。

ファイルパスまたはクラスパス上のURLを取得する。
引数に指定するURLのフォーマットは下記の通り。

      <スキーム名>:<リソースのパス>
 

URLの指定例を下記に示す。

 //ファイルパスの場合
 FileUtil.getResourceURL("file:/var/log/log.properties");

 //クラスパスの場合
 FileUtil.getResourceURL("classpath:nablarch/core/log/log.properties");
 

パラメータ:

url - URL文字列

戻り値:

リソースのURL

例外:

java.lang.IllegalArgumentException - URLがnullまたは不正だった場合

getClasspathResource

public static java.io.InputStream getClasspathResource(java.lang.String path)
                                                throws java.lang.IllegalArgumentException

クラスパス上のリソースを取得する。

以下に例を示す。

 FileUtil.getClasspathResource("nablarch/core/log/log.properties");
 

パラメータ:

path - クラスパス

戻り値:

リソースのストリーム

例外:

java.lang.IllegalArgumentException - クラスパス及びクラスパスから取得するURLがnullまたは、リソースが見つからない場合

getClasspathResourceURL

public static java.net.URL getClasspathResourceURL(java.lang.String path)

クラスパス上のURLを取得する。

以下に例を示す。

 FileUtil.getClasspathResource("nablarch/core/log/log.properties");
 

パラメータ:

path - リソースのパス

戻り値:

リソースのURL

例外:

java.lang.IllegalArgumentException - クラスパスがnullだった場合

listFiles

public static java.io.File[] listFiles(java.lang.String dir,
                                       java.lang.String name)

ディレクトリ配下のファイルおよびディレクトリを検索し、名前で昇順ソートした結果の配列を返す。

ファイル名にはワイルドカード("*")を指定できる。
ディレクトリは、絶対パスまたは相対パスで指定する。
ディレクトリがnullだった場合、引数のファイル名を元に構築したFileオブジェクトを持つ要素が１つの配列が返される。

パラメータ:

dir - ディレクトリ(null指定の場合、指定なし)

name - ファイル名

戻り値:

検索結果の配列

例外:

java.lang.NullPointerException - ファイル名がnullだった場合

deleteFile

public static boolean deleteFile(java.io.File file)

ファイルを削除する。

パラメータ:

file - 削除するファイル

戻り値:

ファイルが削除に成功した場合はtrue、失敗した場合はfalseを返却する。ファイルが存在しない場合はtrueを返却する。

例外:

java.lang.IllegalArgumentException - 削除するファイルがnullだった場合

extractSuffix

public static java.lang.String extractSuffix(java.lang.String fileName)

ファイル名から拡張子を抽出する。

以下の仕様に当てはまる場合は、空文字列を返す。

1. ファイル名の先頭がドット
2. ファイル名の末尾がドット
3. 拡張子にドットがない
4. 拡張子が英数字以外

パラメータ:

fileName - ファイル名

戻り値:

拡張子

例外:

java.lang.IllegalArgumentException - ファイル名がnullだった場合

move

public static void move(java.io.File src,
                        java.io.File dest)

ファイルを移動する。

移動先に同名のファイルが存在していた場合、上書きする。

パラメータ:

src - 移動元ファイル

dest - 移動先ファイル

例外:

java.lang.IllegalArgumentException - 移動元ファイルまたは移動先ファイルがnullの場合

java.lang.RuntimeException - コピー元のファイルが削除できなかった場合

copy

public static void copy(java.io.File src,
                        java.io.File dest)

ファイルをコピーする。

コピー先に同名のファイルが存在していた場合、上書きする。

パラメータ:

src - コピー元ファイル

dest - コピー先ファイル

例外:

java.lang.IllegalArgumentException - コピー元ファイルまたはコピー先ファイルがnullの場合

java.lang.RuntimeException - コピーに失敗した場合