Spec-Zone.ru › OpenJDK 27

Класс ZipOutputStream

java.lang.Object
java.io.OutputStream
java.io.FilterOutputStream
java.util.zip.DeflaterOutputStream
java.util.zip.ZipOutputStream
Все реализуемые интерфейсы:
Closeable, Flushable, AutoCloseable
Прямые известные подклассы:
JarOutputStream
public class ZipOutputStream extends DeflaterOutputStream
Этот класс реализует фильтр выходного потока для записи файлов в формате ZIP. Поддерживаются как сжатые, так и несжатые записи.

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

По умолчанию для кодирования имён записей и комментариев используется кодировка UTF-8. Для указания другой кодировки можно использовать ZipOutputStream(OutputStream, Charset).

Начиная с:
1.1

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

Модификатор и тип Поле Описание
static final int CENATT
Смещение поля внутренних атрибутов файла в заголовке центрального каталога (CEN).
static final int CENATX
Смещение поля внешних атрибутов файла в заголовке центрального каталога (CEN).
static final int CENCOM
Смещение поля длины комментария в заголовке центрального каталога (CEN).
static final int CENCRC
Смещение поля значения CRC-32 несжатого файла в заголовке центрального каталога (CEN).
static final int CENDSK
Смещение поля номера начального диска в заголовке центрального каталога (CEN).
static final int CENEXT
Смещение поля длины дополнительных данных в заголовке центрального каталога (CEN).
static final int CENFLG
Смещение поля флагов шифрования и расшифрования в заголовке центрального каталога (CEN).
static final int CENHDR
Размер заголовка центрального каталога (CEN) в байтах (включая сигнатуру).
static final int CENHOW
Смещение поля метода сжатия в заголовке центрального каталога (CEN).
static final int CENLEN
Смещение поля размера несжатого файла в заголовке центрального каталога (CEN).
static final int CENNAM
Смещение поля длины имени файла в заголовке центрального каталога (CEN).
static final int CENOFF
Смещение поля смещения заголовка LOC в заголовке центрального каталога (CEN).
static final long CENSIG
Сигнатура заголовка центрального каталога (CEN).
static final int CENSIZ
Смещение поля размера сжатого файла в заголовке центрального каталога (CEN).
static final int CENTIM
Смещение поля времени изменения в заголовке центрального каталога (CEN).
static final int CENVEM
Смещение поля версии, создавшей файл, в заголовке центрального каталога (CEN).
static final int CENVER
Смещение поля версии, необходимой для извлечения файла, в заголовке центрального каталога (CEN).
static final int DEFLATED
Метод сжатия для сжатых (DEFLATED) записей.
static final int ENDCOM
Смещение поля длины комментария ZIP-файла в заголовке конца центрального каталога (END).
static final int ENDHDR
Размер заголовка конца центрального каталога (END) в байтах (включая сигнатуру).
static final int ENDOFF
Смещение поля смещения первого заголовка CEN в заголовке конца центрального каталога (END).
static final long ENDSIG
Сигнатура заголовка конца центрального каталога (END).
static final int ENDSIZ
Смещение поля размера центрального каталога в байтах в заголовке конца центрального каталога (END).
static final int ENDSUB
Смещение поля количества записей на этом диске в заголовке конца центрального каталога (END).
static final int ENDTOT
Смещение поля общего количества записей в заголовке конца центрального каталога (END).
static final int EXTCRC
Смещение поля значения CRC-32 несжатого файла в дополнительном локальном заголовке (EXT).
static final int EXTHDR
Размер дополнительного локального заголовка (EXT) в байтах (включая сигнатуру).
static final int EXTLEN
Смещение поля размера несжатого файла в дополнительном локальном заголовке (EXT).
static final long EXTSIG
Сигнатура дополнительного локального заголовка (EXT).
static final int EXTSIZ
Смещение поля размера сжатого файла в дополнительном локальном заголовке (EXT).
static final int LOCCRC
Смещение поля значения CRC-32 несжатого файла в заголовке локального файла (LOC).
static final int LOCEXT
Смещение поля длины дополнительных данных в заголовке локального файла (LOC).
static final int LOCFLG
Смещение поля флага общего назначения в заголовке локального файла (LOC).
static final int LOCHDR
Размер заголовка локального файла (LOC) в байтах (включая сигнатуру).
static final int LOCHOW
Смещение поля метода сжатия в заголовке локального файла (LOC).
static final int LOCLEN
Смещение поля размера несжатого файла в заголовке локального файла (LOC).
static final int LOCNAM
Смещение поля длины имени файла в заголовке локального файла (LOC).
static final long LOCSIG
Сигнатура заголовка локального файла (LOC).
static final int LOCSIZ
Смещение поля размера сжатого файла в заголовке локального файла (LOC).
static final int LOCTIM
Смещение поля времени изменения в заголовке локального файла (LOC).
static final int LOCVER
Смещение поля версии, необходимой для извлечения файла, в заголовке локального файла (LOC).
static final int STORED
Метод сжатия для несжатых (STORED) записей.

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

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

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

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

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

Конструктор Описание
ZipOutputStream(OutputStream out)
Создаёт новый выходной поток ZIP, используя кодировку UTF-8 charset для кодирования имён записей и комментариев.
ZipOutputStream(OutputStream out, Charset charset)
Создаёт новый выходной поток ZIP, используя указанную charset для кодирования имён записей и комментариев.

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

Модификатор и тип Метод Описание
void close()
Закрывает базовый поток и фильтруемый поток после полной записи содержимого выходного потока ZIP.
void closeEntry()
Закрывает текущую запись ZIP и подготавливает поток к записи следующей записи.
void finish()
Завершает запись содержимого выходного потока ZIP, не закрывая базовый поток.
void putNextEntry(ZipEntry e)
Начинает запись новой записи ZIP-файла и устанавливает поток в начало данных записи.
void setComment(String comment)
Устанавливает комментарий ZIP-файла.
void setLevel(int level)
Устанавливает уровень сжатия для последующих записей, использующих метод DEFLATED.
void setMethod(int method)
Устанавливает метод сжатия по умолчанию для последующих записей.
void write(byte[] b, int off, int len)
Записывает массив байтов в данные текущей записи ZIP.

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

deflate, flush, write
Модификатор и тип Метод Описание
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()
Заставляет текущий поток ожидать пробуждения, обычно посредством уведомления или прерывания.
final void wait(long timeoutMillis)
Заставляет текущий поток ожидать пробуждения, обычно посредством уведомления или прерывания, либо до истечения заданного промежутка реального времени.
final void wait(long timeoutMillis, int nanos)
Заставляет текущий поток ожидать пробуждения, обычно посредством уведомления или прерывания, либо до истечения заданного промежутка реального времени.

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

STORED

public static final int STORED
Метод сжатия для несжатых записей (STORED).
См. также:
  • Значения константных полей

DEFLATED

public static final int DEFLATED
Метод сжатия для сжатых записей (DEFLATED).
См. также:
  • Значения константных полей

LOCSIG

static final long LOCSIG
Сигнатура заголовка локального файла (LOC).
См. также:
  • Значения константных полей

EXTSIG

static final long EXTSIG
Сигнатура дополнительного локального заголовка (EXT).
См. также:
  • Значения константных полей

CENSIG

static final long CENSIG
Сигнатура заголовка центрального каталога (CEN).
См. также:
  • Значения константных полей

ENDSIG

static final long ENDSIG
Сигнатура заголовка конца центрального каталога (END).
См. также:
  • Значения константных полей

LOCHDR

static final int LOCHDR
Размер заголовка локального файла (LOC) в байтах (включая сигнатуру).
См. также:
  • Значения константных полей

EXTHDR

static final int EXTHDR
Размер дополнительного локального заголовка (EXT) в байтах (включая сигнатуру).
См. также:
  • Значения константных полей

CENHDR

static final int CENHDR
Размер заголовка центрального каталога (CEN) в байтах (включая сигнатуру).
См. также:
  • Значения константных полей

ENDHDR

static final int ENDHDR
Размер заголовка конца центрального каталога (END) в байтах (включая сигнатуру).
См. также:
  • Значения константных полей

LOCVER

static final int LOCVER
Смещение поля версии, необходимой для извлечения данных, в заголовке локального файла (LOC).
См. также:
  • Значения константных полей

LOCFLG

static final int LOCFLG
Смещение поля флагов общего назначения в заголовке локального файла (LOC).
См. также:
  • Значения константных полей

LOCHOW

static final int LOCHOW
Смещение поля метода сжатия в заголовке локального файла (LOC).
См. также:
  • Значения константных полей

LOCTIM

static final int LOCTIM
Смещение поля времени изменения в заголовке локального файла (LOC).
См. также:
  • Значения константных полей

LOCCRC

static final int LOCCRC
Смещение поля значения CRC-32 несжатого файла в заголовке локального файла (LOC).
См. также:
  • Значения константных полей

LOCSIZ

static final int LOCSIZ
Смещение поля размера сжатого файла в заголовке локального файла (LOC).
См. также:
  • Значения константных полей

LOCLEN

static final int LOCLEN
Смещение поля размера несжатого файла в заголовке локального файла (LOC).
См. также:
  • Значения константных полей

LOCNAM

static final int LOCNAM
Смещение поля длины имени файла в заголовке локального файла (LOC).
См. также:
  • Значения константных полей

LOCEXT

static final int LOCEXT
Смещение поля длины дополнительных данных в заголовке локального файла (LOC).
См. также:
  • Значения константных полей

EXTCRC

static final int EXTCRC
Смещение поля значения CRC-32 несжатого файла в дополнительном локальном заголовке (EXT).
См. также:
  • Значения константных полей

EXTSIZ

static final int EXTSIZ
Смещение поля размера сжатого файла в дополнительном локальном заголовке (EXT).
См. также:
  • Значения константных полей

EXTLEN

static final int EXTLEN
Смещение поля размера несжатого файла в дополнительном локальном заголовке (EXT).
См. также:
  • Значения константных полей

CENVEM

static final int CENVEM
Смещение поля версии, создавшей запись, в заголовке центрального каталога (CEN).
См. также:
  • Значения константных полей

CENVER

static final int CENVER
Смещение поля версии, необходимой для извлечения данных, в заголовке центрального каталога (CEN).
См. также:
  • Значения константных полей

CENFLG

static final int CENFLG
Смещение поля флагов шифрования и дешифрования в заголовке центрального каталога (CEN).
См. также:
  • Значения константных полей

CENHOW

static final int CENHOW
Смещение поля метода сжатия в заголовке центрального каталога (CEN).
См. также:
  • Значения константных полей

CENTIM

static final int CENTIM
Смещение поля времени изменения в заголовке центрального каталога (CEN).
См. также:
  • Значения константных полей

CENCRC

static final int CENCRC
Смещение поля значения CRC-32 несжатого файла в заголовке центрального каталога (CEN).
См. также:
  • Значения константных полей

CENSIZ

static final int CENSIZ
Смещение поля размера сжатого файла в заголовке центрального каталога (CEN).
См. также:
  • Значения константных полей

CENLEN

static final int CENLEN
Смещение поля размера несжатого файла в заголовке центрального каталога (CEN).
См. также:
  • Значения константных полей

CENNAM

static final int CENNAM
Смещение поля длины имени файла в заголовке центрального каталога (CEN).
См. также:
  • Значения константных полей

CENEXT

static final int CENEXT
Смещение поля длины дополнительных данных в заголовке центрального каталога (CEN).
См. также:
  • Значения константных полей

CENCOM

static final int CENCOM
Смещение поля длины комментария в заголовке центрального каталога (CEN).
См. также:
  • Значения константных полей

CENDSK

static final int CENDSK
Смещение поля номера диска, с которого начинается запись, в заголовке центрального каталога (CEN).
См. также:
  • Значения константных полей

CENATT

static final int CENATT
Смещение поля внутренних атрибутов файла в заголовке центрального каталога (CEN).
См. также:
  • Значения константных полей

CENATX

static final int CENATX
Смещение поля внешних атрибутов файла в заголовке центрального каталога (CEN).
См. также:
  • Значения константных полей

CENOFF

static final int CENOFF
Смещение поля смещения заголовка LOC в заголовке центрального каталога (CEN).
См. также:
  • Значения константных полей

ENDSUB

static final int ENDSUB
Смещение поля числа записей на этом диске в заголовке конца центрального каталога (END).
См. также:
  • Значения константных полей

ENDTOT

static final int ENDTOT
Смещение поля общего числа записей в заголовке конца центрального каталога (END).
См. также:
  • Значения константных полей

ENDSIZ

static final int ENDSIZ
Смещение поля размера центрального каталога в байтах в заголовке конца центрального каталога (END).
См. также:
  • Значения константных полей

ENDOFF

static final int ENDOFF
Смещение поля смещения первого заголовка CEN в заголовке конца центрального каталога (END).
См. также:
  • Значения константных полей

ENDCOM

static final int ENDCOM
Смещение поля длины комментария ZIP-файла в заголовке конца центрального каталога (END).
См. также:
  • Значения константных полей

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

ZipOutputStream

public ZipOutputStream(OutputStream out)
Создает новый поток вывода ZIP, используя кодировку UTF-8 charset для кодирования имен записей и комментариев.
Параметры:
out — фактический выходной поток

ZipOutputStream

public ZipOutputStream(OutputStream out, Charset charset)
Создает новый поток вывода ZIP, используя указанную charset для кодирования имен записей и комментариев.
Параметры:
out — фактический выходной поток
charset — кодировка, используемая для кодирования имен записей и комментариев
Начиная с:
1.7

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

setComment

public void setComment(String comment)
Задает комментарий ZIP-файла. Если comment — пустая строка или null, ZIP-файл не будет содержать комментарий.
Параметры:
comment — строка комментария; пустая строка или null, если комментарий не нужен
Исключения:
IllegalArgumentException — если длина указанного комментария ZIP-файла превышает 0xFFFF байт или если comment содержит символы, которые не могут быть отображены с помощью Charset, используемой для кодирования имен записей и комментариев

setMethod

public void setMethod(int method)
Задает метод сжатия по умолчанию для последующих записей. Этот метод будет использоваться, если метод сжатия не указан для отдельной записи ZIP-файла. Изначально задано значение DEFLATED.
Параметры:
method — метод сжатия по умолчанию
Исключения:
IllegalArgumentException — если указанный метод сжатия недопустим

setLevel

public void setLevel(int level)
Задает уровень сжатия для последующих записей, использующих DEFLATED. По умолчанию используется DEFAULT_COMPRESSION.
Параметры:
level — уровень сжатия (0–9)
Исключения:
IllegalArgumentException — если уровень сжатия недопустим

putNextEntry

public void putNextEntry(ZipEntry e) throws IOException
Начинает запись новой записи ZIP-файла и устанавливает позицию потока в начало данных записи. Закрывает текущую запись, если она еще открыта.

Если для записи не указан метод сжатия, будет использоваться метод по умолчанию. При записи сжатой записи (DEFLATED), если размер в сжатом виде явно не задан методом ZipEntry.setCompressedSize(long), после сжатия ему будет присвоено фактическое значение.

Если для записи не задано время изменения, будет использоваться текущее время.

Примечание к API:
При записи записи каталога следует использовать метод сжатия STORED, а значения размера и CRC-32 следует установить в 0: 
     ZipEntry e = new ZipEntry(entryName);
     if (e.isDirectory()) {
         e.setMethod(ZipEntry.STORED);
         e.setSize(0);
         e.setCrc(0);
     }
     stream.putNextEntry(e);
Это обеспечивает оптимальную производительность при обработке записей каталогов.
Параметры:
e — запись ZIP, которую необходимо записать
Исключения:
ZipException — если произошла ошибка формата ZIP
IOException — если произошла ошибка ввода-вывода

closeEntry

public void closeEntry() throws IOException
Закрывает текущую запись ZIP и устанавливает позицию потока для записи следующей записи.
Исключения:
ZipException — если произошла ошибка формата ZIP
IOException — если произошла ошибка ввода-вывода

write

public void write(byte[] b, int off, int len) throws IOException
Записывает массив байтов в данные текущей записи ZIP. Этот метод блокирует выполнение до тех пор, пока не будут записаны все байты.
Переопределяет:
write в классе DeflaterOutputStream
Параметры:
b — данные для записи
off — начальное смещение в данных
len — количество записываемых байтов
Исключения:
ZipException — если произошла ошибка ZIP-файла
IOException — если произошла ошибка ввода-вывода
См. также:
  • FilterOutputStream.write(int)

finish

public void finish() throws IOException
Завершает запись содержимого потока вывода ZIP, не закрывая базовый поток. Используйте этот метод при последовательном применении нескольких фильтров к одному выходному потоку.

Будет выброшено исключение ZipException, если общая длина закодированных имени записи, дополнительных данных, комментария записи и размера заголовка CEN превышает 65 535 байт.

Переопределяет:
finish в классе DeflaterOutputStream
Исключения:
ZipException — если произошла ошибка ZIP-файла
IOException — если произошло исключение ввода-вывода

close

public void close() throws IOException
Закрывает базовый поток и фильтруемый поток после полной записи содержимого потока вывода ZIP.
Определен в:
close в интерфейсе AutoCloseable
Определен в:
close в интерфейсе Closeable
Переопределяет:
close в классе DeflaterOutputStream
Исключения:
ZipException — если произошла ошибка ZIP-файла
IOException — если произошла ошибка ввода-вывода
См. также:
  • FilterOutputStream.flush()
  • FilterOutputStream.out

Сообщить об ошибке или предложить улучшение
Дополнительные справочные материалы по API и документацию для разработчиков см. в разделе Документация Java SE, содержащем более подробные описания для разработчиков, концептуальные обзоры, определения терминов, обходные решения и примеры работающего кода. Другие версии.
Java является товарным знаком или зарегистрированным товарным знаком Oracle и/или ее аффилированных лиц в США и других странах.
Авторское право © 1993, 2026, Oracle и/или ее аффилированные лица, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
Все права защищены. Использование регулируется условиями лицензии и политикой распространения документации.

© 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.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API