Added in API level 1

ZipInputStream

public class ZipInputStream
extends InflaterInputStream

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

Known direct subclasses

JarInputStream

JarInputStream The JarInputStream class is used to read the contents of a JAR file from any input stream.

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

Summary

Constants
`int`	`CENATT`
`int`	`CENATX`
`int`	`CENCOM`
`int`	`CENCRC`
`int`	`CENDSK`
`int`	`CENEXT`
`int`	`CENFLG`
`int`	`CENHDR`
`int`	`CENHOW`
`int`	`CENLEN`
`int`	`CENNAM`
`int`	`CENOFF`
`long`	`CENSIG`
`int`	`CENSIZ`
`int`	`CENTIM`
`int`	`CENVEM`
`int`	`CENVER`
`int`	`ENDCOM`
`int`	`ENDHDR`
`int`	`ENDOFF`
`long`	`ENDSIG`
`int`	`ENDSIZ`
`int`	`ENDSUB`
`int`	`ENDTOT`
`int`	`EXTCRC`
`int`	`EXTHDR`
`int`	`EXTLEN`
`long`	`EXTSIG`
`int`	`EXTSIZ`
`int`	`LOCCRC`
`int`	`LOCEXT`
`int`	`LOCFLG`
`int`	`LOCHDR`
`int`	`LOCHOW`
`int`	`LOCLEN`
`int`	`LOCNAM`
`long`	`LOCSIG`
`int`	`LOCSIZ`
`int`	`LOCTIM`
`int`	`LOCVER`

Inherited fields

From class java.util.zip.InflaterInputStream

`protected byte[]`	`buf` Input buffer for decompression.
`protected boolean`	`closed` This field was deprecated in API level 29. This field will be removed from a future version of Android and should not be used. Subclasses that access this field need to be modified to keep track of their own closed state by overriding close().
`protected Inflater`	`inf` Decompressor for this stream.
`protected int`	`len` Length of input buffer.

From class java.io.FilterInputStream


    protected
    
    
    InputStream

in

The input stream to be filtered.

Public constructors
`ZipInputStream(InputStream in)` Creates a new ZIP input stream.
`ZipInputStream(InputStream in, Charset charset)` Creates a new ZIP input stream.

Public methods
`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.
`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.

Protected methods
`ZipEntry`	`createZipEntry(String name)` Creates a new `ZipEntry` object for the specified entry name.

Inherited methods

From class


        
          java.util.zip.InflaterInputStream

`int`	`available()` Returns 0 after EOF has been reached, otherwise always return 1.
`void`	`close()` Closes this input stream and releases any system resources associated with the stream.
`void`	`fill()` Fills input buffer with more data to decompress.
`void`	`mark(int readlimit)` Marks the current position in this input stream.
`boolean`	`markSupported()` Tests if this input stream supports the `mark` and `reset` methods.
`int`	`read()` Reads a byte of uncompressed data.
`int`	`read(byte[] b, int off, int len)` Reads uncompressed data into an array of bytes.
`void`	`reset()` Repositions this stream to the position at the time the `mark` method was last called on this input stream.
`long`	`skip(long n)` Skips specified number of bytes of uncompressed data.

From class


        
          java.io.FilterInputStream

`int`	`available()` Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking by the next caller of a method for this input stream.
`void`	`close()` Closes this input stream and releases any system resources associated with the stream.
`void`	`mark(int readlimit)` Marks the current position in this input stream.
`boolean`	`markSupported()` Tests if this input stream supports the `mark` and `reset` methods.
`int`	`read()` Reads the next byte of data from this input stream.
`int`	`read(byte[] b, int off, int len)` Reads up to `len` bytes of data from this input stream into an array of bytes.
`int`	`read(byte[] b)` Reads up to `b.length` bytes of data from this input stream into an array of bytes.
`void`	`reset()` Repositions this stream to the position at the time the `mark` method was last called on this input stream.
`long`	`skip(long n)` Skips over and discards `n` bytes of data from the input stream.

From class


        
          java.io.InputStream

`int`	`available()` Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking, which may be 0, or 0 when end of stream is detected.
`void`	`close()` Closes this input stream and releases any system resources associated with the stream.
`void`	`mark(int readlimit)` Marks the current position in this input stream.
`boolean`	`markSupported()` Tests if this input stream supports the `mark` and `reset` methods.
`static InputStream`	`nullInputStream()` Returns a new `InputStream` that reads no bytes.
`int`	`read(byte[] b)` Reads some number of bytes from the input stream and stores them into the buffer array `b`.
`abstract int`	`read()` Reads the next byte of data from the input stream.
`int`	`read(byte[] b, int off, int len)` Reads up to `len` bytes of data from the input stream into an array of bytes.
`byte[]`	`readAllBytes()` Reads all remaining bytes from the input stream.
`int`	`readNBytes(byte[] b, int off, int len)` Reads the requested number of bytes from the input stream into the given byte array.
`byte[]`	`readNBytes(int len)` Reads up to a specified number of bytes from the input stream.
`void`	`reset()` Repositions this stream to the position at the time the `mark` method was last called on this input stream.
`long`	`skip(long n)` Skips over and discards `n` bytes of data from this input stream.
`void`	`skipNBytes(long n)` Skips over and discards exactly `n` bytes of data from this input stream.
`long`	`transferTo(OutputStream out)` Reads all bytes from this input stream and writes the bytes to the given output stream in the order that they are read.

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          java.io.Closeable


      close()

Closes this stream and releases any system resources associated with it.

From interface


        
          java.lang.AutoCloseable


      close()

Closes this resource, relinquishing any underlying resources.

Constants

CENATT

Added in API level 21

public static final int CENATT

Constant Value: 36 (0x00000024)

CENATX

Added in API level 21

public static final int CENATX

Constant Value: 38 (0x00000026)

CENCOM

Added in API level 21

public static final int CENCOM

Constant Value: 32 (0x00000020)

CENCRC

Added in API level 21

public static final int CENCRC

Constant Value: 16 (0x00000010)

CENDSK

Added in API level 21

public static final int CENDSK

Constant Value: 34 (0x00000022)

CENEXT

Added in API level 21

public static final int CENEXT

Constant Value: 30 (0x0000001e)

CENFLG

Added in API level 21

public static final int CENFLG

Constant Value: 8 (0x00000008)

CENHDR

Added in API level 21

public static final int CENHDR

Constant Value: 46 (0x0000002e)

CENHOW

Added in API level 21

public static final int CENHOW

Constant Value: 10 (0x0000000a)

CENLEN

Added in API level 21

public static final int CENLEN

Constant Value: 24 (0x00000018)

CENNAM

Added in API level 21

public static final int CENNAM

Constant Value: 28 (0x0000001c)

CENOFF

Added in API level 21

public static final int CENOFF

Constant Value: 42 (0x0000002a)

CENSIG

Added in API level 21

public static final long CENSIG

Constant Value: 33639248 (0x0000000002014b50)

CENSIZ

Added in API level 21

public static final int CENSIZ

Constant Value: 20 (0x00000014)

CENTIM

Added in API level 21

public static final int CENTIM

Constant Value: 12 (0x0000000c)

CENVEM

Added in API level 21

public static final int CENVEM

Constant Value: 4 (0x00000004)

CENVER

Added in API level 21

public static final int CENVER

Constant Value: 6 (0x00000006)

ENDCOM

Added in API level 21

public static final int ENDCOM

Constant Value: 20 (0x00000014)

ENDHDR

Added in API level 21

public static final int ENDHDR

Constant Value: 22 (0x00000016)

ENDOFF

Added in API level 21

public static final int ENDOFF

Constant Value: 16 (0x00000010)

ENDSIG

Added in API level 21

public static final long ENDSIG

Constant Value: 101010256 (0x0000000006054b50)

ENDSIZ

Added in API level 21

public static final int ENDSIZ

Constant Value: 12 (0x0000000c)

ENDSUB

Added in API level 21

public static final int ENDSUB

Constant Value: 8 (0x00000008)

ENDTOT

Added in API level 21

public static final int ENDTOT

Constant Value: 10 (0x0000000a)

EXTCRC

Added in API level 21

public static final int EXTCRC

Constant Value: 4 (0x00000004)

EXTHDR

Added in API level 21

public static final int EXTHDR

Constant Value: 16 (0x00000010)

EXTLEN

Added in API level 21

public static final int EXTLEN

Constant Value: 12 (0x0000000c)

EXTSIG

Added in API level 21

public static final long EXTSIG

Constant Value: 134695760 (0x0000000008074b50)

EXTSIZ

Added in API level 21

public static final int EXTSIZ

Constant Value: 8 (0x00000008)

LOCCRC

Added in API level 21

public static final int LOCCRC

Constant Value: 14 (0x0000000e)

LOCEXT

Added in API level 21

public static final int LOCEXT

Constant Value: 28 (0x0000001c)

LOCFLG

Added in API level 21

public static final int LOCFLG

Constant Value: 6 (0x00000006)

LOCHDR

Added in API level 21

public static final int LOCHDR

Constant Value: 30 (0x0000001e)

LOCHOW

Added in API level 21

public static final int LOCHOW

Constant Value: 8 (0x00000008)

LOCLEN

Added in API level 21

public static final int LOCLEN

Constant Value: 22 (0x00000016)

LOCNAM

Added in API level 21

public static final int LOCNAM

Constant Value: 26 (0x0000001a)

LOCSIG

Added in API level 21

public static final long LOCSIG

Constant Value: 67324752 (0x0000000004034b50)

LOCSIZ

Added in API level 21

public static final int LOCSIZ

Constant Value: 18 (0x00000012)

LOCTIM

Added in API level 21

public static final int LOCTIM

Constant Value: 10 (0x0000000a)

LOCVER

Added in API level 21

public static final int LOCVER

Constant Value: 4 (0x00000004)

Public constructors

ZipInputStream

Added in API level 1

public ZipInputStream (InputStream in)

Creates a new ZIP input stream.

The UTF-8 charset is used to decode the entry names.

Parameters
`in`	`InputStream`: the actual input stream

ZipInputStream

Added in API level 24

public ZipInputStream (InputStream in, 
                Charset charset)

Creates a new ZIP input stream.

Parameters
`in`	`InputStream`: the actual input stream
`charset`	`Charset`: The charset to be used to decode the ZIP entry name (ignored if the language encoding bit of the ZIP entry's general purpose bit flag is set).

Public methods

available

Added in API level 1

public int available ()

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.

Returns
`int`	1 before EOF and 0 after EOF has reached for current entry.

Throws
`IOException`	if an I/O error occurs.

close

Added in API level 1

public void close ()

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

Throws
`IOException`	if an I/O error has occurred

closeEntry

Added in API level 1

public void closeEntry ()

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

Throws
`ZipException`	if a ZIP file error has occurred
`IOException`	if an I/O error has occurred

getNextEntry

Added in API level 1

public ZipEntry getNextEntry ()

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

If the app targets Android U or above, zip file entry names containing ".." or starting with "/" passed here will throw a ZipException. For more details, see ZipPathValidator.

Returns
`ZipEntry`	the next ZIP file entry, or null if there are no more entries

Throws
`ZipException`	if (1) a ZIP file error has occurred or (2) `targetSdkVersion >= BUILD.VERSION_CODES.UPSIDE_DOWN_CAKE` and (the `name` argument contains ".." or starts with "/").
`IOException`	if an I/O error has occurred

read

Added in API level 1

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

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.

Parameters
`b`	`byte`: the buffer into which the data is read
`off`	`int`: the start offset in the destination array `b`
`len`	`int`: the maximum number of bytes read

Returns
`int`	the actual number of bytes read, or -1 if the end of the entry is reached

Throws
`NullPointerException`	if `b` is `null`.
`IndexOutOfBoundsException`	if `off` is negative, `len` is negative, or `len` is greater than `b.length - off`
`ZipException`	if a ZIP file error has occurred
`IOException`	if an I/O error has occurred

skip

Added in API level 1

public long skip (long n)

Skips specified number of bytes in the current ZIP entry.

Parameters
`n`	`long`: the number of bytes to skip

Returns
`long`	the actual number of bytes skipped

Throws
`ZipException`	if a ZIP file error has occurred
`IOException`	if an I/O error has occurred
`IllegalArgumentException`	if `n < 0`

Protected methods

createZipEntry

Added in API level 1

protected ZipEntry createZipEntry (String name)

Creates a new ZipEntry object for the specified entry name.

Parameters
`name`	`String`: the ZIP file entry name

Returns
`ZipEntry`	the ZipEntry just created

Feb	MAR	Apr
	26
2022	2023	2024