ZipInputStream (Java Platform SE 6)

This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

java.util.zip
class ZipInputStream

java.lang.Object
  java.io.InputStream
      java.io.FilterInputStream
          java.util.zip.InflaterInputStream
              java.util.zip.ZipInputStream

All Implemented Interfaces:: Closeable, ZipConstants

Direct Known Subclasses:: JarInputStream

Most common way to construct:

InputStream is = …;

ZipInputStream zis = new ZipInputStream(is);

Based on 35 examples

public class ZipInputStream
extends InflaterInputStream
implements ZipConstants

This class implements an input stream filter for reading files in the ZIP file format. Includes support for both compressed and uncompressed entries.

Field Summary

Fields inherited from class java.util.zip.InflaterInputStream
`buf, inf, len`

Fields inherited from class java.io.FilterInputStream
`in`

Constructor Summary
`ZipInputStream(InputStream in)` Creates a new ZIP input stream.

Method Summary
`int`	`available()` Returns 0 after EOF has reached for the current entry data, otherwise always return 1.
`void`	`close()` Closes this input stream and releases any system resources associated with the stream.
`void`	`closeEntry()` Closes the current ZIP entry and positions the stream for reading the next entry.
`protected ZipEntry`	`createZipEntry(String name)` Creates a new `ZipEntry` object for the specified entry name.
`ZipEntry`	`getNextEntry()` Reads the next ZIP file entry and positions the stream at the beginning of the entry data.
`int`	`read(byte[] b, int off, int len)` Reads from the current ZIP entry into an array of bytes.
`long`	`skip(long n)` Skips specified number of bytes in the current ZIP entry.

Methods inherited from class java.util.zip.InflaterInputStream
`available, close, fill, mark, markSupported, read, read, reset, skip`

Methods inherited from class java.io.FilterInputStream
`available, close, mark, markSupported, read, read, read, reset, skip`

Methods inherited from class java.io.InputStream
`available, close, mark, markSupported, read, read, read, reset, skip`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

ZipInputStream

public ZipInputStream(InputStream in)

Creates a new ZIP input stream.

Parameters:: in - the actual input stream

Method Detail

available

public int available()
              throws IOException

Returns 0 after EOF has reached for the current entry data, otherwise always return 1.

Programs should not count on this method to return the actual number of bytes that could be read without blocking.

Overrides:: available in class InflaterInputStream
Returns:: 1 before EOF and 0 after EOF has reached for current entry.
Throws:: IOException - if an I/O error occurs.

close

public void close()
           throws IOException

Closes this input stream and releases any system resources associated with the stream.

Overrides:: close in class InflaterInputStream
Throws:: IOException - if an I/O error has occurred

closeEntry

public void closeEntry()
                throws IOException

Closes the current ZIP entry and positions the stream for reading the next entry.

Throws:: IOException - if an I/O error has occurred

createZipEntry

protected ZipEntry createZipEntry(String name)

Creates a new ZipEntry object for the specified entry name.

Parameters:: name - the ZIP file entry name
Returns:: the ZipEntry just created

getNextEntry

public ZipEntry getNextEntry()
                      throws IOException

Reads the next ZIP file entry and positions the stream at the beginning of the entry data.

Returns:: the next ZIP file entry, or null if there are no more entries
Throws:: IOException - if an I/O error has occurred

read

public int read(byte[] b,
                int off,
                int len)
         throws IOException

Reads from the current ZIP entry into an array of bytes. If len is not zero, the method blocks until some input is available; otherwise, no bytes are read and 0 is returned.

Overrides:: read in class InflaterInputStream
Parameters:: b - the buffer into which the data is read; off - the start offset in the destination array b; len - the maximum number of bytes read
Returns:: the actual number of bytes read, or -1 if the end of the entry is reached
Throws:: IOException - if an I/O error has occurred

skip

public long skip(long n)
          throws IOException

Skips specified number of bytes in the current ZIP entry.

Overrides:: skip in class InflaterInputStream
Parameters:: n - the number of bytes to skip
Returns:: the actual number of bytes skipped
Throws:: IOException - if an I/O error has occurred