Класс 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 класса FilterOutputStream вызывает свой метод write с тремя аргументами, используя аргументы b, 0, и b.length.

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

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

write в классе OutputStream

Параметры:

b - данные, подлежащие записи.

Исключения:

IOException - если происходит ошибка ввода-вывода.

См. также:

write(byte[], int, int)

write

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

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

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

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

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

write в классе OutputStream

Параметры:

b - данные.

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

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

Исключения:

IOException - если происходит ошибка ввода-вывода.

См. также:

write(int)

flush

public void flush() throws IOException

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

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

Унаследованный от:

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

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

flush в классе OutputStream

Исключения:

IOException - если происходит ошибка ввода-вывода.

См. также:

out

close

public void close() throws IOException

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

Когда поток ещё не закрыт, метод close класса FilterOutputStream вызывает свой метод flush, а затем вызывает метод close своего основного потока вывода.

Унаследованный от:

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

Унаследованный от:

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

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

close в классе OutputStream

Исключения:

IOException - если происходит ошибка ввода-вывода.

См. также:

flush()
out

© 1993, 2021, 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/17/docs/api/java.base/java/io/FilterOutputStream.html