Класс BufferedReader

java.lang.Object

java.io.Reader

java.io.BufferedReader

Все реализованные интерфейсы:: Closeable, AutoCloseable, Readable

Прямые известные подклассы:: LineNumberReader

public class BufferedReader extends Reader

Читает текст из потока символьного ввода, буферизуя символы, чтобы обеспечить эффективный считывание символов, массивов и строк.

Размер буфера может быть указан или может быть использован размер по умолчанию. По умолчанию он достаточно большой для большинства целей.

В общем случае каждый запрос на чтение, сделанный Reader, вызывает соответствующий запрос на чтение в базовом потоке символов или байтов. Поэтому рекомендуется обернуть BufferedReader вокруг любого Reader, чьи операции read() могут быть дорогостоящими, такие как FileReader и InputStreamReader. Например,

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

будет буферизовать вход из указанного файла. Без буферизации каждый вызов read() или readLine() мог бы привести к чтению байтов из файла, преобразованию их в символы и возвращению, что может быть очень неэффективным.

Программы, которые используют DataInputStream для текстового ввода, могут быть локализованы путем замены каждого DataInputStream соответствующим BufferedReader.

С момента:

1.1

См. также:

Краткое описание полей

Поля, объявленные в классе java.io.Reader

lock

Краткое описание конструкторов

Конструктор	Описание
`BufferedReader(Reader in)`	Создает буферизованный поток символьного ввода, использующий буфер ввода по умолчанию.
`BufferedReader(Reader in, int sz)`	Создает буферизованный поток символьного ввода, использующий буфер ввода заданного размера.

Краткое описание методов

Модификатор и тип	Метод	Описание
`void`	`close()`	Закрывает поток и освобождает все системные ресурсы, связанные с ним.
`Stream<String>`	`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()`	Возвращает поток в последнее отмеченное положение.

Методы, объявленные в классе java.io.Reader

nullReader, read, read, skip, transferTo

Методы, объявленные в классе java.lang.Object

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

Подробное описание конструкторов

BufferedReader

public BufferedReader(Reader in, int sz)

Создаёт буферизованный поток символьного ввода, использующий буфер ввода заданного размера.

Параметры:: in - Поток ввода; sz - Размер буфера ввода
Исключения:: IllegalArgumentException - Если sz <= 0

BufferedReader

public BufferedReader(Reader in)

Создаёт буферизованный поток символьного ввода, использующий буфер ввода стандартного размера.

Параметры:: in - Поток ввода

Подробное описание методов

read

public int read() throws IOException

Читает один символ.

Переопределяет:: read в классе Reader
Возвращает:: Прочитанный символ, как целое число в диапазоне от 0 до 65535 (0x00-0xffff), или -1, если достигнут конец потока
Исключения:: IOException - Если произошла ошибка ввода-вывода

read

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

Читает символы в часть массива.

Этот метод реализует общий контракт соответствующего метода read класса Reader. В качестве дополнительного удобства он пытается прочитать как можно больше символов, многократно вызывая метод read базового потока. Это итерационное read продолжается до тех пор, пока не выполнится одно из следующих условий:

Прочитано указанное количество символов,
Метод read базового потока возвращает -1, указывая на конец файла, или
Метод ready базового потока возвращает false, указывая, что дальнейшие запросы ввода заблокированы.

Если первый вызов read на базовом потоке возвращает -1 для обозначения конца файла, этот метод возвращает -1. В противном случае этот метод возвращает количество фактически прочитанных символов.

Подклассы этого класса рекомендуются, но не обязательны, для попытки прочитать как можно больше символов таким же способом.

Обычно этот метод берет символы из буфера символов этого потока, заполняя его из базового потока по мере необходимости. Однако, если буфер пуст, метка недействительна, и запрошенный размер по крайней мере равен размеру буфера, то этот метод будет читать символы непосредственно из базового потока в заданный массив. Таким образом, избыточные BufferedReader не будут излишне копировать данные.

Определено в:: read в классе Reader
Параметры:: cbuf - Буфер назначения; off - Смещение, с которого начинать хранение символов; len - Максимальное количество символов для чтения
Возвращает:: Количество прочитанных символов, или -1, если достигнут конец потока
Исключения:: IndexOutOfBoundsException - Если off отрицательное, или len отрицательное, или len больше cbuf.length - off; IOException - Если произошла ошибка ввода-вывода

readLine

public String readLine() throws IOException

Читает строку текста. Строка считается завершенной любым из символов перевода строки ('\n'), возврата каретки ('\r'), возвратом каретки, сразу за которым следует перевод строки, или по достижении конца файла (EOF).

Возвращает:

Строка, содержащая содержимое строки, не включая символы завершения строки, или null, если достигнут конец потока без чтения каких-либо символов

Исключения:

IOException - Если произошла ошибка ввода-вывода

См. также:

Files.readAllLines(java.nio.file.Path, java.nio.charset.Charset)

ready

public boolean ready() throws IOException

Определяет, готов ли этот поток к чтению. Буферизованный поток символов готов, если буфер не пуст или если базовый поток символов готов.

Переопределяет:: ready в классе Reader
Возвращает:: True, если следующее чтение гарантированно не заблокируется для ввода, false в противном случае. Обратите внимание, что возвращение false не гарантирует, что следующее чтение заблокируется.
Исключения:: IOException - Если произошла ошибка ввода-вывода

markSupported

public boolean markSupported()

Указывает, поддерживает ли этот поток операцию mark(), которую он поддерживает.

Переопределяет:: markSupported в классе Reader
Возвращает:: true тогда и только тогда, когда этот поток поддерживает операцию mark.

mark

public void mark(int readAheadLimit) throws IOException

Помечает текущую позицию в потоке. Последующие вызовы reset() будут пытаться переместить поток в эту точку.

Переопределяет:: mark в классе Reader
Параметры:: readAheadLimit - Предел количества символов, которые могут быть прочитаны, сохраняя при этом метку. Попытка сбросить поток после чтения символов до этого предела или дальше может завершиться неудачей. Значение предела, большее размера буфера ввода, приведет к выделению нового буфера, размер которого не меньше limit. Поэтому следует с осторожностью использовать большие значения.
Исключения:: IllegalArgumentException - Если readAheadLimit < 0; IOException - Если произошла ошибка ввода-вывода

reset

public void reset() throws IOException

Сбрасывает поток до последней метки.

Переопределяет:: reset в классе Reader
Исключения:: IOException - Если поток никогда не помечался или метка была аннулирована

close

public void close() throws IOException

Описание скопировано из класса: Reader

Закрывает поток и освобождает все системные ресурсы, связанные с ним. После закрытия потока дальнейшие вызовы read(), ready(), mark(), reset() или skip() будут генерировать исключение IOException. Закрытие уже закрытого потока не имеет эффекта.

Определено в:: close в интерфейсе AutoCloseable
Определено в:: close в интерфейсе Closeable
Определено в:: close в классе Reader
Исключения:: IOException - Если произошла ошибка ввода-вывода

lines

public Stream<String> lines()

Возвращает Stream, элементы которого представляют собой строки, считанные из этого BufferedReader. Поток Stream заполняется лениво, т.е. чтение происходит только во время терминальной операции потока Stream.

Нельзя осуществлять операции над потоком ввода во время выполнения терминальной операции потока. В противном случае результат терминальной операции потока неопределён.

После выполнения терминальной операции потока нет гарантий, что поток ввода будет находиться в определённой позиции для чтения следующего символа или строки.

Если при доступе к базовому BufferedReader возникает исключение IOException, оно оборачивается в UncheckedIOException, которое будет сгенерировано методом Stream вызвавшим чтение. Этот метод вернёт поток, если вызван на закрытом BufferedReader. Любая операция над этим потоком, требующая чтения из BufferedReader после его закрытия, приведёт к генерации UncheckedIOException.

Возвращает:: Stream<String> предоставляющий строки текста, описанные этим BufferedReader
С тех пор как:: 1.8

© 1993, 2021, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/BufferedReader.html