Класс 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.

Примечание API:

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

С:

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, of, 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 - Если произошла ошибка ввода-вывода

См. также:

ready

public boolean ready() throws IOException

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

Переопределяет:: ready в классе Reader
Возвращает:: true, если следующий вызов read() гарантированно не заблокирует ожидая ввода, false в противном случае. Обратите внимание, что возвращение false не гарантирует, что следующий вызов read() заблокируется.
Исключения:: 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 заполняется лениво, т.е. чтение происходит только во время выполнения конечной операции потока конечной операции потока.

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

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

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

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

© 1993, 2025, 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://download.java.net/java/early_access/jdk24/docs/api/java.base/java/io/BufferedReader.html