src/java.base/share/classes/java/util/jar/JarEntry.java
author jboes
Tue, 24 Sep 2019 09:43:43 +0100
changeset 58288 48e480e56aad
parent 58242 94bb65cb37d3
child 58679 9c3209ff7550
child 59201 b24f4caa1411
permissions -rw-r--r--
8231186: Replace html tag <code>foo</code> with javadoc tag {@code foo} in java.base Summary: Minor coding style update of javadoc tag in any file in java.base Reviewed-by: bchristi, lancea
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
/*
58242
94bb65cb37d3 8230648: Replace @exception tag with @throws in java.base
jboes
parents: 47987
diff changeset
     2
 * Copyright (c) 1997, 2019, Oracle and/or its affiliates. All rights reserved.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     4
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
90ce3da70b43 Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    10
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
90ce3da70b43 Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
90ce3da70b43 Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
90ce3da70b43 Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    16
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
90ce3da70b43 Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    20
 *
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    23
 * questions.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    24
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    25
90ce3da70b43 Initial load
duke
parents:
diff changeset
    26
package java.util.jar;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
90ce3da70b43 Initial load
duke
parents:
diff changeset
    28
import java.io.IOException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    29
import java.util.zip.ZipEntry;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    30
import java.security.CodeSigner;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    31
import java.security.cert.Certificate;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    32
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
/**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
 * This class is used to represent a JAR file entry.
45434
4582657c7260 8181082: class-level since tag issues in java.base & java.datatransfer module
mli
parents: 25859
diff changeset
    35
 *
4582657c7260 8181082: class-level since tag issues in java.base & java.datatransfer module
mli
parents: 25859
diff changeset
    36
 * @since 1.2
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
public
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
class JarEntry extends ZipEntry {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
    Attributes attr;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
    Certificate[] certs;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
    CodeSigner[] signers;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    43
90ce3da70b43 Initial load
duke
parents:
diff changeset
    44
    /**
58288
48e480e56aad 8231186: Replace html tag <code>foo</code> with javadoc tag {@code foo} in java.base
jboes
parents: 58242
diff changeset
    45
     * Creates a new {@code JarEntry} for the specified JAR file
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    46
     * entry name.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    47
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
     * @param name the JAR file entry name
58288
48e480e56aad 8231186: Replace html tag <code>foo</code> with javadoc tag {@code foo} in java.base
jboes
parents: 58242
diff changeset
    49
     * @throws    NullPointerException if the entry name is {@code null}
58242
94bb65cb37d3 8230648: Replace @exception tag with @throws in java.base
jboes
parents: 47987
diff changeset
    50
     * @throws    IllegalArgumentException if the entry name is longer than
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
     *            0xFFFF bytes.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
    public JarEntry(String name) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
        super(name);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    55
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    56
90ce3da70b43 Initial load
duke
parents:
diff changeset
    57
    /**
58288
48e480e56aad 8231186: Replace html tag <code>foo</code> with javadoc tag {@code foo} in java.base
jboes
parents: 58242
diff changeset
    58
     * Creates a new {@code JarEntry} with fields taken from the
48e480e56aad 8231186: Replace html tag <code>foo</code> with javadoc tag {@code foo} in java.base
jboes
parents: 58242
diff changeset
    59
     * specified {@code ZipEntry} object.
48e480e56aad 8231186: Replace html tag <code>foo</code> with javadoc tag {@code foo} in java.base
jboes
parents: 58242
diff changeset
    60
     * @param ze the {@code ZipEntry} object to create the
48e480e56aad 8231186: Replace html tag <code>foo</code> with javadoc tag {@code foo} in java.base
jboes
parents: 58242
diff changeset
    61
     *           {@code JarEntry} from
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    62
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    63
    public JarEntry(ZipEntry ze) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    64
        super(ze);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    65
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    66
90ce3da70b43 Initial load
duke
parents:
diff changeset
    67
    /**
58288
48e480e56aad 8231186: Replace html tag <code>foo</code> with javadoc tag {@code foo} in java.base
jboes
parents: 58242
diff changeset
    68
     * Creates a new {@code JarEntry} with fields taken from the
48e480e56aad 8231186: Replace html tag <code>foo</code> with javadoc tag {@code foo} in java.base
jboes
parents: 58242
diff changeset
    69
     * specified {@code JarEntry} object.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    70
     *
58288
48e480e56aad 8231186: Replace html tag <code>foo</code> with javadoc tag {@code foo} in java.base
jboes
parents: 58242
diff changeset
    71
     * @param je the {@code JarEntry} to copy
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    72
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    73
    public JarEntry(JarEntry je) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    74
        this((ZipEntry)je);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    75
        this.attr = je.attr;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    76
        this.certs = je.certs;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    77
        this.signers = je.signers;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    78
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    79
90ce3da70b43 Initial load
duke
parents:
diff changeset
    80
    /**
58288
48e480e56aad 8231186: Replace html tag <code>foo</code> with javadoc tag {@code foo} in java.base
jboes
parents: 58242
diff changeset
    81
     * Returns the {@code Manifest} {@code Attributes} for this
48e480e56aad 8231186: Replace html tag <code>foo</code> with javadoc tag {@code foo} in java.base
jboes
parents: 58242
diff changeset
    82
     * entry, or {@code null} if none.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    83
     *
58288
48e480e56aad 8231186: Replace html tag <code>foo</code> with javadoc tag {@code foo} in java.base
jboes
parents: 58242
diff changeset
    84
     * @return the {@code Manifest} {@code Attributes} for this
48e480e56aad 8231186: Replace html tag <code>foo</code> with javadoc tag {@code foo} in java.base
jboes
parents: 58242
diff changeset
    85
     * entry, or {@code null} if none
19047
08210fe86260 8021408: Fix misc doclint issues in java.util and java.io
darcy
parents: 5506
diff changeset
    86
     * @throws IOException  if an I/O error has occurred
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    87
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    88
    public Attributes getAttributes() throws IOException {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    89
        return attr;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    90
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    91
90ce3da70b43 Initial load
duke
parents:
diff changeset
    92
    /**
58288
48e480e56aad 8231186: Replace html tag <code>foo</code> with javadoc tag {@code foo} in java.base
jboes
parents: 58242
diff changeset
    93
     * Returns the {@code Certificate} objects for this entry, or
48e480e56aad 8231186: Replace html tag <code>foo</code> with javadoc tag {@code foo} in java.base
jboes
parents: 58242
diff changeset
    94
     * {@code null} if none. This method can only be called once
48e480e56aad 8231186: Replace html tag <code>foo</code> with javadoc tag {@code foo} in java.base
jboes
parents: 58242
diff changeset
    95
     * the {@code JarEntry} has been completely verified by reading
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    96
     * from the entry input stream until the end of the stream has been
58288
48e480e56aad 8231186: Replace html tag <code>foo</code> with javadoc tag {@code foo} in java.base
jboes
parents: 58242
diff changeset
    97
     * reached. Otherwise, this method will return {@code null}.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    98
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    99
     * <p>The returned certificate array comprises all the signer certificates
90ce3da70b43 Initial load
duke
parents:
diff changeset
   100
     * that were used to verify this entry. Each signer certificate is
90ce3da70b43 Initial load
duke
parents:
diff changeset
   101
     * followed by its supporting certificate chain (which may be empty).
90ce3da70b43 Initial load
duke
parents:
diff changeset
   102
     * Each signer certificate and its supporting certificate chain are ordered
90ce3da70b43 Initial load
duke
parents:
diff changeset
   103
     * bottom-to-top (i.e., with the signer certificate first and the (root)
90ce3da70b43 Initial load
duke
parents:
diff changeset
   104
     * certificate authority last).
90ce3da70b43 Initial load
duke
parents:
diff changeset
   105
     *
58288
48e480e56aad 8231186: Replace html tag <code>foo</code> with javadoc tag {@code foo} in java.base
jboes
parents: 58242
diff changeset
   106
     * @return the {@code Certificate} objects for this entry, or
48e480e56aad 8231186: Replace html tag <code>foo</code> with javadoc tag {@code foo} in java.base
jboes
parents: 58242
diff changeset
   107
     * {@code null} if none.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   108
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   109
    public Certificate[] getCertificates() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   110
        return certs == null ? null : certs.clone();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   111
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   112
90ce3da70b43 Initial load
duke
parents:
diff changeset
   113
    /**
58288
48e480e56aad 8231186: Replace html tag <code>foo</code> with javadoc tag {@code foo} in java.base
jboes
parents: 58242
diff changeset
   114
     * Returns the {@code CodeSigner} objects for this entry, or
48e480e56aad 8231186: Replace html tag <code>foo</code> with javadoc tag {@code foo} in java.base
jboes
parents: 58242
diff changeset
   115
     * {@code null} if none. This method can only be called once
48e480e56aad 8231186: Replace html tag <code>foo</code> with javadoc tag {@code foo} in java.base
jboes
parents: 58242
diff changeset
   116
     * the {@code JarEntry} has been completely verified by reading
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   117
     * from the entry input stream until the end of the stream has been
58288
48e480e56aad 8231186: Replace html tag <code>foo</code> with javadoc tag {@code foo} in java.base
jboes
parents: 58242
diff changeset
   118
     * reached. Otherwise, this method will return {@code null}.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   119
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   120
     * <p>The returned array comprises all the code signers that have signed
90ce3da70b43 Initial load
duke
parents:
diff changeset
   121
     * this entry.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   122
     *
58288
48e480e56aad 8231186: Replace html tag <code>foo</code> with javadoc tag {@code foo} in java.base
jboes
parents: 58242
diff changeset
   123
     * @return the {@code CodeSigner} objects for this entry, or
48e480e56aad 8231186: Replace html tag <code>foo</code> with javadoc tag {@code foo} in java.base
jboes
parents: 58242
diff changeset
   124
     * {@code null} if none.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   125
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   126
     * @since 1.5
90ce3da70b43 Initial load
duke
parents:
diff changeset
   127
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   128
    public CodeSigner[] getCodeSigners() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   129
        return signers == null ? null : signers.clone();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   130
    }
47987
85ea7e83af30 8189611: JarFile versioned stream and real name support
sherman
parents: 47216
diff changeset
   131
85ea7e83af30 8189611: JarFile versioned stream and real name support
sherman
parents: 47216
diff changeset
   132
    /**
85ea7e83af30 8189611: JarFile versioned stream and real name support
sherman
parents: 47216
diff changeset
   133
     * Returns the real name of this {@code JarEntry}.
85ea7e83af30 8189611: JarFile versioned stream and real name support
sherman
parents: 47216
diff changeset
   134
     *
85ea7e83af30 8189611: JarFile versioned stream and real name support
sherman
parents: 47216
diff changeset
   135
     * If this {@code JarEntry} is an entry of a
85ea7e83af30 8189611: JarFile versioned stream and real name support
sherman
parents: 47216
diff changeset
   136
     * <a href="JarFile.html#multirelease">multi-release jar file</a> and the
85ea7e83af30 8189611: JarFile versioned stream and real name support
sherman
parents: 47216
diff changeset
   137
     * {@code JarFile} is configured to be processed as such, the name returned
85ea7e83af30 8189611: JarFile versioned stream and real name support
sherman
parents: 47216
diff changeset
   138
     * by this method is the path name of the versioned entry that the
85ea7e83af30 8189611: JarFile versioned stream and real name support
sherman
parents: 47216
diff changeset
   139
     * {@code JarEntry} represents, rather than the path name of the base entry
85ea7e83af30 8189611: JarFile versioned stream and real name support
sherman
parents: 47216
diff changeset
   140
     * that {@link #getName()} returns. If the {@code JarEntry} does not represent
85ea7e83af30 8189611: JarFile versioned stream and real name support
sherman
parents: 47216
diff changeset
   141
     * a versioned entry of a multi-release {@code JarFile} or the {@code JarFile}
85ea7e83af30 8189611: JarFile versioned stream and real name support
sherman
parents: 47216
diff changeset
   142
     * is not configured for processing a multi-release jar file, this method
85ea7e83af30 8189611: JarFile versioned stream and real name support
sherman
parents: 47216
diff changeset
   143
     * returns the same name that {@link #getName()} returns.
85ea7e83af30 8189611: JarFile versioned stream and real name support
sherman
parents: 47216
diff changeset
   144
     *
85ea7e83af30 8189611: JarFile versioned stream and real name support
sherman
parents: 47216
diff changeset
   145
     * @return the real name of the JarEntry
85ea7e83af30 8189611: JarFile versioned stream and real name support
sherman
parents: 47216
diff changeset
   146
     *
85ea7e83af30 8189611: JarFile versioned stream and real name support
sherman
parents: 47216
diff changeset
   147
     * @since 10
85ea7e83af30 8189611: JarFile versioned stream and real name support
sherman
parents: 47216
diff changeset
   148
     */
85ea7e83af30 8189611: JarFile versioned stream and real name support
sherman
parents: 47216
diff changeset
   149
    public String getRealName() {
85ea7e83af30 8189611: JarFile versioned stream and real name support
sherman
parents: 47216
diff changeset
   150
        return super.getName();
85ea7e83af30 8189611: JarFile versioned stream and real name support
sherman
parents: 47216
diff changeset
   151
    }
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   152
}