cn.hutool.core.io.file

Class FileReader

java.lang.Object

cn.hutool.core.io.file.FileWrapper

cn.hutool.core.io.file.FileReader

All Implemented Interfaces:

Serializable

public class FileReader
extends FileWrapper

文件读取器

Author:

Looly

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	FileReader.ReaderHandler<T> Reader处理接口

Field Summary

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

charset, DEFAULT_CHARSET, file

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static FileReader	create(File file) 创建 FileReader, 编码：FileWrapper.DEFAULT_CHARSET
static FileReader	create(File file, Charset charset) 创建 FileReader
BufferedInputStream	getInputStream() 获得输入流
BufferedReader	getReader() 获得一个文件读取器
<T> T	read(FileReader.ReaderHandler<T> readerHandler) 按照给定的readerHandler读取文件中的数据
byte[]	readBytes() 读取文件所有数据 文件的长度不能超过 Integer.MAX_VALUE
List<String>	readLines() 从文件中读取每一行数据
void	readLines(LineHandler lineHandler) 按照行处理文件内容
<T extends Collection<String>> T	readLines(T collection) 从文件中读取每一行数据
String	readString() 读取文件内容
long	writeToStream(OutputStream out) 将文件写入流中，此方法不会关闭比输出流
long	writeToStream(OutputStream out, boolean isCloseOut) 将文件写入流中

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

FileReader

public FileReader(File file,
                  Charset charset)

构造

Parameters:

file - 文件

charset - 编码，使用 CharsetUtil

FileReader

public FileReader(File file,
                  String charset)

构造

Parameters:

file - 文件

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

FileReader

public FileReader(String filePath,
                  Charset charset)

构造

Parameters:

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

charset - 编码，使用 CharsetUtil

FileReader

public FileReader(String filePath,
                  String charset)

构造

Parameters:

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

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

FileReader

public FileReader(File file)

构造
编码使用 FileWrapper.DEFAULT_CHARSET

Parameters:

file - 文件

FileReader

public FileReader(String filePath)

构造
编码使用 FileWrapper.DEFAULT_CHARSET

Parameters:

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

Method Detail

create

public static FileReader create(File file,
                                Charset charset)

创建 FileReader

Parameters:

file - 文件

charset - 编码，使用 CharsetUtil

Returns:

FileReader

create

public static FileReader create(File file)

创建 FileReader, 编码：FileWrapper.DEFAULT_CHARSET

Parameters:

file - 文件

Returns:

FileReader

readBytes

public byte[] readBytes()
                 throws IORuntimeException

读取文件所有数据
文件的长度不能超过 Integer.MAX_VALUE

Returns:

字节码

Throws:

IORuntimeException - IO异常

readString

public String readString()
                  throws IORuntimeException

读取文件内容

Returns:

内容

Throws:

IORuntimeException - IO异常

readLines

public <T extends Collection<String>> T readLines(T collection)
                                           throws IORuntimeException

从文件中读取每一行数据

Type Parameters:

T - 集合类型

Parameters:

collection - 集合

Returns:

文件中的每行内容的集合

Throws:

IORuntimeException - IO异常

readLines

public void readLines(LineHandler lineHandler)
               throws IORuntimeException

按照行处理文件内容

Parameters:

lineHandler - 行处理器

Throws:

IORuntimeException - IO异常

Since:

3.0.9

readLines

public List<String> readLines()
                       throws IORuntimeException

从文件中读取每一行数据

Returns:

文件中的每行内容的集合

Throws:

IORuntimeException - IO异常

read

public <T> T read(FileReader.ReaderHandler<T> readerHandler)
           throws IORuntimeException

按照给定的readerHandler读取文件中的数据

Type Parameters:

T - 读取的结果对象类型

Parameters:

readerHandler - Reader处理类

Returns:

从文件中read出的数据

Throws:

IORuntimeException - IO异常

getReader

public BufferedReader getReader()
                         throws IORuntimeException

获得一个文件读取器

Returns:

BufferedReader对象

Throws:

IORuntimeException - IO异常

getInputStream

public BufferedInputStream getInputStream()
                                   throws IORuntimeException

获得输入流

Returns:

输入流

Throws:

IORuntimeException - IO异常

writeToStream

public long writeToStream(OutputStream out)
                   throws IORuntimeException

将文件写入流中，此方法不会关闭比输出流

Parameters:

out - 流

Returns:

写出的流byte数

Throws:

IORuntimeException - IO异常

writeToStream

public long writeToStream(OutputStream out,
                          boolean isCloseOut)
                   throws IORuntimeException

将文件写入流中

Parameters:

out - 流

isCloseOut - 是否关闭输出流

Returns:

写出的流byte数

Throws:

IORuntimeException - IO异常

Since:

5.5.2