Класс 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

Модификатор и тип	Метод	Описание
`static OutputStream`	`nullOutputStream()`	Возвращает новый `OutputStream`, отбрасывающий все байты.

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