Класс 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, 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's метод skip выбрасывает IllegalArgumentException для отрицательного параметра; IOException - Если произошла ошибка ввода-вывода

ready

public boolean ready() throws IOException

Указывает, готов ли этот поток к чтению.

Переопределяет:: ready в классе Reader
Возвращает:: Истина, если следующий вызов read() гарантированно не будет блокироваться для ввода, ложь в противном случае. Обратите внимание, что возвращение ложности не гарантирует, что следующий вызов 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, 2023, 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/21/docs/api/java.base/java/io/FilterReader.html