Класс ZipFile

java.lang.Object
- java.util.zip.ZipFile

Все реализованные интерфейсы:: Closeable, AutoCloseable

Прямые известные подклассы:: JarFile

public class ZipFile
extends Object
implements Closeable

Этот класс используется для чтения записей из файла ZIP.

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

Поля

Модификатор и тип	Поле и описание
`static int`	`CENATT`
`static int`	`CENATX`
`static int`	`CENCOM`
`static int`	`CENCRC`
`static int`	`CENDSK`
`static int`	`CENEXT`
`static int`	`CENFLG`
`static int`	`CENHDR`
`static int`	`CENHOW`
`static int`	`CENLEN`
`static int`	`CENNAM`
`static int`	`CENOFF`
`static long`	`CENSIG`
`static int`	`CENSIZ`
`static int`	`CENTIM`
`static int`	`CENVEM`
`static int`	`CENVER`
`static int`	`ENDCOM`
`static int`	`ENDHDR`
`static int`	`ENDOFF`
`static long`	`ENDSIG`
`static int`	`ENDSIZ`
`static int`	`ENDSUB`
`static int`	`ENDTOT`
`static int`	`EXTCRC`
`static int`	`EXTHDR`
`static int`	`EXTLEN`
`static long`	`EXTSIG`
`static int`	`EXTSIZ`
`static int`	`LOCCRC`
`static int`	`LOCEXT`
`static int`	`LOCFLG`
`static int`	`LOCHDR`
`static int`	`LOCHOW`
`static int`	`LOCLEN`
`static int`	`LOCNAM`
`static long`	`LOCSIG`
`static int`	`LOCSIZ`
`static int`	`LOCTIM`
`static int`	`LOCVER`
`static int`	`OPEN_DELETE` Флаг режима для открытия файла ZIP и отметки его для удаления.
`static int`	`OPEN_READ` Флаг режима для открытия файла ZIP для чтения.

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

Конструктор и описание
`ZipFile(File file)` Открывает файл ZIP для чтения, используя указанный объект File.
`ZipFile(File file, Charset charset)` Открывает файл ZIP для чтения, используя указанный объект File.
`ZipFile(File file, int mode)` Открывает новый `ZipFile` для чтения из указанного объекта `File` в указанном режиме.
`ZipFile(File file, int mode, Charset charset)` Открывает новый `ZipFile` для чтения из указанного объекта `File` в указанном режиме.
`ZipFile(String name)` Открывает файл ZIP для чтения.
`ZipFile(String name, Charset charset)` Открывает файл ZIP для чтения.

Методы

Модификатор и тип	Метод и описание
`void`	`close()` Закрывает файл ZIP.
`Enumeration<? extends ZipEntry>`	`entries()` Возвращает перечисление записей файла ZIP.
`protected void`	`finalize()` Обеспечивает освобождение системных ресурсов, используемых объектом ZipFile, когда на него больше нет ссылок.
`String`	`getComment()` Возвращает комментарий к файлу ZIP или null, если комментарий отсутствует.
`ZipEntry`	`getEntry(String name)` Возвращает запись файла ZIP для указанного имени или null, если запись не найдена.
`InputStream`	`getInputStream(ZipEntry entry)` Возвращает поток ввода для чтения содержимого указанной записи файла ZIP.
`String`	`getName()` Возвращает имя пути файла ZIP.
`int`	`size()` Возвращает количество записей в файле ZIP.
`Stream<? extends ZipEntry>`	`stream()` Возвращает упорядоченный `Stream` по записям файла ZIP.

Методы, унаследованные от класса java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Поля

OPEN_READ

public static final int OPEN_READ

Флаг режима открытия файла ZIP для чтения.

См. также:: Значения константных полей

OPEN_DELETE

public static final int OPEN_DELETE

Флаг режима открытия файла ZIP и отметки его для удаления. Файл будет удален в некоторый момент времени между моментом открытия и моментом закрытия, но его содержимое останется доступным через объект ZipFile до тех пор, пока не будет вызван метод close или виртуальная машина не завершит работу.

См. также:: Значения константных полей

LOCSIG

public static final long LOCSIG

См. также:: Значения константных полей

EXTSIG

public static final long EXTSIG

См. также:: Значения константных полей

CENSIG

public static final long CENSIG

См. также:: Значения константных полей

ENDSIG

public static final long ENDSIG

См. также:: Значения константных полей

LOCHDR

public static final int LOCHDR

См. также:: Значения константных полей

EXTHDR

public static final int EXTHDR

См. также:: Значения константных полей

CENHDR

public static final int CENHDR

См. также:: Значения константных полей

ENDHDR

public static final int ENDHDR

См. также:: Значения константных полей

LOCVER

public static final int LOCVER

См. также:: Значения константных полей

LOCFLG

public static final int LOCFLG

См. также:: Значения константных полей

LOCHOW

public static final int LOCHOW

См. также:: Значения константных полей

LOCTIM

public static final int LOCTIM

См. также:: Значения константных полей

LOCCRC

public static final int LOCCRC

См. также:: Значения константных полей

LOCSIZ

public static final int LOCSIZ

См. также:: Значения константных полей

LOCLEN

public static final int LOCLEN

См. также:: Значения константных полей

LOCNAM

public static final int LOCNAM

См. также:: Значения константных полей

LOCEXT

public static final int LOCEXT

См. также:: Значения константных полей

EXTCRC

public static final int EXTCRC

См. также:: Значения константных полей

EXTSIZ

public static final int EXTSIZ

См. также:: Значения константных полей

EXTLEN

public static final int EXTLEN

См. также:: Значения константных полей

CENVEM

public static final int CENVEM

См. также:: Значения константных полей

CENVER

public static final int CENVER

См. также:: Значения константных полей

CENFLG

public static final int CENFLG

См. также:: Значения константных полей

CENHOW

public static final int CENHOW

См. также:: Значения константных полей

CENTIM

public static final int CENTIM

См. также:: Значения константных полей

CENCRC

public static final int CENCRC

См. также:: Значения константных полей

CENSIZ

public static final int CENSIZ

См. также:: Значения константных полей

CENLEN

public static final int CENLEN

См. также:: Значения константных полей

CENNAM

public static final int CENNAM

См. также:: Значения константных полей

CENEXT

public static final int CENEXT

См. также:: Значения константных полей

CENCOM

public static final int CENCOM

См. также:: Значения константных полей

CENDSK

public static final int CENDSK

См. также:: Значения константных полей

CENATT

public static final int CENATT

См. также:: Значения константных полей

CENATX

public static final int CENATX

См. также:: Значения константных полей

CENOFF

public static final int CENOFF

См. также:: Значения константных полей

ENDSUB

public static final int ENDSUB

См. также:: Значения константных полей

ENDTOT

public static final int ENDTOT

См. также:: Значения константных полей

ENDSIZ

public static final int ENDSIZ

См. также:: Значения константных полей

ENDOFF

public static final int ENDOFF

См. также:: Значения константных полей

ENDCOM

public static final int ENDCOM

См. также:: Значения константных полей

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

ZipFile

public ZipFile(String name)
        throws IOException

Открывает файл ZIP для чтения.

Сначала, если существует менеджер безопасности, вызывается его метод checkRead с аргументом name для проверки разрешения на чтение.

Используется кодировка UTF-8 charset для декодирования имён записей и комментариев.

Параметры:: name - имя файла ZIP
Исключения:: ZipException - если произошла ошибка в формате ZIP; IOException - если произошла ошибка ввода-вывода; SecurityException - если менеджер безопасности существует и его метод checkRead не разрешает доступ на чтение к файлу.
См. также:: SecurityManager.checkRead(java.lang.String)

ZipFile

public ZipFile(File file,
               int mode)
        throws IOException

Открывает новый ZipFile для чтения из указанного объекта File в указанном режиме. Аргумент режима должен быть равен OPEN_READ или OPEN_READ | OPEN_DELETE.

Используется кодировка UTF-8 charset для декодирования имён записей и комментариев

Параметры:: file - файл ZIP, который будет открыт для чтения; mode - режим открытия файла
Исключения:: ZipException - если произошла ошибка в формате ZIP; IOException - если произошла ошибка ввода-вывода; SecurityException - если менеджер безопасности существует и его метод checkRead не разрешает доступ на чтение к файлу, или его метод checkDelete не разрешает удаление файла, когда установлен флаг OPEN_DELETE.; IllegalArgumentException - если аргумент mode некорректен
С тех пор как:: 1.3
См. также:: SecurityManager.checkRead(java.lang.String)

ZipFile

public ZipFile(File file)
        throws ZipException,
               IOException

Открывает ZIP-архив для чтения, используя указанный объект File.

Кодировка UTF-8 используется для декодирования имён и комментариев записей.

Параметры:: file - ZIP-архив, который нужно открыть для чтения
Исключения:: ZipException - если произошла ошибка формата ZIP; IOException - если произошла ошибка ввода-вывода

ZipFile

public ZipFile(File file,
               int mode,
               Charset charset)
        throws IOException

Открывает новый ZipFile для чтения из указанного объекта File в указанном режиме. Аргумент режима должен быть либо OPEN_READ, либо OPEN_READ | OPEN_DELETE.

В первую очередь, если существует менеджер безопасности, вызывается его метод checkRead с аргументом name в качестве аргумента, чтобы убедиться, что чтение разрешено.

Параметры:: file - ZIP-архив, который нужно открыть для чтения; mode - режим, в котором файл должен быть открыт; charset - кодировка, которая будет использоваться для декодирования имени и комментария записи ZIP, которая не закодирована с помощью кодировки UTF-8 (указано флагом общего назначения записи).
Исключения:: ZipException - если произошла ошибка формата ZIP; IOException - если произошла ошибка ввода-вывода; SecurityException - если менеджер безопасности существует и его метод checkRead не разрешает доступ на чтение к файлу, или его метод checkDelete не разрешает удаление файла, когда установлен флаг OPEN_DELETE; IllegalArgumentException - если аргумент mode некорректен
С:: 1.7
См. также:: SecurityManager.checkRead(java.lang.String)

ZipFile

public ZipFile(String name,
               Charset charset)
        throws IOException

Открывает ZIP-архив для чтения.

Параметры:: name - имя ZIP-архива; charset - кодировка, которая будет использоваться для декодирования имени и комментария записи ZIP, которая не закодирована с помощью кодировки UTF-8 (указано флагом общего назначения записи).
Исключения:: ZipException - если произошла ошибка формата ZIP; IOException - если произошла ошибка ввода-вывода; SecurityException - если менеджер безопасности существует и его метод checkRead не разрешает доступ на чтение к файлу
С:: 1.7
См. также:: SecurityManager.checkRead(java.lang.String)

ZipFile

public ZipFile(File file,
               Charset charset)
        throws IOException

Открывает ZIP-архив для чтения, используя указанный объект File.

Параметры:: file - ZIP-архив, который нужно открыть для чтения; charset - Кодировка, которая будет использоваться для декодирования имени и комментария записи ZIP (игнорируется, если установлен флаг кодировки языка в бите общего назначения записи).
Исключения:: ZipException - если произошла ошибка формата ZIP; IOException - если произошла ошибка ввода-вывода
С:: 1.7

Методы

getComment

public String getComment()

Возвращает комментарий к ZIP-архиву, или null, если комментарий отсутствует.

Возвращает:: строку комментария к ZIP-архиву, или null, если комментарий отсутствует
Исключения:: IllegalStateException - если ZIP-архив был закрыт С 1.7

getEntry

public ZipEntry getEntry(String name)

Возвращает запись ZIP-архива для указанного имени, или null, если запись не найдена.

Параметры:: name - имя записи
Возвращает:: запись ZIP-архива, или null, если запись не найдена
Исключения:: IllegalStateException - если ZIP-архив был закрыт

getInputStream

public InputStream getInputStream(ZipEntry entry)
                           throws IOException

Возвращает поток для чтения содержимого указанной записи ZIP-архива.

Закрытие этого ZIP-архива приведет к закрытию всех входных потоков, возвращённых вызовами этого метода.

Параметры:: entry - запись ZIP-архива
Возвращает:: поток для чтения содержимого указанной записи ZIP-архива.
Исключения:: ZipException - если произошла ошибка формата ZIP; IOException - если произошла ошибка ввода-вывода; IllegalStateException - если ZIP-архив был закрыт

getName

public String getName()

Возвращает имя пути к ZIP-архиву.

Возвращает:: имя пути к ZIP-архиву

entries

public Enumeration<? extends ZipEntry> entries()

Возвращает перечисление записей ZIP-архива.

Возвращает:: перечисление записей ZIP-архива
Исключения:: IllegalStateException - если ZIP-архив был закрыт

stream

public Stream<? extends ZipEntry> stream()

Возвращает упорядоченный Stream по записям ZIP-архива. Записи появляются в Stream в порядке их появления в центральном каталоге ZIP-архива.

Возвращает:: упорядоченный Stream записей в этом ZIP-архиве
Исключения:: IllegalStateException - если ZIP-архив был закрыт
С:: 1.8

size

public int size()

Возвращает количество записей в ZIP-архиве.

Возвращает:: количество записей в ZIP-архиве
Исключения:: IllegalStateException - если ZIP-архив был закрыт

close

public void close()
           throws IOException

Закрывает ZIP-архив.

Закрытие этого ZIP-архива закроет все входные потоки, ранее возвращённые вызовами метода getInputStream.

Определено в:: close в интерфейсе Closeable
Определено в:: close в интерфейсе AutoCloseable
Исключения:: IOException - если произошла ошибка ввода-вывода

finalize

protected void finalize()
                 throws IOException

Обеспечивает освобождение системных ресурсов, удерживаемых объектом ZipFile, когда на него больше нет ссылок.

Поскольку время, когда GC вызовет этот метод, не определено, настоятельно рекомендуется вызывать метод close сразу после завершения доступа к этому ZipFile. Это предотвратит задержку системных ресурсов на неопределённый период времени.

Переопределяет:: finalize в классе Object
Исключения:: IOException - если произошла ошибка ввода-вывода
См. также:: close()

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