cn.hutool.core.io.file

Class FileWriter

java.lang.Object

cn.hutool.core.io.file.FileWrapper

cn.hutool.core.io.file.FileWriter

All Implemented Interfaces:

Serializable

public class FileWriter
extends FileWrapper

文件写入器

Author:

Looly

See Also:

Serialized Form

Field Summary

Fields inherited from class cn.hutool.core.io.file.FileWrapper

charset, DEFAULT_CHARSET, file

Constructor Summary

Constructors

Constructor and Description
FileWriter(File file) 构造 编码使用 FileWrapper.DEFAULT_CHARSET
FileWriter(File file, Charset charset) 构造
FileWriter(File file, String charset) 构造
FileWriter(String filePath) 构造 编码使用 FileWrapper.DEFAULT_CHARSET
FileWriter(String filePath, Charset charset) 构造
FileWriter(String filePath, String charset) 构造

Method Summary

Modifier and Type	Method and Description
File	append(byte[] data, int off, int len) 追加数据到文件
File	append(String content) 将String写入文件，追加模式
<T> File	appendLines(Iterable<T> list) 将列表写入文件，追加模式
static FileWriter	create(File file) 创建 FileWriter, 编码：FileWrapper.DEFAULT_CHARSET
static FileWriter	create(File file, Charset charset) 创建 FileWriter
BufferedOutputStream	getOutputStream() 获得一个输出流对象
PrintWriter	getPrintWriter(boolean isAppend) 获得一个打印写入对象，可以有print
BufferedWriter	getWriter(boolean isAppend) 获得一个带缓存的写入对象
File	write(byte[] data, int off, int len) 写入数据到文件
File	write(byte[] data, int off, int len, boolean isAppend) 写入数据到文件
File	write(String content) 将String写入文件，覆盖模式
File	write(String content, boolean isAppend) 将String写入文件
File	writeFromStream(InputStream in) 将流的内容写入文件 此方法会自动关闭输入流
File	writeFromStream(InputStream in, boolean isCloseIn) 将流的内容写入文件
<T> File	writeLines(Iterable<T> list) 将列表写入文件，覆盖模式
<T> File	writeLines(Iterable<T> list, boolean isAppend) 将列表写入文件
<T> File	writeLines(Iterable<T> list, LineSeparator lineSeparator, boolean isAppend) 将列表写入文件
File	writeMap(Map<?,?> map, LineSeparator lineSeparator, String kvSeparator, boolean isAppend) 将Map写入文件，每个键值对为一行，一行中键与值之间使用kvSeparator分隔
File	writeMap(Map<?,?> map, String kvSeparator, boolean isAppend) 将Map写入文件，每个键值对为一行，一行中键与值之间使用kvSeparator分隔

Methods inherited from class cn.hutool.core.io.file.FileWrapper

getCharset, getFile, readableFileSize, setCharset, setFile

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FileWriter

public FileWriter(File file,
                  Charset charset)

构造

Parameters:

file - 文件

charset - 编码，使用 CharsetUtil

FileWriter

public FileWriter(File file,
                  String charset)

构造

Parameters:

file - 文件

charset - 编码，使用 CharsetUtil.charset(String)

FileWriter

public FileWriter(String filePath,
                  Charset charset)

构造

Parameters:

filePath - 文件路径，相对路径会被转换为相对于ClassPath的路径

charset - 编码，使用 CharsetUtil

FileWriter

public FileWriter(String filePath,
                  String charset)

构造

Parameters:

filePath - 文件路径，相对路径会被转换为相对于ClassPath的路径

charset - 编码，使用 CharsetUtil.charset(String)

FileWriter

public FileWriter(File file)

构造
编码使用 FileWrapper.DEFAULT_CHARSET

Parameters:

file - 文件

FileWriter

public FileWriter(String filePath)

构造
编码使用 FileWrapper.DEFAULT_CHARSET

Parameters:

filePath - 文件路径，相对路径会被转换为相对于ClassPath的路径

Method Detail

create

public static FileWriter create(File file,
                                Charset charset)

创建 FileWriter

Parameters:

file - 文件

charset - 编码，使用 CharsetUtil

Returns:

FileWriter

create

public static FileWriter create(File file)

创建 FileWriter, 编码：FileWrapper.DEFAULT_CHARSET

Parameters:

file - 文件

Returns:

FileWriter

write

public File write(String content,
                  boolean isAppend)
           throws IORuntimeException

将String写入文件

Parameters:

content - 写入的内容

isAppend - 是否追加

Returns:

目标文件

Throws:

IORuntimeException - IO异常

write

public File write(String content)
           throws IORuntimeException

将String写入文件，覆盖模式

Parameters:

content - 写入的内容

Returns:

目标文件

Throws:

IORuntimeException - IO异常

append

public File append(String content)
            throws IORuntimeException

将String写入文件，追加模式

Parameters:

content - 写入的内容

Returns:

写入的文件

Throws:

IORuntimeException - IO异常

writeLines

public <T> File writeLines(Iterable<T> list)
                    throws IORuntimeException

将列表写入文件，覆盖模式

Type Parameters:

T - 集合元素类型

Parameters:

list - 列表

Returns:

目标文件

Throws:

IORuntimeException - IO异常

appendLines

public <T> File appendLines(Iterable<T> list)
                     throws IORuntimeException

将列表写入文件，追加模式

Type Parameters:

T - 集合元素类型

Parameters:

list - 列表

Returns:

目标文件

Throws:

IORuntimeException - IO异常

writeLines

public <T> File writeLines(Iterable<T> list,
                           boolean isAppend)
                    throws IORuntimeException

将列表写入文件

Type Parameters:

T - 集合元素类型

Parameters:

list - 列表

isAppend - 是否追加

Returns:

目标文件

Throws:

IORuntimeException - IO异常

writeLines

public <T> File writeLines(Iterable<T> list,
                           LineSeparator lineSeparator,
                           boolean isAppend)
                    throws IORuntimeException

将列表写入文件

Type Parameters:

T - 集合元素类型

Parameters:

list - 列表

lineSeparator - 换行符枚举（Windows、Mac或Linux换行符）

isAppend - 是否追加

Returns:

目标文件

Throws:

IORuntimeException - IO异常

Since:

3.1.0

writeMap

public File writeMap(Map<?,?> map,
                     String kvSeparator,
                     boolean isAppend)
              throws IORuntimeException

将Map写入文件，每个键值对为一行，一行中键与值之间使用kvSeparator分隔

Parameters:

map - Map

kvSeparator - 键和值之间的分隔符，如果传入null使用默认分隔符" = "

isAppend - 是否追加

Returns:

目标文件

Throws:

IORuntimeException - IO异常

Since:

4.0.5

writeMap

public File writeMap(Map<?,?> map,
                     LineSeparator lineSeparator,
                     String kvSeparator,
                     boolean isAppend)
              throws IORuntimeException

将Map写入文件，每个键值对为一行，一行中键与值之间使用kvSeparator分隔

Parameters:

map - Map

lineSeparator - 换行符枚举（Windows、Mac或Linux换行符）

kvSeparator - 键和值之间的分隔符，如果传入null使用默认分隔符" = "

isAppend - 是否追加

Returns:

目标文件

Throws:

IORuntimeException - IO异常

Since:

4.0.5

write

public File write(byte[] data,
                  int off,
                  int len)
           throws IORuntimeException

写入数据到文件

Parameters:

data - 数据

off - 数据开始位置

len - 数据长度

Returns:

目标文件

Throws:

IORuntimeException - IO异常

append

public File append(byte[] data,
                   int off,
                   int len)
            throws IORuntimeException

追加数据到文件

Parameters:

data - 数据

off - 数据开始位置

len - 数据长度

Returns:

目标文件

Throws:

IORuntimeException - IO异常

write

public File write(byte[] data,
                  int off,
                  int len,
                  boolean isAppend)
           throws IORuntimeException

写入数据到文件

Parameters:

data - 数据

off - 数据开始位置

len - 数据长度

isAppend - 是否追加模式

Returns:

目标文件

Throws:

IORuntimeException - IO异常

writeFromStream

public File writeFromStream(InputStream in)
                     throws IORuntimeException

将流的内容写入文件
此方法会自动关闭输入流

Parameters:

in - 输入流，不关闭

Returns:

dest

Throws:

IORuntimeException - IO异常

writeFromStream

public File writeFromStream(InputStream in,
                            boolean isCloseIn)
                     throws IORuntimeException

将流的内容写入文件

Parameters:

in - 输入流，不关闭

isCloseIn - 是否关闭输入流

Returns:

dest

Throws:

IORuntimeException - IO异常

Since:

5.5.2

getOutputStream

public BufferedOutputStream getOutputStream()
                                     throws IORuntimeException

获得一个输出流对象

Returns:

输出流对象

Throws:

IORuntimeException - IO异常

getWriter

public BufferedWriter getWriter(boolean isAppend)
                         throws IORuntimeException

获得一个带缓存的写入对象

Parameters:

isAppend - 是否追加

Returns:

BufferedReader对象

Throws:

IORuntimeException - IO异常

getPrintWriter

public PrintWriter getPrintWriter(boolean isAppend)
                           throws IORuntimeException

获得一个打印写入对象，可以有print

Parameters:

isAppend - 是否追加

Returns:

打印对象

Throws:

IORuntimeException - IO异常