Skip to content

Most visited

Recently visited

navigation

JarInputStream

public class JarInputStream
extends ZipInputStream

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


The JarInputStream class is used to read the contents of a JAR file from any input stream. It extends the class java.util.zip.ZipInputStream with support for reading an optional Manifest entry. The Manifest can be used to store meta-information about the JAR file and its entries.

See also:

Summary

Inherited constants

From class java.util.zip.ZipInputStream

Inherited fields

From class java.util.zip.InflaterInputStream
From class java.io.FilterInputStream

Public constructors

JarInputStream(InputStream in)

Creates a new JarInputStream and reads the optional manifest.

JarInputStream(InputStream in, boolean verify)

Creates a new JarInputStream and reads the optional manifest.

Public methods

Manifest getManifest()

Returns the Manifest for this JAR file, or null if none.

ZipEntry getNextEntry()

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

JarEntry getNextJarEntry()

Reads the next JAR 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 JAR file entry into an array of bytes.

Protected methods

ZipEntry createZipEntry(String name)

Creates a new JarEntry (ZipEntry) for the specified JAR file entry name.

Inherited methods

From class java.util.zip.ZipInputStream
From class java.util.zip.InflaterInputStream
From class java.io.FilterInputStream
From class java.io.InputStream
From class java.lang.Object
From interface java.io.Closeable
From interface java.lang.AutoCloseable

Public constructors

JarInputStream

Added in API level 1
JarInputStream (InputStream in)

Creates a new JarInputStream and reads the optional manifest. If a manifest is present, also attempts to verify the signatures if the JarInputStream is signed.

Parameters
in InputStream: the actual input stream
Throws
IOException if an I/O error has occurred

JarInputStream

Added in API level 1
JarInputStream (InputStream in, 
                boolean verify)

Creates a new JarInputStream and reads the optional manifest. If a manifest is present and verify is true, also attempts to verify the signatures if the JarInputStream is signed.

Parameters
in InputStream: the actual input stream
verify boolean: whether or not to verify the JarInputStream if it is signed.
Throws
IOException if an I/O error has occurred

Public methods

getManifest

Added in API level 1
Manifest getManifest ()

Returns the Manifest for this JAR file, or null if none.

Returns
Manifest the Manifest for this JAR file, or null if none.

getNextEntry

Added in API level 1
ZipEntry getNextEntry ()

Reads the next ZIP file entry and positions the stream at the beginning of the entry data. If verification has been enabled, any invalid signature detected while positioning the stream for the next entry will result in an exception.

Returns
ZipEntry the next ZIP file entry, or null if there are no more entries
Throws
ZipException if a ZIP file error has occurred
IOException if an I/O error has occurred
SecurityException if any of the jar file entries are incorrectly signed.

getNextJarEntry

Added in API level 1
JarEntry getNextJarEntry ()

Reads the next JAR file entry and positions the stream at the beginning of the entry data. If verification has been enabled, any invalid signature detected while positioning the stream for the next entry will result in an exception.

Returns
JarEntry the next JAR file entry, or null if there are no more entries
Throws
ZipException if a ZIP file error has occurred
IOException if an I/O error has occurred
SecurityException if any of the jar file entries are incorrectly signed.

read

Added in API level 1
int read (byte[] b, 
                int off, 
                int len)

Reads from the current JAR file 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. If verification has been enabled, any invalid signature on the current entry will be reported at some point before the end of the entry is reached.

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 to 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
SecurityException if any of the jar file entries are incorrectly signed.

Protected methods

createZipEntry

Added in API level 1
ZipEntry createZipEntry (String name)

Creates a new JarEntry (ZipEntry) for the specified JAR file entry name. The manifest attributes of the specified JAR file entry name will be copied to the new JarEntry.

Parameters
name String: the name of the JAR/ZIP file entry
Returns
ZipEntry the JarEntry object just created
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a one-minute survey?
Help us improve Android tools and documentation.