Field Summary

Constructor Summary

Method Summary

Field Details

• MANIFEST_NAME

  public static final String MANIFEST_NAME

  The JAR manifest file name.

  See Also:

  • Constant Field Values

• LOCSIG

  static final long LOCSIG

  Local file (LOC) header signature.

  See Also:

  • Constant Field Values

• EXTSIG

  static final long EXTSIG

  Extra local (EXT) header signature.

  See Also:

  • Constant Field Values

• CENSIG

  static final long CENSIG

  Central directory (CEN) header signature.

  See Also:

  • Constant Field Values

• ENDSIG

  static final long ENDSIG

  End of central directory (END) header signature.

  See Also:

  • Constant Field Values

• LOCHDR

  static final int LOCHDR

  Local file (LOC) header size in bytes (including signature).

  See Also:

  • Constant Field Values

• EXTHDR

  static final int EXTHDR

  Extra local (EXT) header size in bytes (including signature).

  See Also:

  • Constant Field Values

• CENHDR

  static final int CENHDR

  Central directory (CEN) header size in bytes (including signature).

  See Also:

  • Constant Field Values

• ENDHDR

  static final int ENDHDR

  End of central directory (END) header size in bytes (including signature).

  See Also:

  • Constant Field Values

• LOCVER

  static final int LOCVER

  Local file (LOC) header version needed to extract field offset.

  See Also:

  • Constant Field Values

• LOCFLG

  static final int LOCFLG

  Local file (LOC) header general purpose bit flag field offset.

  See Also:

  • Constant Field Values

• LOCHOW

  static final int LOCHOW

  Local file (LOC) header compression method field offset.

  See Also:

  • Constant Field Values

• LOCTIM

  static final int LOCTIM

  Local file (LOC) header modification time field offset.

  See Also:

  • Constant Field Values

• LOCCRC

  static final int LOCCRC

  Local file (LOC) header uncompressed file crc-32 value field offset.

  See Also:

  • Constant Field Values

• LOCSIZ

  static final int LOCSIZ

  Local file (LOC) header compressed size field offset.

  See Also:

  • Constant Field Values

• LOCLEN

  static final int LOCLEN

  Local file (LOC) header uncompressed size field offset.

  See Also:

  • Constant Field Values

• LOCNAM

  static final int LOCNAM

  Local file (LOC) header filename length field offset.

  See Also:

  • Constant Field Values

• LOCEXT

  static final int LOCEXT

  Local file (LOC) header extra field length field offset.

  See Also:

  • Constant Field Values

• EXTCRC

  static final int EXTCRC

  Extra local (EXT) header uncompressed file crc-32 value field offset.

  See Also:

  • Constant Field Values

• EXTSIZ

  static final int EXTSIZ

  Extra local (EXT) header compressed size field offset.

  See Also:

  • Constant Field Values

• EXTLEN

  static final int EXTLEN

  Extra local (EXT) header uncompressed size field offset.

  See Also:

  • Constant Field Values

• CENVEM

  static final int CENVEM

  Central directory (CEN) header version made by field offset.

  See Also:

  • Constant Field Values

• CENVER

  static final int CENVER

  Central directory (CEN) header version needed to extract field offset.

  See Also:

  • Constant Field Values

• CENFLG

  static final int CENFLG

  Central directory (CEN) header encrypt, decrypt flags field offset.

  See Also:

  • Constant Field Values

• CENHOW

  static final int CENHOW

  Central directory (CEN) header compression method field offset.

  See Also:

  • Constant Field Values

• CENTIM

  static final int CENTIM

  Central directory (CEN) header modification time field offset.

  See Also:

  • Constant Field Values

• CENCRC

  static final int CENCRC

  Central directory (CEN) header uncompressed file crc-32 value field offset.

  See Also:

  • Constant Field Values

• CENSIZ

  static final int CENSIZ

  Central directory (CEN) header compressed size field offset.

  See Also:

  • Constant Field Values

• CENLEN

  static final int CENLEN

  Central directory (CEN) header uncompressed size field offset.

  See Also:

  • Constant Field Values

• CENNAM

  static final int CENNAM

  Central directory (CEN) header filename length field offset.

  See Also:

  • Constant Field Values

• CENEXT

  static final int CENEXT

  Central directory (CEN) header extra field length field offset.

  See Also:

  • Constant Field Values

• CENCOM

  static final int CENCOM

  Central directory (CEN) header comment length field offset.

  See Also:

  • Constant Field Values

• CENDSK

  static final int CENDSK

  Central directory (CEN) header disk number start field offset.

  See Also:

  • Constant Field Values

• CENATT

  static final int CENATT

  Central directory (CEN) header internal file attributes field offset.

  See Also:

  • Constant Field Values

• CENATX

  static final int CENATX

  Central directory (CEN) header external file attributes field offset.

  See Also:

  • Constant Field Values

• CENOFF

  static final int CENOFF

  Central directory (CEN) header LOC header offset field offset.

  See Also:

  • Constant Field Values

• ENDSUB

  static final int ENDSUB

  End of central directory (END) header number of entries on this disk field offset.

  See Also:

  • Constant Field Values

• ENDTOT

  static final int ENDTOT

  End of central directory (END) header total number of entries field offset.

  See Also:

  • Constant Field Values

• ENDSIZ

  static final int ENDSIZ

  End of central directory (END) header central directory size in bytes field offset.

  See Also:

  • Constant Field Values

• ENDOFF

  static final int ENDOFF

  End of central directory (END) header offset for the first CEN header field offset.

  See Also:

  • Constant Field Values

• ENDCOM

  static final int ENDCOM

  End of central directory (END) header ZIP file comment length field offset.

  See Also:

  • Constant Field Values

Constructor Details

• JarFile

  public JarFile(String name) throwsIOException

  Creates a newJarFile to read from the specified filename. TheJarFile will be verified if it is signed.

  Parameters:

  name - the name of the jar file to be opened for reading

  Throws:

  IOException - if an I/O error has occurred

• JarFile

  public JarFile(String name, boolean verify) throwsIOException

  Creates a newJarFile to read from the specified filename.

  Parameters:

  name - the name of the jar file to be opened for reading

  verify - whether or not to verify the jar file if it is signed.

  Throws:

  IOException - if an I/O error has occurred

• JarFile

  public JarFile(File file) throwsIOException

  Creates a newJarFile to read from the specifiedFile object. TheJarFile will be verified if it is signed.

  Parameters:

  file - the jar file to be opened for reading

  Throws:

  IOException - if an I/O error has occurred

• JarFile

  public JarFile(File file, boolean verify) throwsIOException

  Creates a newJarFile to read from the specifiedFile object.

  Parameters:

  file - the jar file to be opened for reading

  verify - whether or not to verify the jar file if it is signed.

  Throws:

  IOException - if an I/O error has occurred

• JarFile

  public JarFile(File file, boolean verify, int mode) throwsIOException

  Creates a newJarFile to read from the specifiedFile object in the specified mode. The mode argument must be eitherOPEN_READ orOPEN_READ | OPEN_DELETE.

  Parameters:

  file - the jar file to be opened for reading

  verify - whether or not to verify the jar file if it is signed.

  mode - the mode in which the file is to be opened

  Throws:

  IOException - if an I/O error has occurred

  IllegalArgumentException - if themode argument is invalid

  Since:

  1.3

• JarFile

  public JarFile(File file, boolean verify, int mode,Runtime.Version version) throwsIOException

  Creates a newJarFile to read from the specifiedFile object in the specified mode. The mode argument must be eitherOPEN_READ orOPEN_READ | OPEN_DELETE. The version argument, after being converted to a canonical form, is used to configure theJarFile for processing multi-release jar files.

  The canonical form derived from the version parameter isRuntime.Version.parse(Integer.toString(n)) wheren isMath.max(version.feature(), JarFile.baseVersion().feature()).

  Parameters:

  file - the jar file to be opened for reading

  verify - whether or not to verify the jar file if it is signed.

  mode - the mode in which the file is to be opened

  version - specifies the release version for a multi-release jar file

  Throws:

  IOException - if an I/O error has occurred

  IllegalArgumentException - if themode argument is invalid

  NullPointerException - ifversion isnull

  Since:

  9

Method Details

• baseVersion

  public static Runtime.Version baseVersion()

  Returns the version that represents the unversioned configuration of a multi-release jar file.

  Returns:

  the version that represents the unversioned configuration

  Since:

  9

• runtimeVersion

  public static Runtime.Version runtimeVersion()

  Returns the version that represents the effective runtime versioned configuration of a multi-release jar file.

  By default the feature version number of the returnedVersion will be equal to the feature version number ofRuntime.version(). However, if thejdk.util.jar.version property is set, the returnedVersion is derived from that property and feature version numbers may not be equal.

  Returns:

  the version that represents the runtime versioned configuration

  Since:

  9

• getVersion

  public final Runtime.Version getVersion()

  Returns the maximum version used when searching for versioned entries.

  If thisJarFile is not a multi-release jar file or is not configured to be processed as such, then the version returned will be the same as that returned frombaseVersion().

  Returns:

  the maximum version

  Since:

  9

• isMultiRelease

  public final boolean isMultiRelease()

  Indicates whether or not this jar file is a multi-release jar file.

  Returns:

  true if this JarFile is a multi-release jar file

  Since:

  9

• getManifest

  public Manifest getManifest() throwsIOException

  Returns the jar file manifest, ornull if none.

  Returns:

  the jar file manifest, ornull if none

  Throws:

  IllegalStateException - may be thrown if the jar file has been closed

  IOException - if an I/O error has occurred

• getJarEntry

  public JarEntry getJarEntry(String name)

  Returns theJarEntry for the given base entry name ornull if not found.

  If thisJarFile is a multi-release jar file and is configured to be processed as such, then a search is performed to find and return aJarEntry that is the latest versioned entry associated with the given entry name. The returnedJarEntry is the versioned entry corresponding to the given base entry name prefixed with the string"META-INF/versions/{n}/", for the largest value ofn for which an entry exists. If such a versioned entry does not exist, then theJarEntry for the base entry is returned, otherwisenull is returned if no entries are found. The initial value for the versionn is the maximum version as returned by the methodgetVersion().

  Implementation Requirements:

  This implementation invokesgetEntry(String).

  Parameters:

  name - the jar file entry name

  Returns:

  theJarEntry for the given entry name, or the versioned entry name, ornull if not found

  Throws:

  IllegalStateException - may be thrown if the jar file has been closed

  See Also:

  • JarEntry

• getEntry

  public ZipEntry getEntry(String name)

  Returns theZipEntry for the given base entry name ornull if not found.

  If thisJarFile is a multi-release jar file and is configured to be processed as such, then a search is performed to find and return aZipEntry that is the latest versioned entry associated with the given entry name. The returnedZipEntry is the versioned entry corresponding to the given base entry name prefixed with the string"META-INF/versions/{n}/", for the largest value ofn for which an entry exists. If such a versioned entry does not exist, then theZipEntry for the base entry is returned, otherwisenull is returned if no entries are found. The initial value for the versionn is the maximum version as returned by the methodgetVersion().

  Overrides:

  getEntry in class ZipFile

  Implementation Requirements:

  This implementation may return a versioned entry for the requested name even if there is not a corresponding base entry. This can occur if there is a private or package-private versioned entry that matches. If a subclass overrides this method, assure that the override method invokessuper.getEntry(name) to obtain all versioned entries.

  Parameters:

  name - the jar file entry name

  Returns:

  theZipEntry for the given entry name or the versioned entry name ornull if not found

  Throws:

  IllegalStateException - may be thrown if the jar file has been closed

  See Also:

  • ZipEntry

• entries

  public Enumeration<JarEntry> entries()

  Returns an enumeration of the jar file entries.

  Overrides:

  entries in class ZipFile

  Returns:

  an enumeration of the jar file entries

  Throws:

  IllegalStateException - may be thrown if the jar file has been closed

• stream

  public Stream<JarEntry> stream()

  Returns an orderedStream over the jar file entries. Entries appear in theStream in the order they appear in the central directory of the jar file.

  Overrides:

  stream in class ZipFile

  Returns:

  an orderedStream of entries in this jar file

  Throws:

  IllegalStateException - if the jar file has been closed

  Since:

  1.8

• versionedStream

  public Stream<JarEntry> versionedStream()

  Returns aStream of the versioned jar file entries.

  If thisJarFile is a multi-release jar file and is configured to be processed as such, then an entry in the stream is the latest versioned entry associated with the corresponding base entry name. The maximum version of the latest versioned entry is the version returned bygetVersion(). The returned stream may include an entry that only exists as a versioned entry. If the jar file is not a multi-release jar file or theJarFile is not configured for processing a multi-release jar file, this method returns the same stream thatstream() returns.

  Returns:

  stream of versioned entries

  Since:

  10

• getInputStream

  public InputStream getInputStream(ZipEntry ze) throwsIOException

  Returns an input stream for reading the contents of the specified ZIP file entry.

  Overrides:

  getInputStream in class ZipFile

  API Note:

  TheInputStream returned by this method can wrap anInflaterInputStream, whoseread(byte[], int, int) method can modify any element of the output buffer.

  Parameters:

  ze - the ZIP file entry

  Returns:

  an input stream for reading the contents of the specified ZIP file entry or null if the ZIP file entry does not exist within the jar file

  Throws:

  ZipException - if a ZIP file format error has occurred

  IOException - if an I/O error has occurred

  SecurityException - if any of the jar file entries are incorrectly signed.

  IllegalStateException - may be thrown if the jar file has been closed