FileHelper (AJAXJS-Base 1.2.6 API)

java.lang.Object
- com.ajaxjs.util.io.StreamHelper
- - com.ajaxjs.util.io.FileHelper

```
public class FileHelper
extends StreamHelper
```
文件操作工具类

作者:

sp42 frank@ajaxjs.com

字段概要

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

static String SEPARATOR
当前系统的分隔符(linux、windows)
- 从类继承的字段 com.ajaxjs.util.io.StreamHelper
  BUFFER_SIZE

字段
限定符和类型	字段和说明
`static String`	`SEPARATOR` 当前系统的分隔符(linux、windows)

构造器概要

构造器
构造器和说明

FileHelper()

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

方法概要

所有方法静态方法具体方法
限定符和类型	方法和说明
`static boolean`	`copy(String target, String dest, boolean isReplace)` 复制文件
`static File`	`createFile(String filePath, boolean isOverwrite)` 创建文件，注意这是一个空的文件。
`static File`	`createFile(String folder, String fileName)` 新建一个空文件
`static void`	`delete(File file)` 删除文件或目录
`static void`	`delete(String filePath)` 删除文件或目录
`static String`	`getDirNameByDate()` 根据日期字符串得到目录名格式: /2008/10/15/
`static String`	`getFileName(String str)` 输入 /foo/bar/foo.jpg 返回 foo.jpg
`static String`	`getFileNameFromUrl(String url)` 获取 URL 上的文件名，排除 ?
`static String`	`getFileSuffix(String filename)` 獲取文件名的擴展名
`static void`	`initFolder(File file)` 检测文件所在的目录是否存在，如果没有则建立。
`static void`	`initFolder(String file)` 检测文件所在的目录是否存在，如果没有则建立。
`static void`	`mkDir(String folder)` 创建目录
`static void`	`mkDirByFileName(String filePath)` 根据文件名创建目录。
`static boolean`	`move(String target, String dest)` 移动文件
`static byte[]`	`openAsByte(File file)` 获得指定文件的 byte 数组
`static String`	`openAsText(String filePath)` 打开文件，返回其文本内容。
`static String`	`openAsText(String filePath, Charset encode)` 打开文件，返回其文本内容，可指定编码
`static void`	`save(File file, byte[] data, boolean isOverwrite)` 保存文件数据
`static void`	`save(File file, byte[] data, int off, int len)` 保存文件数据
`static void`	`saveText(File file, String text)` 保存文本内容
`static void`	`saveText(String filePath, String text)` 保存文本内容

从类继承的方法 com.ajaxjs.util.io.StreamHelper
byteIndexOf, byteIndexOf, bytes2output, bytes2output, byteStream2string_Charset, byteStream2string, concat, inputStream2Byte, subBytes, write

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

- 字段详细资料
  - SEPARATOR
```
public static final String SEPARATOR
```
    当前系统的分隔符(linux、windows)
- 构造器详细资料
  - FileHelper
```
public FileHelper()
```
- 方法详细资料
  - copy
```
public static boolean copy(String target,
                           String dest,
                           boolean isReplace)
```
    复制文件
    
    参数:
    
    target - 源文件
    
    dest - 目的文件/目录，如果最后一个为目录，则不改名，如果最后一个为文件名，则改名
    
    isReplace - 是否替换已存在的文件，true = 覆盖
    
    返回:
    
    true 表示复制成功
  - move
```
public static boolean move(String target,
                           String dest)
```
    移动文件
    
    参数:
    
    target - 源文件
    
    dest - 目的文件/目录，如果最后一个为目录，则不改名，如果最后一个为文件名，则改名
    
    返回:
    
    是否操作成功
  - delete
```
public static void delete(File file)
```
    删除文件或目录
    
    参数:
    
    file - 文件对象
  - delete
```
public static void delete(String filePath)
```
    删除文件或目录
    
    参数:
    
    filePath - 文件的完全路径
  - openAsText
```
public static String openAsText(String filePath,
                                Charset encode)
```
    打开文件，返回其文本内容，可指定编码
    
    参数:
    
    filePath - 文件的完全路径
    
    encode - 文件编码
    
    返回:
    
    文件内容
  - openAsText
```
public static String openAsText(String filePath)
```
    打开文件，返回其文本内容。指定为 UTF-8 编码
    
    参数:
    
    filePath - 文件的完全路径
    
    返回:
    
    文件内容
  - openAsByte
```
public static byte[] openAsByte(File file)
```
    获得指定文件的 byte 数组
    
    参数:
    
    file - 文件对象
    
    返回:
    
    文件字节数组
  - save
```
public static void save(File file,
                        byte[] data,
                        boolean isOverwrite)
```
    保存文件数据
    
    参数:
    
    file - 文件对象
    
    data - 文件数据
    
    isOverwrite - 是否覆盖文件，true = 允许覆盖
  - save
```
public static void save(File file,
                        byte[] data,
                        int off,
                        int len)
```
    保存文件数据
    
    参数:
    
    file - 文件对象
    
    data - 文件数据
    
    off - 偏移
    
    len - 长度
  - saveText
```
public static void saveText(File file,
                            String text)
```
    保存文本内容
    
    参数:
    
    file - 文件对象
    
    text - 文本内容
  - saveText
```
public static void saveText(String filePath,
                            String text)
```
    保存文本内容
    
    参数:
    
    filePath - 文件路径
    
    text - 文本内容
  - mkDir
```
public static void mkDir(String folder)
```
    创建目录
    
    参数:
    
    folder - 目录字符串
  - mkDirByFileName
```
public static void mkDirByFileName(String filePath)
```
    根据文件名创建目录。先剥离文件名，剩下的就是目录名。如果没有输出目录则先创建。
    
    参数:
    
    filePath - 完整路径，最后一个元素为文件名
  - initFolder
```
public static void initFolder(File file)
```
    检测文件所在的目录是否存在，如果没有则建立。可以跨多个未建的目录
    
    参数:
    
    file - 必须是文件，不是目录
  - initFolder
```
public static void initFolder(String file)
```
    检测文件所在的目录是否存在，如果没有则建立。可以跨多个未建的目录
    
    参数:
    
    file - 必须是文件，不是目录
  - createFile
```
public static File createFile(String folder,
                              String fileName)
```
    新建一个空文件
    
    参数:
    
    folder - 如果路径不存在则自动创建
    
    fileName - 保存的文件名
    
    返回:
    
    新建文件的 File 对象
  - createFile
```
public static File createFile(String filePath,
                              boolean isOverwrite)
                       throws IOException
```
    创建文件，注意这是一个空的文件。如果没有指定目录则创建；检测是否可以覆盖文件
    
    参数:
    
    filePath - 文件完整路径，最后一个元素是文件名
    
    isOverwrite - 是否覆盖文件
    
    返回:
    
    文件对象
    
    抛出:
    
    IOException - 文件已经存在
  - getDirNameByDate
```
public static String getDirNameByDate()
```
    根据日期字符串得到目录名格式: /2008/10/15/
    
    返回:
    
    如 /2008/10/15/ 格式的字符串
  - getFileName
```
public static String getFileName(String str)
```
    输入 /foo/bar/foo.jpg 返回 foo.jpg
    
    参数:
    
    str - 输入的字符串
    
    返回:
    
    文件名
  - getFileNameFromUrl
```
public static String getFileNameFromUrl(String url)
```
    获取 URL 上的文件名，排除 ? 参数部分
    
    参数:
    
    url - URL
    
    返回:
    
    文件名
  - getFileSuffix
```
public static String getFileSuffix(String filename)
```
    獲取文件名的擴展名
    
    参数:
    
    filename - 文件名
    
    返回:
    
    擴展名

类 FileHelper

字段概要

从类继承的字段 com.ajaxjs.util.io.StreamHelper

构造器概要

方法概要

从类继承的方法 com.ajaxjs.util.io.StreamHelper

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

字段详细资料

SEPARATOR

构造器详细资料

FileHelper

方法详细资料

copy

move

delete

delete

openAsText

openAsText

openAsByte

save

save

saveText

saveText

mkDir

mkDirByFileName

initFolder

initFolder

createFile

createFile

getDirNameByDate

getFileName

getFileNameFromUrl

getFileSuffix