モジュール java.base

パッケージ java.util.zip

クラス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ファイル形式でファイルを書き込むための出力ストリーム・フィルタを実装します。 圧縮データと圧縮解除データの両方をサポートします。

導入されたバージョン:

1.1

フィールドのサマリー

フィールド

修飾子と型	フィールド	説明
static final int	CENATT	中央ディレクトリの(CEN)ヘッダー内部ファイル属性のフィールド・オフセット。
static final int	CENATX	中央ディレクトリの(CEN)ヘッダー外部ファイル属性フィールド・オフセット。
static final int	CENCOM	中央ディレクトリの(CEN)ヘッダー・コメント長フィールド・オフセット。
static final int	CENCRC	中央ディレクトリの(CEN)ヘッダー非圧縮ファイルのcrc-32値フィールド・オフセット。
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	中央ディレクトリの(CEN)ヘッダーLOCヘッダーのオフセット・フィールドのオフセット。
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	中央ディレクトリの(END)ヘッダーzipファイルのコメント長フィールド・オフセットの終わり。
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	圧縮されていない余分なローカル(EXT)ヘッダーのcrc-32値フィールド・オフセット。
static final int	EXTHDR	追加のローカル(EXT)ヘッダー・サイズ(バイト数(シグネチャを含む))。
static final int	EXTLEN	余分なローカル(EXT)ヘッダーの非圧縮サイズ・フィールド・オフセット。
static final long	EXTSIG	追加のローカル(EXT)ヘッダー・シグネチャ。
static final int	EXTSIZ	追加のローカル(EXT)ヘッダー圧縮サイズ・フィールド・オフセット。
static final int	LOCCRC	ローカル・ファイル(LOC)ヘッダー非圧縮ファイルcrc-32値フィールド・オフセット。
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)エントリのための圧縮メソッドです。

クラスjava.util.zip.DeflaterOutputStreamで宣言されたフィールド

buf, def

クラスjava.io.FilterOutputStreamで宣言されたフィールド

out

コンストラクタのサマリー

コンストラクタ

コンストラクタ	説明
ZipOutputStream(OutputStream out)	新しいZIP出力ストリームを作成します。
ZipOutputStream(OutputStream out, Charset charset)	新しいZIP出力ストリームを作成します。

メソッドのサマリー

修飾子と型	メソッド	説明
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エントリ・データに書き込みます。

クラスjava.util.zip.DeflaterOutputStreamで宣言されたメソッド

deflate, flush, write

クラスjava.io.FilterOutputStreamで宣言されたメソッド

write

クラスjava.io.OutputStreamで宣言されたメソッド

nullOutputStream

クラスjava.lang.Objectで宣言されたメソッド

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

フィールド詳細

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

ローカル・ファイル(LOC)ヘッダー非圧縮ファイルcrc-32値フィールド・オフセット。

関連項目:

• 定数フィールド値

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

圧縮されていない余分なローカル(EXT)ヘッダーのcrc-32値フィールド・オフセット。

関連項目:

• 定数フィールド値

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

中央ディレクトリの(CEN)ヘッダー非圧縮ファイルのcrc-32値フィールド・オフセット。

関連項目:

• 定数フィールド値

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

中央ディレクトリの(CEN)ヘッダーLOCヘッダーのオフセット・フィールドのオフセット。

関連項目:

• 定数フィールド値

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

中央ディレクトリの(END)ヘッダーzipファイルのコメント長フィールド・オフセットの終わり。

関連項目:

• 定数フィールド値

コンストラクタの詳細

ZipOutputStream

public ZipOutputStream(OutputStream out)

新しいZIP出力ストリームを作成します。

UTF-8 charsetを使用して、エントリ名とコメントがエンコードされます。

パラメータ:

out - 実際の出力ストリーム

ZipOutputStream

public ZipOutputStream(OutputStream out, Charset charset)

新しいZIP出力ストリームを作成します。

パラメータ:

out - 実際の出力ストリーム

charset - エントリ名とコマンドのエンコードに使用される文字セット

導入されたバージョン:

1.7

メソッドの詳細

setComment

public void setComment(String comment)

ZIPファイル・コメントを設定します。

パラメータ:

comment - コメント文字列

例外:

IllegalArgumentException - 指定されたZIPファイル・コメントの長さが0xFFFFバイトより大きい場合

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出力ストリームの内容の書込みを終了します。 複数のフィルタを続けて同じ出力ストリームに適用するときに、このメソッドを使用します。

オーバーライド:

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