cn.jdevelops.file

类 FileUtil

java.lang.Object

cn.jdevelops.file.FileUtil

public class FileUtil
extends Object

文件工具类

作者

looly

构造器概要

构造器

构造器和说明
FileUtil()

方法概要

限定符和类型	方法和说明
static <T> File	appendLines(Collection<T> list, File file, Charset charset) 将列表写入文件，追加模式，策略为： 当文件为空，从开头追加，尾部不加空行 当有内容，换行追加，尾部不加空行 当有内容，并末尾有空行，依旧换行追加
static BufferedInputStream	getInputStream(File file) 获得输入流
static File	getParent(File file, int level) 获取指定层级的父路径 getParent(file("d:/aaa/bbb/cc/ddd", 0)) -》 "d:/aaa/bbb/cc/ddd" getParent(file("d:/aaa/bbb/cc/ddd", 2)) -》 "d:/aaa/bbb" getParent(file("d:/aaa/bbb/cc/ddd", 4)) -》 "d:/" getParent(file("d:/aaa/bbb/cc/ddd", 5)) -》 null
static BufferedReader	getReader(File file, Charset charset) 获得一个文件读取器
static BufferedReader	getReader(InputStream in, Charset charset) 获得一个Reader
static boolean	isEmpty(File file) 文件是否为空 目录：里面没有文件时为空 文件：文件大小为0时为空
static <T> boolean	isEmpty(T[] array)
static boolean	isNotEmpty(File file) 目录是否为空
static File	mkdir(File dir) 创建文件夹，会递归自动创建其不存在的父文件夹，如果存在直接返回此文件夹 此方法不对File对象类型做判断，如果File不存在，无法判断其类型
static boolean	mkdirsSafely(File dir, int tryCount, long sleepMillis) 安全地级联创建目录 (确保并发环境下能创建成功) 并发环境下，假设 test 目录不存在，如果线程A mkdirs "test/A" 目录，线程B mkdirs "test/B"目录， 其中一个线程可能会失败，进而导致以下代码抛出 FileNotFoundException 异常 file.getParentFile().mkdirs(); // 父目录正在被另一个线程创建中，返回 false file.createNewFile(); // 抛出 IO 异常，因为该线程无法感知到父目录已被创建
static File	mkParentDirs(File file) 创建所给文件或目录的父目录
static List<String>	readLines(File file, Charset charset) 从文件中读取每一行数据
static <T extends Collection<String>> T	readLines(File file, Charset charset, T collection) 从文件中读取每一行数据
static boolean	sleep(long millis) 挂起当前线程
static BufferedInputStream	toBuffered(InputStream in) 转换为{BufferedInputStream}
static FileInputStream	toStream(File file) 文件转为{ FileInputStream}
static File	touch(File file) 创建文件及其父目录，如果这个文件存在，直接返回这个文件 此方法不对File对象类型做判断，如果File不存在，无法判断其类型
static <T> File	writeLines(Collection<T> list, File file, Charset charset) 将列表写入文件，覆盖模式
static <T> File	writeLines(Collection<T> list, File file, Charset charset, boolean isAppend) 将列表写入文件

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

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

构造器详细资料

FileUtil

public FileUtil()

方法详细资料

readLines

public static List<String> readLines(File file,
                                     Charset charset)
                              throws IOException

从文件中读取每一行数据

抛出:

IOException - IO异常

return

文件中的每行内容的集合List

参数

文件, 字符集

writeLines

public static <T> File writeLines(Collection<T> list,
                                  File file,
                                  Charset charset)
                           throws IOException

将列表写入文件，覆盖模式

抛出:

IOException - IO异常

从以下版本开始:

4.2.0

return

目标文件

参数

集合元素类型, 列表, 文件, 字符集

appendLines

public static <T> File appendLines(Collection<T> list,
                                   File file,
                                   Charset charset)
                            throws IOException

将列表写入文件，追加模式，策略为：

• 当文件为空，从开头追加，尾部不加空行
• 当有内容，换行追加，尾部不加空行
• 当有内容，并末尾有空行，依旧换行追加

抛出:

IOException - IO异常

从以下版本开始:

3.1.2

return

目标文件

参数

集合元素类型, 列表, 文件, 字符集

readLines

public static <T extends Collection<String>> T readLines(File file,
                                                         Charset charset,
                                                         T collection)
                                                  throws IOException

从文件中读取每一行数据

抛出:

IOException - IO异常

return

文件中的每行内容的集合

参数

集合类型, 文件路径, 字符集, 集合

writeLines

public static <T> File writeLines(Collection<T> list,
                                  File file,
                                  Charset charset,
                                  boolean isAppend)
                           throws IOException

将列表写入文件

抛出:

IOException - IO异常

return

目标文件

参数

集合元素类型, 列表, 文件, 字符集, 是否追加

isNotEmpty

public static boolean isNotEmpty(File file)

目录是否为空

return

是否为空，当提供非目录时，返回false

参数

目录

isEmpty

public static boolean isEmpty(File file)

文件是否为空
目录：里面没有文件时为空 文件：文件大小为0时为空

return

是否为空，当提供非目录时，返回false

参数

文件

isEmpty

public static <T> boolean isEmpty(T[] array)

touch

public static File touch(File file)
                  throws IOException

创建文件及其父目录，如果这个文件存在，直接返回这个文件
此方法不对File对象类型做判断，如果File不存在，无法判断其类型

抛出:

IOException - IO异常

return

文件，若路径为null，返回null

参数

文件对象

mkParentDirs

public static File mkParentDirs(File file)
                         throws IOException

创建所给文件或目录的父目录

抛出:

IOException

return

父目录

参数

文件或目录

getParent

public static File getParent(File file,
                             int level)
                      throws IOException

获取指定层级的父路径

 getParent(file("d:/aaa/bbb/cc/ddd", 0)) -》 "d:/aaa/bbb/cc/ddd"
 getParent(file("d:/aaa/bbb/cc/ddd", 2)) -》 "d:/aaa/bbb"
 getParent(file("d:/aaa/bbb/cc/ddd", 4)) -》 "d:/"
 getParent(file("d:/aaa/bbb/cc/ddd", 5)) -》 null
 

抛出:

IOException

从以下版本开始:

4.1.2

return

路径File，如果不存在返回null

参数

目录或文件, 层级

mkdir

public static File mkdir(File dir)

创建文件夹，会递归自动创建其不存在的父文件夹，如果存在直接返回此文件夹
此方法不对File对象类型做判断，如果File不存在，无法判断其类型

return

创建的目录

参数

目录

mkdirsSafely

public static boolean mkdirsSafely(File dir,
                                   int tryCount,
                                   long sleepMillis)

安全地级联创建目录 (确保并发环境下能创建成功)

     并发环境下，假设 test 目录不存在，如果线程A mkdirs "test/A" 目录，线程B mkdirs "test/B"目录，
     其中一个线程可能会失败，进而导致以下代码抛出 FileNotFoundException 异常

     file.getParentFile().mkdirs(); // 父目录正在被另一个线程创建中，返回 false
     file.createNewFile(); // 抛出 IO 异常，因为该线程无法感知到父目录已被创建
 

从以下版本开始:

5.7.21

return

true表示创建成功，false表示创建失败

参数

待创建的目录, 最大尝试次数, 线程等待的毫秒数

作者

z8g

sleep

public static boolean sleep(long millis)

挂起当前线程

从以下版本开始:

5.3.2

return

被中断返回false，否则true

参数

挂起的毫秒数

getReader

public static BufferedReader getReader(File file,
                                       Charset charset)
                                throws IOException

获得一个文件读取器

抛出:

IOException - IO异常

return

BufferedReader对象

参数

文件, 字符集

getInputStream

public static BufferedInputStream getInputStream(File file)
                                          throws IOException

获得输入流

抛出:

IOException - 文件未找到

return

输入流

参数

文件

toBuffered

public static BufferedInputStream toBuffered(InputStream in)

转换为{BufferedInputStream}

从以下版本开始:

4.0.10

return

{ BufferedInputStream}

参数

{ InputStream}

toStream

public static FileInputStream toStream(File file)
                                throws IOException

文件转为{ FileInputStream}

抛出:

IOException

return

{FileInputStream}

参数

文件

getReader

public static BufferedReader getReader(InputStream in,
                                       Charset charset)

获得一个Reader

return

BufferedReader对象

参数

输入流, 字符集