W3cubDocs

/OpenJDK 21

Class JarEntry

java.lang.Object
java.util.zip.ZipEntry
java.util.jar.JarEntry
All Implemented Interfaces:
Cloneable
public class JarEntry extends ZipEntry
This class is used to represent a JAR file entry.
Since:
1.2

Field Summary

Modifier and Type Field Description
static final int CENATT
Central directory (CEN) header internal file attributes field offset.
static final int CENATX
Central directory (CEN) header external file attributes field offset.
static final int CENCOM
Central directory (CEN) header comment length field offset.
static final int CENCRC
Central directory (CEN) header uncompressed file crc-32 value field offset.
static final int CENDSK
Central directory (CEN) header disk number start field offset.
static final int CENEXT
Central directory (CEN) header extra field length field offset.
static final int CENFLG
Central directory (CEN) header encrypt, decrypt flags field offset.
static final int CENHDR
Central directory (CEN) header size in bytes (including signature).
static final int CENHOW
Central directory (CEN) header compression method field offset.
static final int CENLEN
Central directory (CEN) header uncompressed size field offset.
static final int CENNAM
Central directory (CEN) header filename length field offset.
static final int CENOFF
Central directory (CEN) header LOC header offset field offset.
static final long CENSIG
Central directory (CEN) header signature.
static final int CENSIZ
Central directory (CEN) header compressed size field offset.
static final int CENTIM
Central directory (CEN) header modification time field offset.
static final int CENVEM
Central directory (CEN) header version made by field offset.
static final int CENVER
Central directory (CEN) header version needed to extract field offset.
static final int ENDCOM
End of central directory (END) header zip file comment length field offset.
static final int ENDHDR
End of central directory (END) header size in bytes (including signature).
static final int ENDOFF
End of central directory (END) header offset for the first CEN header field offset.
static final long ENDSIG
End of central directory (END) header signature.
static final int ENDSIZ
End of central directory (END) header central directory size in bytes field offset.
static final int ENDSUB
End of central directory (END) header number of entries on this disk field offset.
static final int ENDTOT
End of central directory (END) header total number of entries field offset.
static final int EXTCRC
Extra local (EXT) header uncompressed file crc-32 value field offset.
static final int EXTHDR
Extra local (EXT) header size in bytes (including signature).
static final int EXTLEN
Extra local (EXT) header uncompressed size field offset.
static final long EXTSIG
Extra local (EXT) header signature.
static final int EXTSIZ
Extra local (EXT) header compressed size field offset.
static final int LOCCRC
Local file (LOC) header uncompressed file crc-32 value field offset.
static final int LOCEXT
Local file (LOC) header extra field length field offset.
static final int LOCFLG
Local file (LOC) header general purpose bit flag field offset.
static final int LOCHDR
Local file (LOC) header size in bytes (including signature).
static final int LOCHOW
Local file (LOC) header compression method field offset.
static final int LOCLEN
Local file (LOC) header uncompressed size field offset.
static final int LOCNAM
Local file (LOC) header filename length field offset.
static final long LOCSIG
Local file (LOC) header signature.
static final int LOCSIZ
Local file (LOC) header compressed size field offset.
static final int LOCTIM
Local file (LOC) header modification time field offset.
static final int LOCVER
Local file (LOC) header version needed to extract field offset.

Fields declared in class java.util.zip.ZipEntry

DEFLATED, STORED

Constructor Summary

Constructor Description
JarEntry(String name)
Creates a new JarEntry for the specified JAR file entry name.
JarEntry(JarEntry je)
Creates a new JarEntry with fields taken from the specified JarEntry object.
JarEntry(ZipEntry ze)
Creates a new JarEntry with fields taken from the specified ZipEntry object.

Method Summary

Modifier and Type Method Description
Attributes getAttributes()
Returns the Manifest Attributes for this entry, or null if none.
Certificate[] getCertificates()
Returns the Certificate objects for this entry, or null if none.
CodeSigner[] getCodeSigners()
Returns the CodeSigner objects for this entry, or null if none.
String getRealName()
Returns the real name of this JarEntry.

Methods declared in class java.util.zip.ZipEntry

clone, getComment, getCompressedSize, getCrc, getCreationTime, getExtra, getLastAccessTime, getLastModifiedTime, getMethod, getName, getSize, getTime, getTimeLocal, hashCode, isDirectory, setComment, setCompressedSize, setCrc, setCreationTime, setExtra, setLastAccessTime, setLastModifiedTime, setMethod, setSize, setTime, setTimeLocal, toString

Methods declared in class java.lang.Object

equals, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

LOCSIG

static final long LOCSIG
Local file (LOC) header signature.
See Also:

EXTSIG

static final long EXTSIG
Extra local (EXT) header signature.
See Also:

CENSIG

static final long CENSIG
Central directory (CEN) header signature.
See Also:

ENDSIG

static final long ENDSIG
End of central directory (END) header signature.
See Also:

LOCHDR

static final int LOCHDR
Local file (LOC) header size in bytes (including signature).
See Also:

EXTHDR

static final int EXTHDR
Extra local (EXT) header size in bytes (including signature).
See Also:

CENHDR

static final int CENHDR
Central directory (CEN) header size in bytes (including signature).
See Also:

ENDHDR

static final int ENDHDR
End of central directory (END) header size in bytes (including signature).
See Also:

LOCVER

static final int LOCVER
Local file (LOC) header version needed to extract field offset.
See Also:

LOCFLG

static final int LOCFLG
Local file (LOC) header general purpose bit flag field offset.
See Also:

LOCHOW

static final int LOCHOW
Local file (LOC) header compression method field offset.
See Also:

LOCTIM

static final int LOCTIM
Local file (LOC) header modification time field offset.
See Also:

LOCCRC

static final int LOCCRC
Local file (LOC) header uncompressed file crc-32 value field offset.
See Also:

LOCSIZ

static final int LOCSIZ
Local file (LOC) header compressed size field offset.
See Also:

LOCLEN

static final int LOCLEN
Local file (LOC) header uncompressed size field offset.
See Also:

LOCNAM

static final int LOCNAM
Local file (LOC) header filename length field offset.
See Also:

LOCEXT

static final int LOCEXT
Local file (LOC) header extra field length field offset.
See Also:

EXTCRC

static final int EXTCRC
Extra local (EXT) header uncompressed file crc-32 value field offset.
See Also:

EXTSIZ

static final int EXTSIZ
Extra local (EXT) header compressed size field offset.
See Also:

EXTLEN

static final int EXTLEN
Extra local (EXT) header uncompressed size field offset.
See Also:

CENVEM

static final int CENVEM
Central directory (CEN) header version made by field offset.
See Also:

CENVER

static final int CENVER
Central directory (CEN) header version needed to extract field offset.
See Also:

CENFLG

static final int CENFLG
Central directory (CEN) header encrypt, decrypt flags field offset.
See Also:

CENHOW

static final int CENHOW
Central directory (CEN) header compression method field offset.
See Also:

CENTIM

static final int CENTIM
Central directory (CEN) header modification time field offset.
See Also:

CENCRC

static final int CENCRC
Central directory (CEN) header uncompressed file crc-32 value field offset.
See Also:

CENSIZ

static final int CENSIZ
Central directory (CEN) header compressed size field offset.
See Also:

CENLEN

static final int CENLEN
Central directory (CEN) header uncompressed size field offset.
See Also:

CENNAM

static final int CENNAM
Central directory (CEN) header filename length field offset.
See Also:

CENEXT

static final int CENEXT
Central directory (CEN) header extra field length field offset.
See Also:

CENCOM

static final int CENCOM
Central directory (CEN) header comment length field offset.
See Also:

CENDSK

static final int CENDSK
Central directory (CEN) header disk number start field offset.
See Also:

CENATT

static final int CENATT
Central directory (CEN) header internal file attributes field offset.
See Also:

CENATX

static final int CENATX
Central directory (CEN) header external file attributes field offset.
See Also:

CENOFF

static final int CENOFF
Central directory (CEN) header LOC header offset field offset.
See Also:

ENDSUB

static final int ENDSUB
End of central directory (END) header number of entries on this disk field offset.
See Also:

ENDTOT

static final int ENDTOT
End of central directory (END) header total number of entries field offset.
See Also:

ENDSIZ

static final int ENDSIZ
End of central directory (END) header central directory size in bytes field offset.
See Also:

ENDOFF

static final int ENDOFF
End of central directory (END) header offset for the first CEN header field offset.
See Also:

ENDCOM

static final int ENDCOM
End of central directory (END) header zip file comment length field offset.
See Also:

Constructor Details

JarEntry

public JarEntry(String name)
Creates a new JarEntry for the specified JAR file entry name.
Parameters:
name - the JAR file entry name
Throws:
NullPointerException - if the entry name is null
IllegalArgumentException - if the entry name is longer than 0xFFFF bytes.

JarEntry

public JarEntry(ZipEntry ze)
Creates a new JarEntry with fields taken from the specified ZipEntry object.
Parameters:
ze - the ZipEntry object to create the JarEntry from

JarEntry

public JarEntry(JarEntry je)
Creates a new JarEntry with fields taken from the specified JarEntry object.
Parameters:
je - the JarEntry to copy

Method Details

getAttributes

public Attributes getAttributes() throws IOException
Returns the Manifest Attributes for this entry, or null if none.
Returns:
the Manifest Attributes for this entry, or null if none
Throws:
IOException - if an I/O error has occurred

getCertificates

public Certificate[] getCertificates()
Returns the Certificate objects for this entry, or null if none. This method can only be called once the JarEntry has been completely verified by reading from the entry input stream until the end of the stream has been reached. Otherwise, this method will return null.

The returned certificate array comprises all the signer certificates that were used to verify this entry. Each signer certificate is followed by its supporting certificate chain (which may be empty). Each signer certificate and its supporting certificate chain are ordered bottom-to-top (i.e., with the signer certificate first and the (root) certificate authority last).

Returns:
the Certificate objects for this entry, or null if none.

getCodeSigners

public CodeSigner[] getCodeSigners()
Returns the CodeSigner objects for this entry, or null if none. This method can only be called once the JarEntry has been completely verified by reading from the entry input stream until the end of the stream has been reached. Otherwise, this method will return null.

The returned array comprises all the code signers that have signed this entry.

Returns:
the CodeSigner objects for this entry, or null if none.
Since:
1.5

getRealName

public String getRealName()
Returns the real name of this JarEntry. If this JarEntry is an entry of a multi-release jar file and the JarFile is configured to be processed as such, the name returned by this method is the path name of the versioned entry that the JarEntry represents, rather than the path name of the base entry that ZipEntry.getName() returns. If the JarEntry does not represent a versioned entry of a multi-release JarFile or the JarFile is not configured for processing a multi-release jar file, this method returns the same name that ZipEntry.getName() returns.
Returns:
the real name of the JarEntry
Since:
10

© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/jar/JarEntry.html