Класс 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` в этот поток вывода.

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

nullOutputStream

Методы, объявленные в классе java.lang.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, 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/FilterOutputStream.html