Класс FilterOutputStream

Все реализованные интерфейсы:
Closeable, Flushable, AutoCloseable
Прямые известные подклассы:
BufferedOutputStream, CheckedOutputStream, CipherOutputStream, DataOutputStream, DeflaterOutputStream, DigestOutputStream, InflaterOutputStream, PrintStream
public class FilterOutputStream
extends OutputStream

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

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

С момента:
1.0

Поля

Модификатор и типПолеОписание
protected OutputStreamout

Основной поток вывода для фильтрации.

Конструкторы

КонструкторОписание
FilterOutputStream​(OutputStream out)

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

Методы

Модификатор и типМетодОписание
voidclose()

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

voidflush()

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

voidwrite​(byte[] b)

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

voidwrite​(byte[] b, int off, int len)

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

voidwrite​(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, 2020, 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/11/docs/api/java.base/java/io/FilterOutputStream.html

Spec-Zone .ru
спецификации, руководства, описания, API