PathUtil (hutool-core 5.4.4 API)

java.lang.Object
- cn.hutool.core.io.file.PathUtil

直接已知子类:

FileUtil
```
public class PathUtil
extends Object
```
NIO中Path对象操作封装

从以下版本开始:

5.4.1

作者:

looly

构造器概要

构造器
构造器和说明

PathUtil()

构造器
构造器和说明
`PathUtil()`

方法概要

所有方法静态方法具体方法
限定符和类型	方法和说明
`static Path`	`copyFile(Path src, Path dest, CopyOption... options)` 通过JDK7+的 `Files.copy(Path, Path, CopyOption...)`
`static Path`	`copyFile(Path src, Path dest, StandardCopyOption... options)` 通过JDK7+的 `Files.copy(Path, Path, CopyOption...)`
`static boolean`	`del(Path path)` 删除文件或者文件夹注意：删除文件夹时不会判断文件夹是否为空，如果不空则递归删除子文件或文件夹某个文件删除失败会终止删除操作
`static boolean`	`equals(Path file1, Path file2)` 检查两个文件是否是同一个文件所谓文件相同，是指Path对象是否指向同一个文件或文件夹
`static BasicFileAttributes`	`getAttributes(Path path, boolean isFollowLinks)` 获取文件属性
`static BufferedInputStream`	`getInputStream(Path path)` 获得输入流
`static Path`	`getLastPathEle(Path path)` 获取指定位置的最后一个子路径部分
`static BufferedOutputStream`	`getOutputStream(Path path)` 获得输出流
`static Path`	`getPathEle(Path path, int index)` 获取指定位置的子路径部分，支持负数，例如index为-1表示从后数第一个节点位置
`static BufferedReader`	`getReader(Path path, Charset charset)` 获得一个文件读取器
`static BufferedReader`	`getUtf8Reader(Path path)` 获得一个文件读取器
`static boolean`	`isDirectory(Path path, boolean isFollowLinks)` 判断是否为目录，如果file为null，则返回false
`static boolean`	`isDirEmpty(Path dirPath)` 目录是否为空
`static boolean`	`isFile(Path path, boolean isFollowLinks)` 判断是否为文件，如果file为null，则返回false
`static boolean`	`isSymlink(Path path)` 判断是否为符号链接文件
`static List<File>`	`loopFiles(Path path, int maxDepth, FileFilter fileFilter)` 递归遍历目录以及子目录中的所有文件如果提供path为文件，直接返回过滤结果
`static Path`	`rename(Path path, String newName, boolean isOverride)` 修改文件或目录的文件名，不变更路径，只是简单修改文件名 FileUtil.rename(file, "aaa.jpg", false) xx/xx.png =》xx/aaa.jpg
`static Path`	`subPath(Path path, int fromIndex, int toIndex)` 获取指定位置的子路径部分，支持负数，例如起始为-1表示从后数第一个节点位置
`static void`	`walkFiles(Path start, int maxDepth, FileVisitor<? super Path> visitor)` 遍历指定path下的文件并做处理

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

- 构造器详细资料
  - PathUtil
```
public PathUtil()
```
- 方法详细资料
  - isDirEmpty
```
public static boolean isDirEmpty(Path dirPath)
```
    目录是否为空
    
    参数:
    
    dirPath - 目录
    
    返回:
    
    是否为空
    
    抛出:
    
    IORuntimeException - IOException
  - loopFiles
```
public static List<File> loopFiles(Path path,
                                   int maxDepth,
                                   FileFilter fileFilter)
```
    递归遍历目录以及子目录中的所有文件
    如果提供path为文件，直接返回过滤结果
    
    参数:
    
    path - 当前遍历文件或目录
    
    maxDepth - 遍历最大深度，-1表示遍历到没有目录为止
    
    fileFilter - 文件过滤规则对象，选择要保留的文件，只对文件有效，不过滤目录，null表示接收全部文件
    
    返回:
    
    文件列表
    
    从以下版本开始:
    
    5.4.1
  - walkFiles
```
public static void walkFiles(Path start,
                             int maxDepth,
                             FileVisitor<? super Path> visitor)
```
    遍历指定path下的文件并做处理
    
    参数:
    
    start - 起始路径，必须为目录
    
    maxDepth - 最大遍历深度，-1表示不限制深度
    
    visitor - FileVisitor 接口，用于自定义在访问文件时，访问目录前后等节点做的操作
    
    从以下版本开始:
    
    4.6.3
    
    另请参阅:
    
    Files.walkFileTree(Path, java.util.Set, int, FileVisitor)
  - del
```
public static boolean del(Path path)
                   throws IORuntimeException
```
    删除文件或者文件夹
    注意：删除文件夹时不会判断文件夹是否为空，如果不空则递归删除子文件或文件夹
    某个文件删除失败会终止删除操作
    
    参数:
    
    path - 文件对象
    
    返回:
    
    成功与否
    
    抛出:
    
    IORuntimeException - IO异常
    
    从以下版本开始:
    
    4.4.2
  - copyFile
```
public static Path copyFile(Path src,
                            Path dest,
                            StandardCopyOption... options)
                     throws IORuntimeException
```
    通过JDK7+的 Files.copy(Path, Path, CopyOption...) 方法拷贝文件
    
    参数:
    
    src - 源文件路径
    
    dest - 目标文件或目录，如果为目录使用与源文件相同的文件名
    
    options - StandardCopyOption
    
    返回:
    
    Path
    
    抛出:
    
    IORuntimeException - IO异常
  - copyFile
```
public static Path copyFile(Path src,
                            Path dest,
                            CopyOption... options)
                     throws IORuntimeException
```
    通过JDK7+的 Files.copy(Path, Path, CopyOption...) 方法拷贝文件
    
    参数:
    
    src - 源文件路径
    
    dest - 目标文件或目录，如果为目录使用与源文件相同的文件名
    
    options - StandardCopyOption
    
    返回:
    
    Path
    
    抛出:
    
    IORuntimeException - IO异常
    
    从以下版本开始:
    
    5.4.1
  - isDirectory
```
public static boolean isDirectory(Path path,
                                  boolean isFollowLinks)
```
    判断是否为目录，如果file为null，则返回false
    
    参数:
    
    path - Path
    
    isFollowLinks - 是否追踪到软链对应的真实地址
    
    返回:
    
    如果为目录true
    
    从以下版本开始:
    
    3.1.0
  - getPathEle
```
public static Path getPathEle(Path path,
                              int index)
```
    获取指定位置的子路径部分，支持负数，例如index为-1表示从后数第一个节点位置
    
    参数:
    
    path - 路径
    
    index - 路径节点位置，支持负数（负数从后向前计数）
    
    返回:
    
    获取的子路径
    
    从以下版本开始:
    
    3.1.2
  - getLastPathEle
```
public static Path getLastPathEle(Path path)
```
    获取指定位置的最后一个子路径部分
    
    参数:
    
    path - 路径
    
    返回:
    
    获取的最后一个子路径
    
    从以下版本开始:
    
    3.1.2
  - subPath
```
public static Path subPath(Path path,
                           int fromIndex,
                           int toIndex)
```
    获取指定位置的子路径部分，支持负数，例如起始为-1表示从后数第一个节点位置
    
    参数:
    
    path - 路径
    
    fromIndex - 起始路径节点（包括）
    
    toIndex - 结束路径节点（不包括）
    
    返回:
    
    获取的子路径
    
    从以下版本开始:
    
    3.1.2
  - getAttributes
```
public static BasicFileAttributes getAttributes(Path path,
                                                boolean isFollowLinks)
                                         throws IORuntimeException
```
    获取文件属性
    
    参数:
    
    path - 文件路径Path
    
    isFollowLinks - 是否跟踪到软链对应的真实路径
    
    返回:
    
    BasicFileAttributes
    
    抛出:
    
    IORuntimeException - IO异常
  - getInputStream
```
public static BufferedInputStream getInputStream(Path path)
                                          throws IORuntimeException
```
    获得输入流
    
    参数:
    
    path - Path
    
    返回:
    
    输入流
    
    抛出:
    
    IORuntimeException - 文件未找到
    
    从以下版本开始:
    
    4.0.0
  - getUtf8Reader
```
public static BufferedReader getUtf8Reader(Path path)
                                    throws IORuntimeException
```
    获得一个文件读取器
    
    参数:
    
    path - 文件Path
    
    返回:
    
    BufferedReader对象
    
    抛出:
    
    IORuntimeException - IO异常
    
    从以下版本开始:
    
    4.0.0
  - getReader
```
public static BufferedReader getReader(Path path,
                                       Charset charset)
                                throws IORuntimeException
```
    获得一个文件读取器
    
    参数:
    
    path - 文件Path
    
    charset - 字符集
    
    返回:
    
    BufferedReader对象
    
    抛出:
    
    IORuntimeException - IO异常
    
    从以下版本开始:
    
    4.0.0
  - getOutputStream
```
public static BufferedOutputStream getOutputStream(Path path)
                                            throws IORuntimeException
```
    获得输出流
    
    参数:
    
    path - Path
    
    返回:
    
    输入流
    
    抛出:
    
    IORuntimeException - 文件未找到
    
    从以下版本开始:
    
    5.4.1
  - rename
```
public static Path rename(Path path,
                          String newName,
                          boolean isOverride)
```
    修改文件或目录的文件名，不变更路径，只是简单修改文件名
```
 FileUtil.rename(file, "aaa.jpg", false) xx/xx.png =》xx/aaa.jpg
 
```
    参数:
    
    path - 被修改的文件
    
    newName - 新的文件名，包括扩展名
    
    isOverride - 是否覆盖目标文件
    
    返回:
    
    目标文件Path
    
    从以下版本开始:
    
    5.4.1
  - equals
```
public static boolean equals(Path file1,
                             Path file2)
                      throws IORuntimeException
```
    检查两个文件是否是同一个文件
    所谓文件相同，是指Path对象是否指向同一个文件或文件夹
    
    参数:
    
    file1 - 文件1
    
    file2 - 文件2
    
    返回:
    
    是否相同
    
    抛出:
    
    IORuntimeException - IO异常
    
    从以下版本开始:
    
    5.4.1
    
    另请参阅:
    
    Files.isSameFile(Path, Path)
  - isFile
```
public static boolean isFile(Path path,
                             boolean isFollowLinks)
```
    判断是否为文件，如果file为null，则返回false
    
    参数:
    
    path - 文件
    
    isFollowLinks - 是否跟踪软链（快捷方式）
    
    返回:
    
    如果为文件true
    
    另请参阅:
    
    Files.isRegularFile(Path, LinkOption...)
  - isSymlink
```
public static boolean isSymlink(Path path)
```
    判断是否为符号链接文件
    
    参数:
    
    path - 被检查的文件
    
    返回:
    
    是否为符号链接文件
    
    从以下版本开始:
    
    4.4.2

类 PathUtil

构造器概要

方法概要

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

构造器详细资料

PathUtil

方法详细资料

isDirEmpty

loopFiles

walkFiles

del

copyFile

copyFile

isDirectory

getPathEle

getLastPathEle

subPath

getAttributes

getInputStream

getUtf8Reader

getReader

getOutputStream

rename

equals

isFile

isSymlink