Класс GZIPOutputStream

java.util.zip.GZIPOutputStream

Все реализуемые интерфейсы:: Closeable, Flushable, AutoCloseable

public class GZIPOutputStream extends DeflaterOutputStream

Этот класс реализует фильтр потока для записи сжатых данных в формате файла GZIP.

Если не указано иное, передача аргумента null конструктору или методу этого класса приведёт к выбрасыванию NullPointerException.

Начиная с версии:: 1.1

Краткое описание полей

Модификатор и тип	Поле	Описание
`protected CRC32`	`crc`	CRC-32 несжатых данных.

Поля, объявленные в классе DeflaterOutputStream

buf, def

Модификатор и тип	Поле	Описание
`protected byte[]`	`buf`	Буфер вывода для записи сжатых данных.
`protected Deflater`	`def`	Компрессор для этого потока.

Поля, объявленные в классе FilterOutputStream

out

Модификатор и тип	Поле	Описание
`protected OutputStream`	`out`	Базовый поток вывода, для которого применяется фильтр.

Краткое описание конструкторов

Конструктор	Описание
`GZIPOutputStream(OutputStream out)`	Создаёт новый поток вывода с размером буфера по умолчанию.
`GZIPOutputStream(OutputStream out, boolean syncFlush)`	Создаёт новый поток вывода с размером буфера по умолчанию и указанным режимом сброса.
`GZIPOutputStream(OutputStream out, int size)`	Создаёт новый поток вывода с указанным размером буфера.
`GZIPOutputStream(OutputStream out, int size, boolean syncFlush)`	Создаёт новый поток вывода с указанным размером буфера и режимом сброса.

Краткое описание методов

Модификатор и тип	Метод	Описание
`void`	`finish()`	Завершает запись сжатых данных в поток вывода, не закрывая базовый поток.
`void`	`write(byte[] buf, int off, int len)`	Записывает массив байтов в поток сжатого вывода.

Методы, объявленные в классе DeflaterOutputStream

close, deflate, flush, write

Модификатор и тип	Метод	Описание
`void`	`close()`	Записывает оставшиеся сжатые данные в поток вывода и закрывает базовый поток.
`protected void`	`deflate()`	Записывает следующий блок сжатых данных в поток вывода.
`void`	`flush()`	Сбрасывает поток сжатого вывода.
`void`	`write(int b)`	Записывает байт в поток сжатого вывода.

Методы, объявленные в классе FilterOutputStream

write

Модификатор и тип	Метод	Описание
`void`	`write(byte[] b)`	Записывает `b.length` байтов в этот поток вывода.

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

Подробное описание полей

crc

protected CRC32 crc

CRC-32 несжатых данных.

Подробное описание конструкторов

GZIPOutputStream

public GZIPOutputStream(OutputStream out, int size) throws IOException

Создаёт новый поток вывода с указанным размером буфера.

Новый экземпляр потока вывода создаётся так, как если бы был вызван трёхаргументный конструктор GZIPOutputStream(out, size, false).

Параметры:: out — поток вывода; size — размер буфера вывода
Исключения:: IOException — если произошла ошибка ввода-вывода.; IllegalArgumentException — если size <= 0

GZIPOutputStream

public GZIPOutputStream(OutputStream out, int size, boolean syncFlush) throws IOException

Создаёт новый поток вывода с указанным размером буфера и режимом сброса.

Параметры:: out — поток вывода; size — размер буфера вывода; syncFlush — если true вызов унаследованного метода flush() этого экземпляра сбрасывает компрессор в режиме сброса Deflater.SYNC_FLUSH перед сбросом потока вывода; в противном случае сбрасывается только поток вывода
Исключения:: IOException — если произошла ошибка ввода-вывода.; IllegalArgumentException — если size <= 0
Начиная с версии:: 1.7

GZIPOutputStream

public GZIPOutputStream(OutputStream out) throws IOException

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

Новый экземпляр потока вывода создаётся так, как если бы был вызван двухаргументный конструктор GZIPOutputStream(out, false).

Параметры:: out — поток вывода
Исключения:: IOException — если произошла ошибка ввода-вывода.

GZIPOutputStream

public GZIPOutputStream(OutputStream out, boolean syncFlush) throws IOException

Создаёт новый поток вывода с размером буфера по умолчанию и указанным режимом сброса.

Параметры:: out — поток вывода; syncFlush — если true вызов унаследованного метода flush() этого экземпляра сбрасывает компрессор в режиме сброса Deflater.SYNC_FLUSH перед сбросом потока вывода; в противном случае сбрасывается только поток вывода
Исключения:: IOException — если произошла ошибка ввода-вывода.
Начиная с версии:: 1.7

Подробное описание методов

write

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

Записывает массив байтов в поток сжатого вывода. Этот метод блокирует выполнение до тех пор, пока не будут записаны все байты.

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

write в классе DeflaterOutputStream

Параметры:

buf — записываемые данные

off — начальное смещение данных

len — длина данных

Исключения:

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

См. также:

finish

public void finish() throws IOException

Завершает запись сжатых данных в поток вывода, не закрывая базовый поток. Используйте этот метод при последовательном применении нескольких фильтров к одному потоку вывода.

Переопределяет:: finish в классе DeflaterOutputStream
Исключения:: 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.