函数
func canonicalize(Path)
public func canonicalize(path: Path): Path
功能:将 Path 实例规范化,获取绝对路径形式的规范化路径。
所有的中间引用和软链接都会处理(UNC 路径下的软链接无法被规范化),例如,对于路径 "/foo/test/../test/bar.txt",该函数会返回 "/foo/test/bar.txt"。
参数:
返回值:
异常:
- FSException - 路径不存在或无法规范化时抛出异常。
- IllegalArgumentException - 路径为空,或包含字符串结束符时抛出异常。
func canonicalize(String)
public func canonicalize(path: String): Path
功能:用 path 字符串构造 Path 实例,并进行规范化,获取绝对路径形式的规范化路径。
所有的中间引用和软链接都会处理 (UNC 路径下的软链接无法被规范化),例如,对于路径 "/foo/test/../test/bar.txt",该函数会返回 "/foo/test/bar.txt"。
参数:
- path: String - 待规范化的路径字符串。
返回值:
异常:
- FSException - 路径不存在或无法规范化时抛出异常。
- IllegalArgumentException - 路径为空,或包含字符串结束符时抛出异常。
func copy(Path, Path, Bool)
public func copy(sourcePath: Path, to!: Path, overwrite!: Bool = false): Unit
功能:实现文件系统的拷贝功能,用于复制文件或目录。
当目标位置存在且 overwrite
为 true
时,该函数要求 sourcePath
的类型与 to
的类型一致,比如,sourcePath
的类型是 Directory
,to
的类型也应该是 Directory
,否则函数会抛出异常 FSException。当前支持的文件类型有文件夹(Directory),常规文件(Regular file),符号链接(SymbolicLink)。
参数:
异常:
- FSException - 如果源文件类型和目标文件类型不一致会抛出异常,或者
overwrite
为false
并且目标地址存在时抛出异常。 - IllegalArgumentException - 路径为空,或包含字符串结束符时抛出异常。
func copy(String, String, Bool)
public func copy(sourcePath: String, to!: String, overwrite!: Bool = false): Unit
功能:实现文件系统的拷贝功能,用于复制文件或目录。
当目标位置存在且 overwrite
为 true
时,该函数要求 sourcePath
的类型与 to
的类型一致,比如,sourcePath
的类型是 Directory
,to
的类型也应该是 Directory
,否则函数会抛出异常 FSException。当前支持的文件类型有文件夹(Directory),常规文件(Regular file),符号链接(SymbolicLink)。
参数:
异常:
- FSException - 如果源文件类型和目标文件类型不一致会抛出异常,或者
overwrite
为false
并且目标地址存在时抛出异常。 - IllegalArgumentException - 路径为空,或包含字符串结束符时抛出异常。
func exists(Path)
public func exists(path: Path): Bool
功能:判断目标地址是否存在。
参数:
- path: Path - 待判断的目标地址。
返回值:
- Bool - 目标地址是否存在。
异常:
- IllegalArgumentException - 路径为空,或包含字符串结束符时抛出异常。
func exists(String)
public func exists(path: String): Bool
功能:判断目标地址是否存在。
参数:
- path: String - 待判断的目标地址。
返回值:
- Bool - 目标地址是否存在。
异常:
- IllegalArgumentException - 路径为空,或包含字符串结束符时抛出异常。
func rename(Path, Path, Bool)
public func rename(sourcePath: Path, to!: Path, overwrite!: Bool = false): Unit
功能:将 sourcePath
指定的文件或者目录重命名为由 to
给定的名称,sourcePath
必须是现有文件或者目录的路径,如果 to
是现有文件或者目录的路径时,其具体行为由 overwrite
指定, 如果 overwrite
为 true
,将会删除现有的文件或者目录,再执行重命名操作,否则会抛出异常。
注意
当
overwrite
为true
时,rename
的一个隐含行为是删除目标位置的原有文件或者目录,如果目标位置是目录,将会递归删除目录内的所有内容,需要谨慎使用。
参数:
异常:
- FSException - 操作系统执行rename方法失败时抛出异常。
- IllegalArgumentException - 路径为空,或包含字符串结束符时抛出异常。
func rename(String, String, Bool)
public func rename(sourcePath: String, to!: String, overwrite!: Bool = false): Unit
功能:将 sourcePath
指定的文件或者目录重命名为由 to
给定的名称,sourcePath
必须是现有文件或者目录的路径,如果 to
是现有文件或者目录的路径时,其具体行为由 overwrite
指定, 如果 overwrite
为 true
,将会删除现有的文件或者目录,再执行重命名操作,overwrite
为 false
会抛出异常。
注意
当
overwrite
为true
时,rename
的一个隐含行为是删除目标位置的原有文件或者目录,如果目标位置是目录,将会递归删除目录内的所有内容,需要谨慎使用。
参数:
异常:
- FSException - 操作系统执行rename方法失败时抛出异常。
- IllegalArgumentException - 路径为空,或包含字符串结束符时抛出异常。
func remove(Path, Bool)
public func remove(path: Path, recursive!: Bool = false): Unit
功能:删除文件或目录。
当目标是文件夹时,可选择是否递归删除文件夹。
参数:
异常:
- FSException - 如果指定目录不存在,或删除失败,则抛异常。
- IllegalArgumentException - 路径为空,或包含字符串结束符时抛出异常。
func remove(String, Bool)
public func remove(path: String, recursive!: Bool = false): Unit
功能:删除文件或目录。
当目标是文件夹时,可选择是否递归删除文件夹。
参数:
异常:
- FSException - 如果指定目录不存在,或删除失败,则抛异常。
- IllegalArgumentException - 路径为空,或包含字符串结束符时抛出异常。
func removeIfExists(Path, Bool)
public func removeIfExists(path: Path, recursive!: Bool = false): Bool
功能:判断目标是否存在,如果存在则执行remove方法,并返回 true
。
参数:
返回值:
- Bool - 目标地址是否存在。
异常:
- FSException - 如果删除失败,抛出此异常。
- IllegalArgumentException - 路径为空,或包含字符串结束符时抛出异常。
func removeIfExists(String, Bool)
public func removeIfExists(path: String, recursive!: Bool = false): Bool
功能:判断目标是否存在,如果存在则执行remove方法,并返回 true
。
参数:
返回值:
- Bool - 目标地址是否存在。
异常:
- FSException - 如果删除失败,抛出此异常。
- IllegalArgumentException - 路径为空,或包含字符串结束符时抛出异常。