FileUtil (Excel Write/Read Framework 0.5.26 API)

java.lang.Object
- org.ttzero.excel.util.FileUtil

```
public class FileUtil
extends Object
```
File operation util. Ignore the IOException and output error logs

作者:

guanquan.wang on 2017-9-10

方法概要

所有方法静态方法具体方法
限定符和类型	方法和说明
`static void`	`close(Closeable closeable)` Close the `Closeable` stream
`static void`	`copyFolder(String srcPath, String descPath, boolean moveSubFolder)` Copy a directory to a new path
`static void`	`cp_R(Path srcPath, Path descPath)` Copy a directory to a new path
`static void`	`cp_R(Path srcPath, Path descPath, boolean moveSubFolder)` Copy a directory to a new path
`static void`	`cp_R(String srcPath, String descPath)` Copy a directory to a new path
`static void`	`cp_R(String srcPath, String descPath, boolean moveSubFolder)` Copy a directory to a new path
`static void`	`cp(File srcFile, File descFile)` Copy a single file
`static long`	`cp(InputStream source, OutputStream sink)` Reads all bytes from an input stream and writes them to an output stream.
`static void`	`cp(InputStream is, Path descFile)` Copy a single file
`static void`	`cp(Path srcPath, File descFile)` Copy a single file
`static boolean`	`exists(Path path)` Tests whether a file exists.
`static Path`	`getTargetPath(Path targetPath, String fileName, String suffix)` 获取目标路径，如果已存在相同文件名则会在文件名后追回`（n）`以区分， `n`从1开始如果已存在`（n）`则新文件名为`（n + 1）` 例：目标文件夹已存在`a.xlsx`和`b（5）.xlsx`两个文件，添加一个名为`a.xlsx`的文件因为`a.xlsx`已存在所以新文件另存为`a（1）.xlsx`，添加一个名为`b.xlsx`的文件则新文件另存为`b（6）.xlsx`
`static boolean`	`isWindows()` Test current OS system is windows family
`static Path`	`mkdir(Path destPath)` Create a directory
`static Path`	`mktmp(String prefix)` Create a temp directory
`static void`	`rm_rf(File root, boolean rmSelf)` Remove file and sub-files if it is a directory
`static void`	`rm_rf(Path root)` Remove file and sub-files if it a directory
`static void`	`rm(File file)` Delete if exists file
`static void`	`rm(Path path)` Delete if exists file
`static void`	`writeToDisk(org.dom4j.Document doc, Path path)` Write the `Document` to a specify `Path` with xml format
`static void`	`writeToDiskNoFormat(org.dom4j.Document doc, Path path)` Write the `Document` to a specify `Path`

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 方法详细资料
  - close
```
public static void close(Closeable closeable)
```
    Close the Closeable stream
    
    参数:
    
    closeable - a closeable stream
  - rm
```
public static void rm(Path path)
```
    Delete if exists file
    
    参数:
    
    path - the file path to be delete
  - rm
```
public static void rm(File file)
```
    Delete if exists file
    
    参数:
    
    file - the file to be delete
  - rm_rf
```
public static void rm_rf(Path root)
```
    Remove file and sub-files if it a directory
    
    参数:
    
    root - the root path
  - rm_rf
```
public static void rm_rf(File root,
                         boolean rmSelf)
```
    Remove file and sub-files if it is a directory
    
    参数:
    
    root - the root path
    
    rmSelf - remove self if true
  - cp
```
public static void cp(Path srcPath,
                      File descFile)
```
    Copy a single file
    
    参数:
    
    srcPath - the source path
    
    descFile - the destination file
  - cp
```
public static void cp(File srcFile,
                      File descFile)
```
    Copy a single file
    
    参数:
    
    srcFile - the source file
    
    descFile - the destination file
  - cp
```
public static void cp(InputStream is,
                      Path descFile)
```
    Copy a single file
    
    参数:
    
    is - the source input stream
    
    descFile - the destination path
  - cp
```
public static long cp(InputStream source,
                      OutputStream sink)
               throws IOException
```
    Reads all bytes from an input stream and writes them to an output stream.
    
    参数:
    
    source - source inputStream
    
    sink - dist outputStream
    
    返回:
    
    number of copied bytes
    
    抛出:
    
    IOException - if I/O error occur.
  - cp_R
```
public static void cp_R(String srcPath,
                        String descPath,
                        boolean moveSubFolder)
```
    Copy a directory to a new path
    
    参数:
    
    srcPath - the source path string
    
    descPath - the destination path string
    
    moveSubFolder - need move sub-folders
  - cp_R
```
public static void cp_R(Path srcPath,
                        Path descPath,
                        boolean moveSubFolder)
```
    Copy a directory to a new path
    
    参数:
    
    srcPath - the source path
    
    descPath - the destination path
    
    moveSubFolder - need move sub-folders
  - cp_R
```
public static void cp_R(String srcPath,
                        String descPath)
```
    Copy a directory to a new path
    
    参数:
    
    srcPath - the source path string
    
    descPath - the destination path string
  - cp_R
```
public static void cp_R(Path srcPath,
                        Path descPath)
```
    Copy a directory to a new path
    
    参数:
    
    srcPath - the source path
    
    descPath - the destination path
  - copyFolder
```
public static void copyFolder(String srcPath,
                              String descPath,
                              boolean moveSubFolder)
```
    Copy a directory to a new path
    
    参数:
    
    srcPath - the source path string
    
    descPath - the destination path string
    
    moveSubFolder - need move sub-folders
  - mkdir
```
public static Path mkdir(Path destPath)
                  throws IOException
```
    Create a directory
    
    参数:
    
    destPath - the destination directory path
    
    返回:
    
    the temp directory path
    
    抛出:
    
    IOException - if I/O error occur
  - mktmp
```
public static Path mktmp(String prefix)
                  throws IOException
```
    Create a temp directory
    
    参数:
    
    prefix - the directory prefix
    
    返回:
    
    the temp directory path
    
    抛出:
    
    IOException - if I/O error occur
  - isWindows
```
public static boolean isWindows()
```
    Test current OS system is windows family
    
    返回:
    
    true if OS is windows family
  - writeToDisk
```
public static void writeToDisk(org.dom4j.Document doc,
                               Path path)
                        throws IOException
```
    Write the Document to a specify Path with xml format
    
    参数:
    
    doc - the Document
    
    path - the output path
    
    抛出:
    
    IOException - if I/O error occur
  - writeToDiskNoFormat
```
public static void writeToDiskNoFormat(org.dom4j.Document doc,
                                       Path path)
                                throws IOException
```
    Write the Document to a specify Path
    
    参数:
    
    doc - the Document
    
    path - the output path
    
    抛出:
    
    IOException - if I/O error occur
  - exists
```
public static boolean exists(Path path)
```
    Tests whether a file exists.
    
    参数:
    
    path - the path to the file to test
    
    返回:
    
    false if not exits or no read permission
  - getTargetPath
```
public static Path getTargetPath(Path targetPath,
                                 String fileName,
                                 String suffix)
```
    获取目标路径，如果已存在相同文件名则会在文件名后追回（n）以区分， n从1开始如果已存在（n）则新文件名为（n + 1）
    例：目标文件夹已存在a.xlsx和b（5）.xlsx两个文件，添加一个名为a.xlsx的文件因为a.xlsx已存在所以新文件另存为a（1）.xlsx，添加一个名为b.xlsx的文件则新文件另存为b（6）.xlsx
    
    参数:
    
    targetPath - 目标路径，可以是文件或文件夹
    
    fileName - 不带后缀的文件名
    
    suffix - 文件后缀，如.xlsx
    
    返回:
    
    实际的目标路径

类 FileUtil

方法概要

从类继承的方法 java.lang.Object

方法详细资料

close

rm

rm

rm_rf

rm_rf

cp

cp

cp

cp

cp_R

cp_R

cp_R

cp_R

copyFolder

mkdir

mktmp

isWindows

writeToDisk

writeToDiskNoFormat

exists

getTargetPath