JarEntry (Java SE 15 & JDK 15)
Description: declaration: module: java.base, package: java.util.jar, class: JarEntry
Keywords: java.util.jar.JarEntry class

Module java.base
Package java.util.jar

# 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

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

  ### Fields declared in class java.util.zip.ZipEntry

  `DEFLATED, STORED`

- ## Constructor Summary

  Constructors
  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
    See Also:
      Constant Field Values

  - ### EXTSIG

    static final long EXTSIG
    See Also:
      Constant Field Values

  - ### CENSIG

    static final long CENSIG
    See Also:
      Constant Field Values

  - ### ENDSIG

    static final long ENDSIG
    See Also:
      Constant Field Values

  - ### LOCHDR

    static final int LOCHDR
    See Also:
      Constant Field Values

  - ### EXTHDR

    static final int EXTHDR
    See Also:
      Constant Field Values

  - ### CENHDR

    static final int CENHDR
    See Also:
      Constant Field Values

  - ### ENDHDR

    static final int ENDHDR
    See Also:
      Constant Field Values

  - ### LOCVER

    static final int LOCVER
    See Also:
      Constant Field Values

  - ### LOCFLG

    static final int LOCFLG
    See Also:
      Constant Field Values

  - ### LOCHOW

    static final int LOCHOW
    See Also:
      Constant Field Values

  - ### LOCTIM

    static final int LOCTIM
    See Also:
      Constant Field Values

  - ### LOCCRC

    static final int LOCCRC
    See Also:
      Constant Field Values

  - ### LOCSIZ

    static final int LOCSIZ
    See Also:
      Constant Field Values

  - ### LOCLEN

    static final int LOCLEN
    See Also:
      Constant Field Values

  - ### LOCNAM

    static final int LOCNAM
    See Also:
      Constant Field Values

  - ### LOCEXT

    static final int LOCEXT
    See Also:
      Constant Field Values

  - ### EXTCRC

    static final int EXTCRC
    See Also:
      Constant Field Values

  - ### EXTSIZ

    static final int EXTSIZ
    See Also:
      Constant Field Values

  - ### EXTLEN

    static final int EXTLEN
    See Also:
      Constant Field Values

  - ### CENVEM

    static final int CENVEM
    See Also:
      Constant Field Values

  - ### CENVER

    static final int CENVER
    See Also:
      Constant Field Values

  - ### CENFLG

    static final int CENFLG
    See Also:
      Constant Field Values

  - ### CENHOW

    static final int CENHOW
    See Also:
      Constant Field Values

  - ### CENTIM

    static final int CENTIM
    See Also:
      Constant Field Values

  - ### CENCRC

    static final int CENCRC
    See Also:
      Constant Field Values

  - ### CENSIZ

    static final int CENSIZ
    See Also:
      Constant Field Values

  - ### CENLEN

    static final int CENLEN
    See Also:
      Constant Field Values

  - ### CENNAM

    static final int CENNAM
    See Also:
      Constant Field Values

  - ### CENEXT

    static final int CENEXT
    See Also:
      Constant Field Values

  - ### CENCOM

    static final int CENCOM
    See Also:
      Constant Field Values

  - ### CENDSK

    static final int CENDSK
    See Also:
      Constant Field Values

  - ### CENATT

    static final int CENATT
    See Also:
      Constant Field Values

  - ### CENATX

    static final int CENATX
    See Also:
      Constant Field Values

  - ### CENOFF

    static final int CENOFF
    See Also:
      Constant Field Values

  - ### ENDSUB

    static final int ENDSUB
    See Also:
      Constant Field Values

  - ### ENDTOT

    static final int ENDTOT
    See Also:
      Constant Field Values

  - ### ENDSIZ

    static final int ENDSIZ
    See Also:
      Constant Field Values

  - ### ENDOFF

    static final int ENDOFF
    See Also:
      Constant Field Values

  - ### ENDCOM

    static final int ENDCOM
    See Also:
      Constant Field Values

- ## 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