src/java.base/share/classes/java/util/zip/package-info.java
author erikj
Tue, 12 Sep 2017 19:03:39 +0200
changeset 47216 71c04702a3d5
parent 45433 jdk/src/java.base/share/classes/java/util/zip/package-info.java@01ecdcf197df
child 50238 a9307f400f5a
permissions -rw-r--r--
8187443: Forest Consolidation: Move files to unified layout Reviewed-by: darcy, ihse
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
27737
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
     1
/*
45433
01ecdcf197df 8181290: Invalid HTML 5 in core-libs docs
jjg
parents: 27737
diff changeset
     2
 * Copyright (c) 1998, 2017, Oracle and/or its affiliates. All rights reserved.
27737
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
     4
 *
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
    10
 *
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
    15
 * accompanied this code).
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
    16
 *
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
    20
 *
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
    23
 * questions.
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
    24
 */
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    25
27737
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
    26
/**
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
    27
 * Provides classes for reading and writing the standard ZIP and GZIP file
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
    28
 * formats. Also includes classes for compressing and decompressing data using
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
    29
 * the DEFLATE compression algorithm, which is used by the ZIP and GZIP file
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
    30
 * formats. Additionally, there are utility classes for computing the CRC-32,
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
    31
 * CRC-32C and Adler-32 checksums of arbitrary input streams.
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
    32
 *
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
    33
 * <h2>Package Specification</h2>
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
    34
 *
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
    35
 * <ul>
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
    36
 *     <li><a href="http://www.info-zip.org/doc/appnote-19970311-iz.zip">
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
    37
 *         Info-ZIP Application Note 970311</a> - a detailed description of
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
    38
 *         the Info-ZIP format upon which the {@code java.util.zip} classes
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
    39
 *         are based.
45433
01ecdcf197df 8181290: Invalid HTML 5 in core-libs docs
jjg
parents: 27737
diff changeset
    40
 *     <li><a id="zip64">An implementation may optionally support the
27737
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
    41
 *         ZIP64(tm) format extensions defined by the</a>
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
    42
 *         <a href="http://www.pkware.com/documents/casestudies/APPNOTE.TXT">
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
    43
 *         PKWARE ZIP File Format Specification</a>. The ZIP64(tm) format
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
    44
 *         extensions are used to overcome the size limitations of the
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
    45
 *         original ZIP format.
45433
01ecdcf197df 8181290: Invalid HTML 5 in core-libs docs
jjg
parents: 27737
diff changeset
    46
 *     <li><a id="lang_encoding">APPENDIX D of</a>
27737
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
    47
 *         <a href="http://www.pkware.com/documents/casestudies/APPNOTE.TXT">
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
    48
 *         PKWARE ZIP File Format Specification</a> - Language Encoding Flag
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
    49
 *         (EFS) to encode ZIP entry filename and comment fields using UTF-8.
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
    50
 *     <li><a href="http://www.ietf.org/rfc/rfc1950.txt">
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
    51
 *         ZLIB Compressed Data Format Specification version 3.3</a>
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
    52
 *         &nbsp;
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
    53
 *         <a href="http://www.ietf.org/rfc/rfc1950.txt.pdf">(pdf)</a>
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
    54
 *         (RFC 1950)
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
    55
 *     <li><a href="http://www.ietf.org/rfc/rfc1951.txt">
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
    56
 *         DEFLATE Compressed Data Format Specification version 1.3</a>
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
    57
 *         &nbsp;
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
    58
 *         <a href="http://www.ietf.org/rfc/rfc1951.txt.pdf">(pdf)</a>
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
    59
 *         (RFC 1951)
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
    60
 *     <li><a href="http://www.ietf.org/rfc/rfc1952.txt">
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
    61
 *         GZIP file format specification version 4.3</a>
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
    62
 *         &nbsp;
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
    63
 *         <a href="http://www.ietf.org/rfc/rfc1952.txt.pdf">(pdf)</a>
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
    64
 *         (RFC 1952)
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
    65
 *     <li>CRC-32 checksum is described in RFC 1952 (above)
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
    66
 *     <li>CRC-32C checksum is described in
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
    67
 *         <a href="http://www.ietf.org/rfc/rfc3720.txt">Internet Small
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
    68
 *         Computer Systems Interface (iSCSI)</a>
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
    69
 *         &nbsp;
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
    70
 *         <a href="http://www.ietf.org/rfc/rfc3720.txt.pdf">(pdf)</a>
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
    71
 *         (RFC 3720)
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
    72
 *     <li>Adler-32 checksum is described in RFC 1950 (above)
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
    73
 * </ul>
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
    74
 *
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
    75
 * @since 1.1
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
    76
 */
0a3fb0529425 6321472: Add CRC-32C API
sherman
parents: 25859
diff changeset
    77
package java.util.zip;