Класс FilterReader

java.lang.Object

java.io.Reader

java.io.FilterReader

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

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

public abstract class FilterReader extends Reader

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

Начиная с:: 1.1

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

Модификатор и тип	Поле	Описание
`protected Reader`	`in`	Базовый символьный поток ввода.

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

lock

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

FilterReader(Reader in)

Модификатор	Конструктор	Описание
`protected`	Создаёт новый фильтруемый поток чтения.

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

Модификатор и тип	Метод	Описание
`void`	`close()`	Закрывает поток и освобождает все связанные с ним системные ресурсы.
`void`	`mark(int readAheadLimit)`	Помечает текущую позицию в потоке.
`boolean`	`markSupported()`	Сообщает, поддерживает ли этот поток операцию mark().
`int`	`read()`	Читает один символ.
`int`	`read(char[] cbuf, int off, int len)`	Читает символы в часть массива.
`boolean`	`ready()`	Сообщает, готов ли этот поток к чтению.
`void`	`reset()`	Сбрасывает поток.
`long`	`skip(long n)`	Пропускает символы.

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

nullReader, of, read, read, readAllAsString, readAllLines, transferTo

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

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

Подробное описание полей

in

protected Reader in

Базовый символьный поток ввода.

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

FilterReader

protected FilterReader(Reader in)

Создаёт новый фильтруемый поток чтения.

Параметры:: in — объект Reader, предоставляющий базовый поток.
Вызывает исключение:: NullPointerException — если in имеет значение null

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

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

Читает символы в часть массива. Этот метод блокирует выполнение, пока не станут доступны входные данные, не произойдёт ошибка ввода-вывода или не будет достигнут конец потока.

Если len равно нулю, символы не читаются и возвращается 0; в противном случае предпринимается попытка прочитать хотя бы один символ. Если символы недоступны, поскольку достигнут конец потока, возвращается значение -1; в противном случае считывается и сохраняется в cbuf как минимум один символ.

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

skip

public long skip(long n) throws IOException

Пропускает символы. Этот метод блокирует выполнение, пока не станут доступны символы, не произойдёт ошибка ввода-вывода или не будет достигнут конец потока. Если до вызова этого метода поток уже достиг конца, символы не пропускаются и возвращается ноль.

Переопределяет:: skip в классе Reader
Параметры:: n — количество символов для пропуска
Возвращает:: Фактическое количество пропущенных символов
Вызывает исключение:: IllegalArgumentException — если n отрицательно, а метод skip содержащегося в потоке Reader выбрасывает IllegalArgumentException для отрицательного параметра; 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

Помечает текущую позицию в потоке.

Переопределяет:: mark в классе Reader
Параметры:: readAheadLimit — ограничение на количество символов, которые можно прочитать с сохранением метки. После чтения этого количества символов попытка сбросить поток может завершиться неудачей.
Вызывает исключение:: 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 — если происходит ошибка ввода-вывода

© 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://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/io/FilterReader.html