鸿蒙OS BufferedReader

BufferedReader

java.lang.Object

|---java.io.Reader

|---|---java.io.BufferedReader

public class BufferedReader
extends Reader

从字符输入流中读取文本，缓冲字符，以便高效读取字符、数组和行。

可以指定缓冲区大小，也可以使用默认大小。 对于大多数用途，默认值足够大。

通常，由 Reader 发出的每个读取请求都会导致对底层字符或字节流发出相应的读取请求。 因此，建议将 BufferedReader 包装在 read() 操作可能成本高昂的任何 Reader 周围，例如 FileReaders 和 InputStreamReaders。 例如，

 BufferedReader in
   = new BufferedReader(new FileReader("foo.in"));

将缓冲来自指定文件的输入。 如果没有缓冲，每次调用 read() 或 readLine() 都可能导致从文件中读取字节，转换为字符，然后返回，这可能非常低效。

使用 DataInputStreams 进行文本输入的程序可以通过将每个 DataInputStream 替换为适当的 BufferedReader 来本地化。

Since:

JDK1.1

字段摘要

从类 java.io.Reader 继承的字段
lock

构造函数摘要

构造函数	描述
BufferedReader(Reader in)	创建一个使用默认大小的输入缓冲区的缓冲字符输入流。
BufferedReader(Reader in, int sz)	创建一个使用指定大小的输入缓冲区的缓冲字符输入流。

方法总结

修饰符和类型	方法	描述
void	close()	关闭流并释放与其关联的任何系统资源。
StreamString	lines()	返回一个 Stream，其元素是从此 BufferedReader 读取的行。
void	mark(int readAheadLimit)	标记流中的当前位置。
boolean	markSupported()	告诉这个流是否支持 mark() 操作，它支持。
int	read()	读取单个字符。
int	read(char[] cbuf, int off, int len)	将字符读入数组的一部分。
String	readLine()	读取一行文本。
boolean	ready()	告诉这个流是否准备好被读取。
void	reset()	将流重置为最新标记。
long	skip(long n)	跳过字符。

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

从类 java.io.Reader 继承的方法
read, read

构造函数详细信息

BufferedReader

public BufferedReader(Reader in, int sz)

创建一个使用指定大小的输入缓冲区的缓冲字符输入流。

参数：

参数名称	参数描述
in	输入流
sz	输入缓冲区大小

Throws:

Throw名称	Throw描述
IllegalArgumentException	如果 sz <= 0

BufferedReader

public BufferedReader(Reader in)

创建一个使用默认大小的输入缓冲区的缓冲字符输入流。

参数：

参数名称	参数描述
in	输入流

方法详情

read

public int read() throws IOException

读取单个字符。

覆盖：

在类输入流中读取

返回:

读取的字符，为 0 到 65535 (0x00-0xffff) 范围内的整数，如果已到达流的末尾，则为 -1

Throws:

Throw名称	Throw描述
IOException	如果发生 I/O 错误

read

public int read(char[] cbuf, int off, int len) throws IOException

将字符读入数组的一部分。

该方法实现了 Reader 类对应的 [Reader#read(char], int, int) 方法的通用约定。 作为额外的便利，它尝试通过重复调用底层流的读取方法来读取尽可能多的字符。 此迭代读取将继续，直到满足以下条件之一：

• 已读取指定数量的字符，
• 底层流的read方法返回-1，表示文件结束，或者
• 底层流的 ready 方法返回 false，表示进一步的输入请求会阻塞。

如果对底层流的第一次读取返回 -1 以指示文件结束，则此方法返回 -1。 否则，此方法返回实际读取的字符数。

鼓励但不要求此类的子类尝试以相同的方式读取尽可能多的字符。

通常，此方法从该流的字符缓冲区中获取字符，并根据需要从底层流中填充它。 但是，如果缓冲区为空，标记无效，并且请求的长度至少与缓冲区一样大，则此方法将直接从底层流中读取字符到给定数组中。 因此冗余的 BufferedReader 不会不必要地复制数据。

指定者：

在类读取流中阅读

参数：

参数名称	参数描述
cbuf	目标缓冲区
off	开始存储字符的偏移量
len	要读取的最大字符数

返回:

读取的字符数，如果已到达流的末尾，则为 -1

Throws:

Throw名称	Throw描述
IOException	如果发生 I/O 错误

readLine

public String readLine() throws IOException

读取一行文本。 一行被认为是由换行符 ('n')、回车符 ('r') 或紧跟换行符的回车符中的任何一个终止的。

返回:

包含行内容的字符串，不包括任何行终止字符，如果已到达流的末尾，则为 null

Throws:

Throw名称	Throw描述
IOException	如果发生 I/O 错误

skip

public long skip(long n) throws IOException

跳过字符。

覆盖：

skip 类输入流

参数：

参数名称	参数描述
n	要跳过的字符数

返回:

实际跳过的字符数

Throws:

Throw名称	Throw描述
IllegalArgumentException	如果 n 为负数。
IOException	如果发生 I/O 错误

ready

public boolean ready() throws IOException

告诉这个流是否准备好被读取。 如果缓冲区不为空，或者底层字符流已准备好，则缓冲字符流已准备好。

覆盖：

准备好类输入流

返回:

如果保证下一个 read() 不会阻塞输入，则为 true，否则为 false。 请注意，返回 false 并不能保证下一次读取将阻塞。

Throws:

Throw名称	Throw描述
IOException	如果发生 I/O 错误

markSupported

public boolean markSupported()

告诉这个流是否支持 mark() 操作，它支持。

覆盖：

在阅读器类中标记支持

返回:

当且仅当此流支持标记操作时才为 true。

mark

public void mark(int readAheadLimit) throws IOException

标记流中的当前位置。 对 reset() 的后续调用将尝试将流重新定位到该点。

覆盖：

在类输入流中标记

参数：

参数名称	参数描述
readAheadLimit	在保留标记的同时限制可以读取的字符数。 在读取达到此限制或超过此限制的字符后尝试重置流可能会失败。 大于输入缓冲区大小的限制值将导致分配一个大小不小于限制的新缓冲区。 因此，应谨慎使用较大的值。

Throws:

Throw名称	Throw描述
IllegalArgumentException	如果 readAheadLimit < 0
IOException	如果发生 I/O 错误

reset

public void reset() throws IOException

将流重置为最新标记。

覆盖：

在输入流类中重置

Throws:

Throw名称	Throw描述
IOException	如果流从未被标记，或者标记已失效

close

public void close() throws IOException

从班级复制的描述：读者

关闭流并释放与其关联的任何系统资源。 关闭流后，进一步的 read()、ready()、mark()、reset() 或 skip() 调用将引发 IOException。 关闭以前关闭的流没有效果。

指定者：

在接口 AutoCloseable 中关闭

指定者：

在接口Closeable中关闭

指定者：

关闭类输入流

Throws:

Throw名称	Throw描述
IOException	如果发生 I/O 错误

lines

public StreamString lines()

返回一个 Stream，其元素是从此 BufferedReader 读取的行。 Stream 是惰性填充的，即在终端流操作期间只读发生。

终端流操作执行过程中不得对阅读器进行操作。否则，终端流操作的结果是不确定的。

执行终端流操作后，不能保证阅读器将处于读取下一个字符或行的特定位置。

如果在访问底层 BufferedReader 时抛出 IOException，它将被包装在 UncheckedIOException 中，该异常将从导致读取发生的 Stream 方法中抛出。如果在关闭的 BufferedReader 上调用此方法，将返回一个 Stream。该流上的任何需要在关闭后从 BufferedReader 读取的操作都将导致抛出 UncheckedIOException。

返回：

提供此 BufferedReader 描述的文本行的 Stream<String>

Since:

1.8