Класс FilterOutputStream

java.lang.Object

java.io.OutputStream

java.io.FilterOutputStream

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

Прямые известные подклассы:: BufferedOutputStream, CheckedOutputStream, CipherOutputStream, DataOutputStream, DeflaterOutputStream, DigestOutputStream, InflaterOutputStream, PrintStream

public class FilterOutputStream extends OutputStream

Этот класс является суперклассом всех классов, которые фильтруют выходные потоки. Такие потоки располагаются поверх уже существующего выходного потока ( базового выходного потока), который используется как основной приемник данных, при этом данные могут преобразовываться в процессе передачи или предоставляться дополнительные возможности.

Сам класс FilterOutputStream просто переопределяет все методы OutputStream версиями, которые передают все запросы базовому выходному потоку. Подклассы FilterOutputStream могут дополнительно переопределять некоторые из этих методов, а также предоставлять дополнительные методы и поля.

Начиная с:: 1.0

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

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

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

Конструктор	Описание
`FilterOutputStream(OutputStream out)`	Создает фильтр выходного потока на основе указанного базового выходного потока.

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

Модификатор и тип	Метод	Описание
`void`	`close()`	Закрывает этот выходной поток и освобождает все системные ресурсы, связанные с ним.
`void`	`flush()`	Сбрасывает этот выходной поток и принудительно записывает все буферизованные выходные байты в поток.
`void`	`write(byte[] b)`	Записывает байты `b.length` в этот выходной поток.
`void`	`write(byte[] b, int off, int len)`	Записывает байты `len` из указанного массива `byte`, начиная со смещения `off`, в этот выходной поток.
`void`	`write(int b)`	Записывает указанный `byte` в этот выходной поток.

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

nullOutputStream

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

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

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

out

protected OutputStream out

Базовый выходной поток, который необходимо фильтровать.

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

FilterOutputStream

public FilterOutputStream(OutputStream out)

Создает фильтр выходного потока на основе указанного базового выходного потока.

Параметры:: out — базовый выходной поток, который будет присвоен полю this.out для последующего использования, или null, если этот экземпляр создается без базового потока.

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

write

public void write(int b) throws IOException

Записывает указанный byte в этот выходной поток.

Метод write класса FilterOutputStream вызывает метод write базового выходного потока, то есть выполняет out.write(b).

Реализует абстрактный метод write класса OutputStream.

Определено в:: write в классе OutputStream
Параметры:: b — byte.
Исключения:: IOException — если возникает ошибка ввода-вывода.

write

public void write(byte[] b) throws IOException

Записывает байты b.length в этот выходной поток.

Переопределяет:

write в классе OutputStream

Требования к реализации:

Метод write класса FilterOutputStream вызывает свой метод write с тремя аргументами: b, 0 и b.length.

Примечание по реализации:

Обратите внимание, что этот метод не вызывает однопараметрический метод write базового выходного потока с единственным аргументом b.

Параметры:

b — записываемые данные.

Исключения:

IOException — если возникает ошибка ввода-вывода.

См. также:

write

public void write(byte[] b, int off, int len) throws IOException

Записывает байты len из указанного массива byte, начиная со смещения off, в этот выходной поток.

Переопределяет:

write в классе OutputStream

Требования к реализации:

Метод write класса FilterOutputStream вызывает однопараметрический метод write для каждого byte, подлежащего выводу.

Примечание по реализации:

Обратите внимание, что этот метод не вызывает метод write базового выходного потока с теми же аргументами. Подклассам FilterOutputStream следует предоставлять более эффективную реализацию этого метода.

Параметры:

b — данные.

off — начальное смещение в данных.

len — количество байтов для записи.

Исключения:

IOException — если возникает ошибка ввода-вывода.

IndexOutOfBoundsException — если off отрицательно, len отрицательно или len больше, чем b.length - off

См. также:

flush

public void flush() throws IOException

Сбрасывает этот выходной поток и принудительно записывает все буферизованные выходные байты в поток.

Определено в:

flush в интерфейсе Flushable

Переопределяет:

flush в классе OutputStream

Требования к реализации:

Метод flush класса FilterOutputStream вызывает метод flush базового выходного потока.

Исключения:

IOException — если возникает ошибка ввода-вывода.

См. также:

close

public void close() throws IOException

Закрывает этот выходной поток и освобождает все системные ресурсы, связанные с ним.

Определено в:

close в интерфейсе AutoCloseable

Определено в:

close в интерфейсе Closeable

Переопределяет:

close в классе OutputStream

Требования к реализации:

Если поток еще не закрыт, метод close класса


FilterOutputStream

вызывает свой метод flush, а затем вызывает метод close базового выходного потока.

Исключения:

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/FilterOutputStream.html