Класс FilterWriter

java.lang.Object

java.io.Writer

java.io.FilterWriter

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

public abstract class FilterWriter extends Writer

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

Начиная с:: 1.1

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

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

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

lock

Модификатор и тип	Поле	Описание
`protected Object`	`lock`	Объект, используемый для синхронизации операций с этим потоком.

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

FilterWriter(Writer out)

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

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

Модификатор и тип	Метод	Описание
`void`	`close()`	Закрывает поток, предварительно сбросив его буфер.
`void`	`flush()`	Сбрасывает буфер потока.
`void`	`write(char[] cbuf, int off, int len)`	Записывает часть массива символов.
`void`	`write(int c)`	Записывает один символ.
`void`	`write(String str, int off, int len)`	Записывает часть строки.

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

append, append, append, nullWriter, write, write

Модификатор и тип	Метод	Описание
`Writer`	`append(char c)`	Добавляет указанный символ в этот писатель.
`Writer`	`append(CharSequence csq)`	Добавляет указанную последовательность символов в этот писатель.
`Writer`	`append(CharSequence csq, int start, int end)`	Добавляет подстроку указанной последовательности символов в этот писатель.
`static Writer`	`nullWriter()`	Возвращает новый `Writer`, отбрасывающий все символы.
`void`	`write(char[] cbuf)`	Записывает массив символов.
`void`	`write(String str)`	Записывает строку.

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

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

Модификатор и тип	Метод	Описание
`protected Object`	`clone()`	Создаёт и возвращает копию этого объекта.
`boolean`	`equals(Object obj)`	Показывает, равен ли какой-либо другой объект этому объекту.
`protected void`	`finalize()`	Устарело, будет удалено: этот элемент API может быть удалён в будущей версии. Финализация объявлена устаревшей и может быть удалена в одном из будущих выпусков.
`final Class<?>`	`getClass()`	Возвращает класс времени выполнения этого `Object`.
`int`	`hashCode()`	Возвращает хеш-код этого объекта.
`final void`	`notify()`	Пробуждает один поток, ожидающий на мониторе этого объекта.
`final void`	`notifyAll()`	Пробуждает все потоки, ожидающие на мониторе этого объекта.
`String`	`toString()`	Возвращает строковое представление объекта.
`final void`	`wait()`	Заставляет текущий поток ожидать пробуждения, обычно в результате вызова notify или interrupt.
`final void`	`wait(long timeoutMillis)`	Заставляет текущий поток ожидать пробуждения, обычно в результате вызова notify или interrupt, либо истечения заданного времени.
`final void`	`wait(long timeoutMillis, int nanos)`	Заставляет текущий поток ожидать пробуждения, обычно в результате вызова notify или interrupt, либо истечения заданного времени.

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

out

protected Writer out

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

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

FilterWriter

protected FilterWriter(Writer out)

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

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

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

write

public void write(int c) throws IOException

Записывает один символ.

Переопределяет:: write в классе Writer
Параметры:: c — int, указывающий символ для записи
Исключения:: IOException — если возникает ошибка ввода-вывода

write

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

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

Определено в:: write в классе Writer
Параметры:: cbuf — буфер с символами для записи; off — смещение, с которого начинается чтение символов; len — количество символов для записи
Исключения:: IndexOutOfBoundsException — если значения параметров off и len приводят к тому, что соответствующий метод базового Writer выбрасывает IndexOutOfBoundsException; IOException — если возникает ошибка ввода-вывода

write

public void write(String str, int off, int len) throws IOException

Записывает часть строки.

Переопределяет:: write в классе Writer
Параметры:: str — строка для записи; off — смещение, с которого начинается чтение символов; len — количество символов для записи
Исключения:: IndexOutOfBoundsException — если значения параметров off и len приводят к тому, что соответствующий метод базового Writer выбрасывает IndexOutOfBoundsException; IOException — если возникает ошибка ввода-вывода

flush

public void flush() throws IOException

Сбрасывает буфер потока.

Определено в:: flush в интерфейсе Flushable
Определено в:: flush в классе Writer
Исключения:: IOException — если возникает ошибка ввода-вывода

close

public void close() throws IOException

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

Закрывает поток, предварительно сбросив его буфер. После закрытия потока дальнейшие вызовы write() или flush() приведут к выбрасыванию IOException. Закрытие уже закрытого потока не оказывает никакого эффекта.

Определено в:: close в интерфейсе AutoCloseable
Определено в:: close в интерфейсе Closeable
Определено в:: close в классе Writer
Исключения:: 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.