Класс 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`	Основной поток ввода символов.

Объявленные поля в классе java.io.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)`	Пропускает символы.

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

nullReader, of, read, read, transferTo

Объявленные методы в классе java.lang.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 отрицательно и метод Reader содержащего потока skip выбрасывает 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://download.java.net/java/early_access/jdk24/docs/api/java.base/java/io/FilterReader.html