java.lang.Object
java.util.zip.ZipFile
- すべての実装されたインタフェース:
Closeable
,AutoCloseable
- 直系の既知のサブクラス:
JarFile
public class ZipFile extends Object implements Closeable
このクラスは、ZIPファイルからエントリを読み込むために使用します。
ほかで指定がない場合、null
引数をコンストラクタまたはこのクラスのメソッドへ渡すと、NullPointerException
がスローされます。
- APIの注:
- この
ZipFile
によって使用されるリソースを解放するには、close()
メソッドを明示的にまたはtry-with-resourcesによって呼び出す必要があります。 サブクラスは、サブクラスによって獲得されたリソースのクリーンアップを担当します。 クリーンアップを実行するためにObject.finalize()
をオーバーライドするサブクラスは、Cleaner
などの代替クリーンアップ・メカニズムを使用し、オーバーライドするfinalize
メソッドを削除するように変更する必要があります。 - 導入されたバージョン:
- 1.1
-
フィールドのサマリー
フィールド 修飾子と型 フィールド 説明 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)
Fileオブジェクトに指定されたZIPファイルを、読込み用に開きます。ZipFile(File file, int mode)
指定されたモードで指定のFile
オブジェクトから読み込む新しいZipFile
を開きます。ZipFile(File file, int mode, Charset charset)
指定されたモードで指定のFile
オブジェクトから読み込む新しいZipFile
を開きます。ZipFile(File file, Charset charset)
Fileオブジェクトに指定されたZIPファイルを、読込み用に開きます。ZipFile(String name)
zipファイルを読込み用に開きます。ZipFile(String name, Charset charset)
zipファイルを読込み用に開きます。 -
メソッドのサマリー
修飾子と型 メソッド 説明 void
close()
ZIPファイルを閉じます。Enumeration<? extends ZipEntry>
entries()
ZIPファイル・エントリの列挙を返します。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()
ZIPファイル・エントリ上に順序付けされたStream
を返します。
-
フィールド詳細
-
OPEN_READ
public static final int OPEN_READZIPファイルを読込み用に開くモード・フラグです。- 関連項目:
- 定数フィールド値
-
OPEN_DELETE
public static final int OPEN_DELETEZIPファイルを開いて、削除のマークを付けるモード・フラグです。 ファイルを開いてから閉じるまでにファイルが削除されますが、closeメソッドが呼び出されるか、仮想マシンが終了するまで、ZipFile
オブジェクトによってファイルの内容にアクセスできます。- 関連項目:
- 定数フィールド値
-
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 IOExceptionzipファイルを読込み用に開きます。セキュリティ・マネージャが存在する場合は、まず、セキュリティ・マネージャの
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指定されたモードで指定のFile
オブジェクトから読み込む新しいZipFile
を開きます。 モード引数は、OPEN_READ
またはOPEN_READ|OPEN_DELETE
である必要があります。セキュリティ・マネージャが存在する場合は、まず、セキュリティ・マネージャの
checkRead
メソッドが引数としてname
を指定して呼び出され、読込みが許可されるかどうかを確認します。UTF-8
charset
を使用して、エントリ名とコメントがデコードされます- パラメータ:
file
- 読取りのために開くZIPファイルmode
- ファイルが開かれるモード- 例外:
ZipException
- ZIP形式エラーが発生した場合IOException
- 入出力エラーが発生した場合SecurityException
- セキュリティ・マネージャが存在し、そのcheckRead
メソッドがファイルへの読取りアクセスを許可しないか、OPEN_DELETE
フラグが設定されていて、そのcheckDelete
メソッドがファイルの削除を許可しない場合。IllegalArgumentException
-mode
引数が無効な場合- 導入されたバージョン:
- 1.3
- 関連項目:
SecurityManager.checkRead(java.lang.String)
-
ZipFile
public ZipFile(File file) throws ZipException, IOExceptionFileオブジェクトに指定されたZIPファイルを、読込み用に開きます。UTF-8
charset
を使用して、エントリ名とコメントがデコードされます。- パラメータ:
file
- 読取りのために開くZIPファイル- 例外:
ZipException
- ZIP形式エラーが発生した場合IOException
- 入出力エラーが発生した場合
-
ZipFile
public ZipFile(File file, int mode, Charset charset) throws IOException指定されたモードで指定のFile
オブジェクトから読み込む新しいZipFile
を開きます。 モード引数は、OPEN_READ
またはOPEN_READ|OPEN_DELETE
である必要があります。セキュリティ・マネージャが存在する場合は、まず、セキュリティ・マネージャの
checkRead
メソッドが引数としてname
を指定して呼び出され、読込みが許可されるかどうかを確認します。- パラメータ:
file
- 読取りのために開くZIPファイルmode
- ファイルが開かれるモードcharset
- UTF-8エンコーディング(エントリの汎用フラグによって示される)によってエンコードされていないZIPエントリ名とコメントのデコードに使用される文字セット。- 例外:
ZipException
- ZIP形式エラーが発生した場合IOException
- 入出力エラーが発生した場合SecurityException
- セキュリティ・マネージャが存在し、そのcheckRead
メソッドがファイルへの読取りアクセスを許可しないか、OPEN_DELETE
フラグが設定されていて、そのcheckDelete
メソッドがファイルの削除を許可しない場合IllegalArgumentException
-mode
引数が無効な場合- 導入されたバージョン:
- 1.7
- 関連項目:
SecurityManager.checkRead(java.lang.String)
-
ZipFile
public ZipFile(String name, Charset charset) throws IOExceptionzipファイルを読込み用に開きます。セキュリティ・マネージャが存在する場合は、まず、セキュリティ・マネージャの
checkRead
メソッドが引数としてname
を指定して呼び出され、読込みが許可されるかどうかを確認します。- パラメータ:
name
- ZIPファイルの名前charset
- UTF-8エンコーディング(エントリの汎用フラグによって示される)によってエンコードされていないZIPエントリ名とコメントのデコードに使用される文字セット。- 例外:
ZipException
- ZIP形式エラーが発生した場合IOException
- 入出力エラーが発生した場合SecurityException
- セキュリティ・マネージャが存在する場合に、セキュリティ・マネージャのcheckRead
メソッドがファイルへの読込みアクセスを許可しない場合- 導入されたバージョン:
- 1.7
- 関連項目:
SecurityManager.checkRead(java.lang.String)
-
ZipFile
public ZipFile(File file, Charset charset) throws IOExceptionFileオブジェクトに指定されたZIPファイルを、読込み用に開きます。- パラメータ:
file
- 読取りのために開くZIPファイルcharset
- ZIPエントリ名とコメントのデコードに使用される文字セット (ZIPエントリの汎用ビット・フラグの言語エンコーディング・ビットが設定されている場合無視される)。- 例外:
ZipException
- ZIP形式エラーが発生した場合IOException
- 入出力エラーが発生した場合- 導入されたバージョン:
- 1.7
-
-
メソッドの詳細
-
getComment
public String getComment()zipファイル・コメントを返します。コメントがない場合はnullを返します。- 戻り値:
- zipファイルのコメント文字列。コメント文字列がない場合は、null
- 例外:
IllegalStateException
- ZIPファイルが閉じられている場合- 導入されたバージョン:
- 1.7
-
getEntry
指定された名前の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
ZIPファイル・エントリ上に順序付けされたStream
を返します。 エントリは、ZIPファイルの中央のディレクトリに存在する順番でStream
に存在します。- 戻り値:
- このZIPファイル内のエントリの順序付けされた
Stream
- 例外:
IllegalStateException
- ZIPファイルが閉じられている場合- 導入されたバージョン:
- 1.8
-
size
public int size()ZIPファイル中のエントリの数を返します。- 戻り値:
- ZIPファイル中のエントリの数
- 例外:
IllegalStateException
- ZIPファイルが閉じられている場合
-
close
public void close() throws IOExceptionZIPファイルを閉じます。このZIPファイルを閉じると、
getInputStream
メソッドの呼出しにより以前に返されたすべての入力ストリームが閉じられます。- 定義:
close
、インタフェース:AutoCloseable
- 定義:
close
、インタフェース:Closeable
- 例外:
IOException
- 入出力エラーが発生した場合
-