FileUtil (Nablarch-API)

java.lang.Object
- nablarch.core.util.FileUtil

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

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

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`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)` リソースを取得する。ファイルパスまたはクラスパス上のリソースを取得する。引数に指定するURLのフォーマットは下記の通り。
`static java.net.URL`	`getResourceURL(java.lang.String url)` URLを取得する。ファイルパスまたはクラスパス上のURLを取得する。引数に指定するURLのフォーマットは下記の通り。
`static java.io.File[]`	`listFiles(java.lang.String dir, java.lang.String name)` ディレクトリ配下のファイルおよびディレクトリを検索し、名前で昇順ソートした結果の配列を返す。ファイル名にはワイルドカード("*")を指定できる。ディレクトリは、絶対パスまたは相対パスで指定する。ディレクトリが`null`だった場合、引数のファイル名を元に構築したFileオブジェクトを持つ要素が１つの配列が返される。
`static void`	`move(java.io.File src, java.io.File dest)` ファイルを移動する。移動先に同名のファイルが存在していた場合、上書きする。

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

Class FileUtil

Method Summary

Methods inherited from class java.lang.Object

Method Detail

closeQuietly

getResource

getResourceURL

getClasspathResource

getClasspathResourceURL

listFiles

deleteFile

extractSuffix

move

copy