PathUtil (heaven 0.13.0 API)

java.lang.Object
- com.github.houbb.heaven.util.nio.PathUtil

```
public final class PathUtil
extends Object
```
路径工具类

从以下版本开始:

0.0.6

作者:

binbin.hou

字段概要

字段
限定符和类型字段和说明

static Path ROOT_PATH
根路径

字段
限定符和类型	字段和说明
`static Path`	`ROOT_PATH` 根路径

方法概要

所有方法静态方法具体方法已过时的方法
限定符和类型	方法和说明
`static void`	`appendLines(String pathStr, Collection<String> lines)` 行内容添加到到指定文件
`static void`	`appendLines(String pathStr, String... lines)` 行内容添加到到指定列
`static List<Path>`	`getAllDirFileNames(String dir)` 获取某一路径下的所有文件
`static String`	`getAppResourcesPath()` 获取资源文件默认存放路径。
`static String`	`getAppRootPath()` 获取项目根路径。
`static String`	`getAppTestResourcesPath()` 获取测试类
`static List<Path>`	`getDirFileNames(String dir, String glob)` 获取指定文件夹下对应的某类型文件
`static List<String>`	`getDirFileNameStrs(String dir, String glob)` 获得列表下对应的文件字符串形式
`static Path`	`getParentPath(Path path)` 获取父类路径，避免返回 null 1.
`static List<Path>`	`getParentPaths(Path path)` 获取所有的父类路径 1.
`static String`	`getPath()` 已过时。 (因为结果具有不确定性)
`static String`	`getPath(Class clazz)` 直接class.getResource("")拿到的是编译后的路径。
`static List<Path>`	`getPathList(Path rootPath)` 递归获取所有对应的文件 1.
`static List<Path>`	`getPathList(String dir, String glob)` 获得对应的PATH列表。
`static Path`	`getPublicParentPath(List<Path> pathList)` 获取共有的路径
`static String`	`getRelativePath(Path parentPath, Path path)` 获取 path 相对于 parentPath 剩余的路径和 `Path.relativize(Path)` 不同，这个结果更加直观。
`static String`	`getRootPath()` 获取的target路径
`static String`	`getRootPath(Class clazz)` 类似getPath(Class), 只是不包含类的路径,而是获取到当前类包的根路径。
`static String`	`packageToPath(String packagePath)` 将包名称转化为对应的路径 com.github.houbinbin TO: com/github/houbinbin
`static List<String>`	`readAllLines(String pathStr)` 读取文件所有行的内容
`static List<String>`	`readAllLines(String pathStr, String charset)` 读取文件所有行的内容
`static List<String>`	`readAllLines(String pathStr, String charset, int startIndex, int endIndex)` 读取文件所有的行
`static List<String>`	`retainAll(List<List<String>> collectionList)` 获取所有集合的交集 1.
`static void`	`writeLines(String pathStr, Collection<String> lines)` 写入行内容到指定文件
`static void`	`writeLines(String pathStr, Collection<String> lines, String charset, OpenOption... openOptions)` 写入行内容到指定列
`static void`	`writeLines(String pathStr, String... lines)` 写入行内容到指定列

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

- 字段详细资料
  - ROOT_PATH
```
public static final Path ROOT_PATH
```
    根路径
- 方法详细资料
  - getRelativePath
```
public static String getRelativePath(Path parentPath,
                                     Path path)
```
    获取 path 相对于 parentPath 剩余的路径和 Path.relativize(Path) 不同，这个结果更加直观。不过性能一般。
    
    参数:
    
    parentPath - 父类路径
    
    path - 原始路径
    
    返回:
    
    相对结果路径
  - getPublicParentPath
```
public static Path getPublicParentPath(List<Path> pathList)
```
    获取共有的路径
    
    参数:
    
    pathList - 路径列表
    
    返回:
    
    结果
  - getParentPaths
```
public static List<Path> getParentPaths(Path path)
```
    获取所有的父类路径 1. 不包含本身 2. 递归获取父类，如果父类为 null 则停止（说明到 root 了） 3. 默认 / root 的是所有逻辑的父亲路径，包括 root 文件夹本身。
    
    参数:
    
    path - 当前路径
    
    返回:
    
    所有的父类列表
  - getParentPath
```
public static Path getParentPath(Path path)
```
    获取父类路径，避免返回 null 1. 如果为根路径，则依然返回根路径
    
    参数:
    
    path - 路径
    
    返回:
    
    结果
  - retainAll
```
public static List<String> retainAll(List<List<String>> collectionList)
```
    获取所有集合的交集 1. 如果后续参数为空，则直接返回第一个集合。 2. 如果第一个列表为空，则直接返回第一个集合。
    
    参数:
    
    collectionList - 原始对象集合
    
    返回:
    
    满足条件的结合
  - getPathList
```
public static List<Path> getPathList(Path rootPath)
```
    递归获取所有对应的文件 1. 如果为文件，直接返回本身 2. 如果为文件夹，则递归获取下面的所有文件信息
    
    参数:
    
    rootPath - 根路径
    
    返回:
    
    文件列表
  - getPathList
```
public static List<Path> getPathList(String dir,
                                     String glob)
```
    获得对应的PATH列表。
    
    参数:
    
    dir - 文件夹
    
    glob - 文件正则
    
    返回:
    
    路径列表
  - getDirFileNames
```
public static List<Path> getDirFileNames(String dir,
                                         String glob)
```
    获取指定文件夹下对应的某类型文件
    
    参数:
    
    dir - 文件夹路径
    
    glob - 文件正则表达式
    
    返回:
    
    path list
  - getAllDirFileNames
```
public static List<Path> getAllDirFileNames(String dir)
```
    获取某一路径下的所有文件
    
    参数:
    
    dir - 文件夹
    
    返回:
    
    路径列表
    
    另请参阅:
    
    指定此处的glob为 *.*
  - getDirFileNameStrs
```
public static List<String> getDirFileNameStrs(String dir,
                                              String glob)
```
    获得列表下对应的文件字符串形式
    
    参数:
    
    dir - 文件夹
    
    glob - 文件正则
    
    返回:
    
    文件名称列表
  - getPath
```
public static String getPath()
```
    已过时。 (因为结果具有不确定性)
    
    结果不确定
    
    返回:
    
    路径
    
    从以下版本开始:
    
    0.0.7
  - getRootPath
```
public static String getRootPath()
```
    获取的target路径
    
    返回:
    
    路径
    
    从以下版本开始:
    
    0.0.7
  - getAppRootPath
```
public static String getAppRootPath()
```
    获取项目根路径。
    
    返回:
    
    本项目中返回: /Users/houbinbin/IT/code/script-generator since 0.0.7
  - getAppResourcesPath
```
public static String getAppResourcesPath()
```
    获取资源文件默认存放路径。
    
    返回:
    
    根路径+/src/main/resources
  - getAppTestResourcesPath
```
public static String getAppTestResourcesPath()
```
    获取测试类
    
    返回:
    
    转换后的路径
  - getRootPath
```
public static String getRootPath(Class clazz)
```
    类似getPath(Class), 只是不包含类的路径,而是获取到当前类包的根路径。如: filelist:/Users/houbinbin/IT/code/script-generator/script-generator-tool/target/classes/ 转化为: /Users/houbinbin/IT/code/script-generator/script-generator-tool/src/main/java
    
    参数:
    
    clazz - 类
    
    返回:
    
    转换后的路径
  - getPath
```
public static String getPath(Class clazz)
```
    直接class.getResource("")拿到的是编译后的路径。如: filelist:/Users/houbinbin/IT/code/script-generator/script-generator-tool/target/classes/com/ryo/script-generator/util/ 转化成: /Users/houbinbin/IT/code/script-generator/script-generator-tool/src/main/java/com/ryo/script-generator/util/
    
    参数:
    
    clazz - 类
    
    返回:
    
    转换后的路径
  - packageToPath
```
public static String packageToPath(String packagePath)
```
    将包名称转化为对应的路径 com.github.houbinbin TO: com/github/houbinbin
    
    参数:
    
    packagePath - 包名称
    
    返回:
    
    转换后的路径
  - readAllLines
```
public static List<String> readAllLines(String pathStr)
```
    读取文件所有行的内容
    
    参数:
    
    pathStr - 路径
    
    返回:
    
    列表
    
    从以下版本开始:
    
    0.1.6
  - readAllLines
```
public static List<String> readAllLines(String pathStr,
                                        String charset)
```
    读取文件所有行的内容
    
    参数:
    
    pathStr - 路径
    
    charset - 编码
    
    返回:
    
    列表
    
    从以下版本开始:
    
    0.1.6
  - readAllLines
```
public static List<String> readAllLines(String pathStr,
                                        String charset,
                                        int startIndex,
                                        int endIndex)
```
    读取文件所有的行
    
    参数:
    
    pathStr - 路径
    
    charset - 编码
    
    startIndex - 开始行下标
    
    endIndex - 结束行下标
    
    返回:
    
    列表内容
    
    从以下版本开始:
    
    0.1.6
  - writeLines
```
public static void writeLines(String pathStr,
                              String... lines)
```
    写入行内容到指定列
    
    参数:
    
    pathStr - 路径
    
    lines - 行内容数组
    
    从以下版本开始:
    
    0.1.8
  - writeLines
```
public static void writeLines(String pathStr,
                              Collection<String> lines)
```
    写入行内容到指定文件
    
    参数:
    
    pathStr - 路径
    
    lines - 行内容
    
    从以下版本开始:
    
    0.1.8
  - appendLines
```
public static void appendLines(String pathStr,
                               String... lines)
```
    行内容添加到到指定列
    
    参数:
    
    pathStr - 路径
    
    lines - 行内容数组
    
    从以下版本开始:
    
    0.1.8
  - appendLines
```
public static void appendLines(String pathStr,
                               Collection<String> lines)
```
    行内容添加到到指定文件
    
    参数:
    
    pathStr - 路径
    
    lines - 行内容
    
    从以下版本开始:
    
    0.1.8
  - writeLines
```
public static void writeLines(String pathStr,
                              Collection<String> lines,
                              String charset,
                              OpenOption... openOptions)
```
    写入行内容到指定列
    
    参数:
    
    pathStr - 路径
    
    charset - 编码
    
    lines - 行内容
    
    openOptions - 操作
    
    从以下版本开始:
    
    0.1.8

类 PathUtil

字段概要

方法概要

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

字段详细资料

ROOT_PATH

方法详细资料

getRelativePath

getPublicParentPath

getParentPaths

getParentPath

retainAll

getPathList

getPathList

getDirFileNames

getAllDirFileNames

getDirFileNameStrs

getPath

getRootPath

getAppRootPath

getAppResourcesPath

getAppTestResourcesPath

getRootPath

getPath

packageToPath

readAllLines

readAllLines

readAllLines

writeLines

writeLines

appendLines

appendLines

writeLines