Класс 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 могут дополнительно переопределить некоторые из этих методов, а также предоставить дополнительные методы и поля.

С тех пор:: JDK1.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.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 в интерфейсе Closeable
Унаследованно от:: close в интерфейсе AutoCloseable
Переопределяет:: 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.