Files (Nutz 1.r.61.r2 API)

java.lang.Object
- org.nutz.lang.Files

```
public class Files
extends Object
```
文件操作的帮助函数

作者:

amos(amosleaf@gmail.com), zozoh(zozohtnt@gmail.com), wendal(wendal1985@gmail.com), bonyfish(mc02cxj@gmail.com)

嵌套类概要

嵌套类
限定符和类型类和说明

static class Files.LsMode
each 函数的参数类型

嵌套类
限定符和类型	类和说明
`static class`	`Files.LsMode` each 函数的参数类型

构造器概要

构造器
构造器和说明

Files()

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

方法概要

所有方法静态方法具体方法
限定符和类型	方法和说明
`static void`	`appendWrite(File f, Object obj)` 将内容写到一个文件末尾 InputStream - 按二进制方式写入 byte[] - 按二进制方式写入 Reader - 按 UTF-8 方式写入其他对象被 toString() 后按照 UTF-8 方式写入
`static File`	`checkFile(String path)` 从 CLASSPATH 下或从指定的本机器路径下寻找一个文件
`static void`	`cleanAllFolderInSubFolderes(File dir, String name)` 将一个目录下的特殊名称的目录彻底删除，比如 '.svn' 或者 '.cvs'
`static boolean`	`clearDir(File dir)` 清除一个目录里所有的内容
`static boolean`	`copy(File src, File target)` 自动决定是 copy 文件还是目录
`static boolean`	`copyDir(File src, File target)` 拷贝一个目录
`static boolean`	`copyFile(File src, File target)` 相当于 copyFile(src,target,-1)
`static boolean`	`copyFile(File src, File target, long count)` 将一个文件 copy 一部分（或者全部）到另外一个文件。
`static boolean`	`copyFileWithoutException(File src, File target, long count)`
`static boolean`	`copyOnWrite(File f, Object obj)`
`static boolean`	`copyOnWrite(String path, Object obj)`
`static File`	`createDirIfNoExists(File d)` 传入一个目录对象，如果目录不存在，则创建目录
`static File`	`createDirIfNoExists(String path)` 试图生成一个目录对象，如果文件不存在则创建它。
`static File`	`createFileIfNoExists(File f)` 如果文件对象不存在，则创建它
`static File`	`createFileIfNoExists(String path)` 试图生成一个文件对象，如果文件不存在则创建它。
`static File`	`createFileIfNoExists2(String path)`
`static boolean`	`createNewFile(File f)` 创建新文件，如果父目录不存在，也一并创建。
`static boolean`	`deleteDir(File dir)` 强行删除一个目录，包括这个目录下所有的子目录和文件
`static boolean`	`deleteFile(File f)` 删除一个文件
`static File[]`	`dirs(File dir)` 获取一个目录下所有子目录。
`static boolean`	`equals(File f1, File f2)` 判断两个文件内容是否相等
`static File[]`	`files(File dir, String suffix)` 获取一个目录下所有的文件(不递归，仅仅一层)。
`static ZipEntry[]`	`findEntryInZip(ZipFile zip, String regex)` 根据正则式，从压缩文件中获取文件
`static File`	`findFile(String path)` 从 CLASSPATH 下或从指定的本机器路径下寻找一个文件
`static File`	`findFile(String path, ClassLoader klassLoader)` 从 CLASSPATH 下或从指定的本机器路径下寻找一个文件
`static File`	`findFile(String path, ClassLoader klassLoader, String enc)` 从 CLASSPATH 下或从指定的本机器路径下寻找一个文件
`static File`	`findFile(String path, String enc)` 从 CLASSPATH 下或从指定的本机器路径下寻找一个文件
`static InputStream`	`findFileAsStream(String path)` 获取输出流
`static InputStream`	`findFileAsStream(String path, Class<?> klass)` 获取输出流
`static InputStream`	`findFileAsStream(String path, Class<?> klass, String enc)` 获取输出流
`static InputStream`	`findFileAsStream(String path, String enc)` 获取输出流
`static File`	`getFile(File dir, String path)` 在一个目录下，获取一个文件对象
`static String`	`getMajorName(File f)` 获取文件主名。
`static String`	`getMajorName(String path)` 获取文件主名。
`static String`	`getName(File f)`
`static String`	`getName(String path)`
`static String`	`getParent(String path)`
`static String`	`getSuffix(File f)`
`static String`	`getSuffix(String path)` 获取文件后缀名，包括 '.'
`static String`	`getSuffixName(File f)`
`static String`	`getSuffixName(String path)` 获取文件后缀名，不包括 '.'
`static boolean`	`isDirectory(File f)` 文件对象是否是目录，可接受 null
`static boolean`	`isEquals(File f1, File f2)` 精确比较两个文件是否相等
`static boolean`	`isFile(File f)` 文件对象是否是文件，可接受 null
`static File[]`	`ls(File d, Pattern p, boolean exclude, Files.LsMode mode)` 在一个目录里列出所有的子文件或者目录
`static File[]`	`ls(File d, String regex, Files.LsMode mode)` 列文件
`static File[]`	`ls(String path, String regex, Files.LsMode mode)`
`static File[]`	`lsAll(File d, String regex)`
`static File[]`	`lsAll(String path, String regex)`
`static File[]`	`lsDir(File d, String regex)`
`static File[]`	`lsDir(String path, String regex)`
`static File[]`	`lsFile(File d, String regex)`
`static File[]`	`lsFile(String path, String regex)`
`static boolean`	`makeDir(File dir)` 创建新目录，如果父目录不存在，也一并创建。
`static boolean`	`move(File src, File target)` 将文件移动到新的位置
`static String`	`read(File f)` 读取 UTF-8 文件全部内容
`static String`	`read(String path)` 读取 UTF-8 文件全部内容
`static byte[]`	`readBytes(File f)` 读取文件全部字节，并关闭文件
`static byte[]`	`readBytes(String path)` 读取文件全部字节，并关闭文件
`static void`	`readLine(File f, Callback<String> callback)`
`static List<String>`	`readLines(File f)`
`static int`	`readRange(File f, int pos, byte[] buf, int at, int len)`
`static boolean`	`rename(File src, String newName)` 将文件改名
`static String`	`renamePath(String path, String newName)` 修改路径
`static File`	`renameSuffix(File f, String suffix)` 将文件后缀改名，从而生成一个新的文件对象。
`static String`	`renameSuffix(String path, String suffix)` 将文件路径后缀改名，从而生成一个新的文件路径。
`static File[]`	`scanDirs(File dir)` 递归查找获取一个目录下所有子目录(及子目录的子目录)。
`static void`	`write(File f, Object obj)` 将内容写到一个文件内，内容对象可以是： InputStream - 按二进制方式写入 byte[] - 按二进制方式写入 Reader - 按 UTF-8 方式写入其他对象被 toString() 后按照 UTF-8 方式写入
`static void`	`write(String path, Object obj)` 将内容写到一个文件内，内容对象可以是： InputStream - 按二进制方式写入 byte[] - 按二进制方式写入 Reader - 按 UTF-8 方式写入其他对象被 toString() 后按照 UTF-8 方式写入
`static int`	`writeRange(File f, int pos, byte[] buf, int at, int len)`

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

- 构造器详细资料
  - Files
```
public Files()
```
- 方法详细资料
  - read
```
public static String read(String path)
```
    读取 UTF-8 文件全部内容
    
    参数:
    
    path - 文件路径
    
    返回:
    
    文件内容
  - read
```
public static String read(File f)
```
    读取 UTF-8 文件全部内容
    
    参数:
    
    f - 文件
    
    返回:
    
    文件内容
  - readBytes
```
public static byte[] readBytes(String path)
```
    读取文件全部字节，并关闭文件
    
    参数:
    
    path - 文件路径
    
    返回:
    
    文件的字节内容
  - readBytes
```
public static byte[] readBytes(File f)
```
    读取文件全部字节，并关闭文件
    
    参数:
    
    f - 文件
    
    返回:
    
    文件的字节内容
  - write
```
public static void write(String path,
                         Object obj)
```
    将内容写到一个文件内，内容对象可以是：
    - InputStream - 按二进制方式写入
    - byte[] - 按二进制方式写入
    - Reader - 按 UTF-8 方式写入
    - 其他对象被 toString() 后按照 UTF-8 方式写入
    参数:
    
    path - 文件路径，如果不存在，则创建
    
    obj - 内容对象
  - write
```
public static void write(File f,
                         Object obj)
```
    将内容写到一个文件内，内容对象可以是：
    - InputStream - 按二进制方式写入
    - byte[] - 按二进制方式写入
    - Reader - 按 UTF-8 方式写入
    - 其他对象被 toString() 后按照 UTF-8 方式写入
    参数:
    
    f - 文件
    
    obj - 内容
  - appendWrite
```
public static void appendWrite(File f,
                               Object obj)
```
    将内容写到一个文件末尾
    - InputStream - 按二进制方式写入
    - byte[] - 按二进制方式写入
    - Reader - 按 UTF-8 方式写入
    - 其他对象被 toString() 后按照 UTF-8 方式写入
    参数:
    
    f - 文件
    
    obj - 内容
  - renameSuffix
```
public static File renameSuffix(File f,
                                String suffix)
```
    将文件后缀改名，从而生成一个新的文件对象。但是并不在磁盘上创建它
    
    参数:
    
    f - 文件
    
    suffix - 新后缀，比如 ".gif" 或者 ".jpg"
    
    返回:
    
    新文件对象
  - renameSuffix
```
public static String renameSuffix(String path,
                                  String suffix)
```
    将文件路径后缀改名，从而生成一个新的文件路径。
    
    参数:
    
    path - 文件路径
    
    suffix - 新后缀，比如 ".gif" 或者 ".jpg"
    
    返回:
    
    新文件后缀
  - getMajorName
```
public static String getMajorName(String path)
```
    获取文件主名。即去掉后缀的名称
    
    参数:
    
    path - 文件路径
    
    返回:
    
    文件主名
  - getMajorName
```
public static String getMajorName(File f)
```
    获取文件主名。即去掉后缀的名称
    
    参数:
    
    f - 文件
    
    返回:
    
    文件主名
  - getSuffixName
```
public static String getSuffixName(File f)
```
    另请参阅:
    
    getSuffixName(String)
  - getSuffixName
```
public static String getSuffixName(String path)
```
    获取文件后缀名，不包括 '.'，如 'abc.gif','，则返回 'gif'
    
    参数:
    
    path - 文件路径
    
    返回:
    
    文件后缀名
  - getSuffix
```
public static String getSuffix(File f)
```
    另请参阅:
    
    getSuffix(String)
  - getSuffix
```
public static String getSuffix(String path)
```
    获取文件后缀名，包括 '.'，如 'abc.gif','，则返回 '.gif'
    
    参数:
    
    path - 文件路径
    
    返回:
    
    文件后缀
  - findEntryInZip
```
public static ZipEntry[] findEntryInZip(ZipFile zip,
                                        String regex)
```
    根据正则式，从压缩文件中获取文件
    
    参数:
    
    zip - 压缩文件
    
    regex - 正则式，用来匹配文件名
    
    返回:
    
    数组
  - createFileIfNoExists
```
public static File createFileIfNoExists(String path)
                                 throws IOException
```
    试图生成一个文件对象，如果文件不存在则创建它。如果给出的 PATH 是相对路径则会在 CLASSPATH 中寻找，如果未找到，则会在用户主目录中创建这个文件
    
    参数:
    
    path - 文件路径，可以以 ~ 开头，也可以是 CLASSPATH 下面的路径
    
    返回:
    
    文件对象
    
    抛出:
    
    IOException - 创建失败
  - createFileIfNoExists2
```
public static File createFileIfNoExists2(String path)
```
  - createFileIfNoExists
```
public static File createFileIfNoExists(File f)
```
    如果文件对象不存在，则创建它
    
    参数:
    
    f - 文件对象
    
    返回:
    
    传入的文件对象，以便为调用者省略一行代码
  - createDirIfNoExists
```
public static File createDirIfNoExists(String path)
```
    试图生成一个目录对象，如果文件不存在则创建它。如果给出的 PATH 是相对路径则会在 CLASSPATH 中寻找，如果未找到，则会在用户主目录中创建这个目录
    
    参数:
    
    path - 文件路径，可以以 ~ 开头，也可以是 CLASSPATH 下面的路径
    
    返回:
    
    文件对象
  - createDirIfNoExists
```
public static File createDirIfNoExists(File d)
```
    传入一个目录对象，如果目录不存在，则创建目录
    
    参数:
    
    d - 文件目录对象
    
    返回:
    
    文件目录对象，以便调用者省略一行代码
  - findFile
```
public static File findFile(String path,
                            ClassLoader klassLoader,
                            String enc)
```
    从 CLASSPATH 下或从指定的本机器路径下寻找一个文件
    
    参数:
    
    path - 文件路径
    
    klassLoader - 参考 ClassLoader
    
    enc - 文件路径编码
    
    返回:
    
    文件对象，如果不存在，则为 null
  - findFile
```
public static File findFile(String path,
                            String enc)
```
    从 CLASSPATH 下或从指定的本机器路径下寻找一个文件
    
    参数:
    
    path - 文件路径
    
    enc - 文件路径编码
    
    返回:
    
    文件对象，如果不存在，则为 null
  - findFile
```
public static File findFile(String path,
                            ClassLoader klassLoader)
```
    从 CLASSPATH 下或从指定的本机器路径下寻找一个文件
    
    参数:
    
    path - 文件路径
    
    klassLoader - 使用该 ClassLoader进行查找
    
    返回:
    
    文件对象，如果不存在，则为 null
  - ls
```
public static File[] ls(File d,
                        Pattern p,
                        boolean exclude,
                        Files.LsMode mode)
```
    在一个目录里列出所有的子文件或者目录
    
    参数:
    
    d - 目录
    
    p - 正则表达式对象，如果为空，则是全部正则表达式
    
    exclude - true 正则表达式匹配的文件会被忽略，false 正则表达式匹配的文件会被包含
    
    mode - 请参看 LsMode 枚举类说明, null 表示 LsMode.ALL
    
    返回:
    
    得到文件对象数组
    
    另请参阅:
    
    Files.LsMode
  - ls
```
public static File[] ls(File d,
                        String regex,
                        Files.LsMode mode)
```
    列文件
    
    参数:
    
    d - 目录对象
    
    regex - 正则表达式
    
    mode - 模式
    
    返回:
    
    文件列表对象
    
    另请参阅:
    
    ls(File, Pattern, boolean, LsMode)
  - ls
```
public static File[] ls(String path,
                        String regex,
                        Files.LsMode mode)
```
    另请参阅:
    
    ls(File, String, LsMode)
  - lsFile
```
public static File[] lsFile(File d,
                            String regex)
```
    另请参阅:
    
    ls(File, String, LsMode)
  - lsFile
```
public static File[] lsFile(String path,
                            String regex)
```
    另请参阅:
    
    ls(String, String, LsMode)
  - lsDir
```
public static File[] lsDir(File d,
                           String regex)
```
    另请参阅:
    
    ls(File, String, LsMode)
  - lsDir
```
public static File[] lsDir(String path,
                           String regex)
```
    另请参阅:
    
    ls(String, String, LsMode)
  - lsAll
```
public static File[] lsAll(File d,
                           String regex)
```
    另请参阅:
    
    ls(File, String, LsMode)
  - lsAll
```
public static File[] lsAll(String path,
                           String regex)
```
    另请参阅:
    
    ls(String, String, LsMode)
  - findFile
```
public static File findFile(String path)
```
    从 CLASSPATH 下或从指定的本机器路径下寻找一个文件
    
    参数:
    
    path - 文件路径
    
    返回:
    
    文件对象，如果不存在，则为 null
  - checkFile
```
public static File checkFile(String path)
```
    从 CLASSPATH 下或从指定的本机器路径下寻找一个文件
    
    参数:
    
    path - 文件路径
    
    返回:
    
    文件对象，如果不存在，则抛出一个运行时异常
  - findFileAsStream
```
public static InputStream findFileAsStream(String path,
                                           Class<?> klass,
                                           String enc)
```
    获取输出流
    
    参数:
    
    path - 文件路径
    
    klass - 参考的类， -- 会用这个类的 ClassLoader
    
    enc - 文件路径编码
    
    返回:
    
    输出流
  - findFileAsStream
```
public static InputStream findFileAsStream(String path,
                                           String enc)
```
    获取输出流
    
    参数:
    
    path - 文件路径
    
    enc - 文件路径编码
    
    返回:
    
    输出流
  - findFileAsStream
```
public static InputStream findFileAsStream(String path,
                                           Class<?> klass)
```
    获取输出流
    
    参数:
    
    path - 文件路径
    
    klass - 参考的类， -- 会用这个类的 ClassLoader
    
    返回:
    
    输出流
  - findFileAsStream
```
public static InputStream findFileAsStream(String path)
```
    获取输出流
    
    参数:
    
    path - 文件路径
    
    返回:
    
    输出流
  - isDirectory
```
public static boolean isDirectory(File f)
```
    文件对象是否是目录，可接受 null
  - isFile
```
public static boolean isFile(File f)
```
    文件对象是否是文件，可接受 null
  - createNewFile
```
public static boolean createNewFile(File f)
                             throws IOException
```
    创建新文件，如果父目录不存在，也一并创建。可接受 null 参数
    
    参数:
    
    f - 文件对象
    
    返回:
    
    false，如果文件已存在。 true 创建成功
    
    抛出:
    
    IOException
  - makeDir
```
public static boolean makeDir(File dir)
```
    创建新目录，如果父目录不存在，也一并创建。可接受 null 参数
    
    参数:
    
    dir - 目录对象
    
    返回:
    
    false，如果目录已存在。 true 创建成功
    
    抛出:
    
    IOException
  - deleteDir
```
public static boolean deleteDir(File dir)
```
    强行删除一个目录，包括这个目录下所有的子目录和文件
    
    参数:
    
    dir - 目录
    
    返回:
    
    是否删除成功
  - deleteFile
```
public static boolean deleteFile(File f)
```
    删除一个文件
    
    参数:
    
    f - 文件
    
    返回:
    
    是否删除成功
    
    抛出:
    
    IOException
  - clearDir
```
public static boolean clearDir(File dir)
```
    清除一个目录里所有的内容
    
    参数:
    
    dir - 目录
    
    返回:
    
    是否清除成功
  - copyFile
```
public static boolean copyFile(File src,
                               File target)
                        throws IOException
```
    相当于 copyFile(src,target,-1)
    
    抛出:
    
    IOException
    
    另请参阅:
    
    copyFile(File, File, long)
  - copyFile
```
public static boolean copyFile(File src,
                               File target,
                               long count)
                        throws IOException
```
    将一个文件 copy 一部分（或者全部）到另外一个文件。如果目标文件不存在，创建它先。
    
    参数:
    
    src - 源文件
    
    target - 目标文件
    
    count - 要 copy 的字节数，0 表示什么都不 copy， -1 表示 copy 全部数据
    
    返回:
    
    是否成功
    
    抛出:
    
    IOException
  - copyFileWithoutException
```
public static boolean copyFileWithoutException(File src,
                                               File target,
                                               long count)
```
    另请参阅:
    
    copyFile(File, File, long)
  - copy
```
public static boolean copy(File src,
                           File target)
```
    自动决定是 copy 文件还是目录
    
    参数:
    
    src - 源
    
    target - 目标
    
    返回:
    
    是否 copy 成功
  - copyDir
```
public static boolean copyDir(File src,
                              File target)
                       throws IOException
```
    拷贝一个目录
    
    参数:
    
    src - 原始目录
    
    target - 新目录
    
    返回:
    
    是否拷贝成功
    
    抛出:
    
    IOException
  - move
```
public static boolean move(File src,
                           File target)
                    throws IOException
```
    将文件移动到新的位置
    
    参数:
    
    src - 原始文件
    
    target - 新文件
    
    返回:
    
    移动是否成功
    
    抛出:
    
    IOException
  - rename
```
public static boolean rename(File src,
                             String newName)
```
    将文件改名
    
    参数:
    
    src - 文件
    
    newName - 新名称
    
    返回:
    
    改名是否成功
  - renamePath
```
public static String renamePath(String path,
                                String newName)
```
    修改路径
    
    参数:
    
    path - 路径
    
    newName - 新名称
    
    返回:
    
    新路径
  - getParent
```
public static String getParent(String path)
```
    参数:
    
    path - 路径
    
    返回:
    
    父路径
  - getName
```
public static String getName(File f)
```
    参数:
    
    f - 文件对象
    
    返回:
    
    文件或者目录名
  - getName
```
public static String getName(String path)
```
    参数:
    
    path - 全路径
    
    返回:
    
    文件或者目录名
  - cleanAllFolderInSubFolderes
```
public static void cleanAllFolderInSubFolderes(File dir,
                                               String name)
                                        throws IOException
```
    将一个目录下的特殊名称的目录彻底删除，比如 '.svn' 或者 '.cvs'
    
    参数:
    
    dir - 目录
    
    name - 要清除的目录名
    
    抛出:
    
    IOException
  - isEquals
```
public static boolean isEquals(File f1,
                               File f2)
```
    精确比较两个文件是否相等
    参数:
    
    f1 - 文件1
    
    f2 - 文件2
    
    返回:
    true: 两个文件内容完全相等
    false: 任何一个文件对象为 null，不存在或内容不相等
  - getFile
```
public static File getFile(File dir,
                           String path)
```
    在一个目录下，获取一个文件对象
    
    参数:
    
    dir - 目录
    
    path - 文件相对路径
    
    返回:
    
    文件
  - dirs
```
public static File[] dirs(File dir)
```
    获取一个目录下所有子目录。子目录如果以 '.' 开头，将被忽略
    
    参数:
    
    dir - 目录
    
    返回:
    
    子目录数组
  - scanDirs
```
public static File[] scanDirs(File dir)
```
    递归查找获取一个目录下所有子目录(及子目录的子目录)。子目录如果以 '.' 开头，将被忽略
    包含传入的目录
    
    参数:
    
    dir - 目录
    
    返回:
    
    子目录数组
  - files
```
public static File[] files(File dir,
                           String suffix)
```
    获取一个目录下所有的文件(不递归，仅仅一层)。隐藏文件会被忽略。
    
    参数:
    
    dir - 目录
    
    suffix - 文件后缀名。如果为 null，则获取全部文件
    
    返回:
    
    文件数组
  - equals
```
public static boolean equals(File f1,
                             File f2)
```
    判断两个文件内容是否相等
    参数:
    
    f1 - 文件对象
    
    f2 - 文件对象
    
    返回:
    true: 两个文件内容完全相等
    false: 任何一个文件对象为 null，不存在或内容不相等
  - copyOnWrite
```
public static boolean copyOnWrite(File f,
                                  Object obj)
```
  - copyOnWrite
```
public static boolean copyOnWrite(String path,
                                  Object obj)
```
  - readLines
```
public static List<String> readLines(File f)
```
  - readLine
```
public static void readLine(File f,
                            Callback<String> callback)
```
  - readRange
```
public static int readRange(File f,
                            int pos,
                            byte[] buf,
                            int at,
                            int len)
```
  - writeRange
```
public static int writeRange(File f,
                             int pos,
                             byte[] buf,
                             int at,
                             int len)
```

类 Files

嵌套类概要

构造器概要

方法概要

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

构造器详细资料

Files

方法详细资料

read

read

readBytes

readBytes

write

write

appendWrite

renameSuffix

renameSuffix

getMajorName

getMajorName

getSuffixName

getSuffixName

getSuffix

getSuffix

findEntryInZip

createFileIfNoExists

createFileIfNoExists2

createFileIfNoExists

createDirIfNoExists

createDirIfNoExists

findFile

findFile

findFile

ls

ls

ls

lsFile

lsFile

lsDir

lsDir

lsAll

lsAll

findFile

checkFile

findFileAsStream

findFileAsStream

findFileAsStream

findFileAsStream

isDirectory

isFile

createNewFile

makeDir

deleteDir

deleteFile

clearDir

copyFile

copyFile

copyFileWithoutException

copy

copyDir

move

rename

renamePath

getParent

getName

getName

cleanAllFolderInSubFolderes

isEquals

getFile

dirs

scanDirs

files

equals

copyOnWrite

copyOnWrite

readLines

readLine

readRange

writeRange