langtools/src/jdk.compiler/share/classes/com/sun/tools/javac/file/ZipArchive.java
author jlahoda
Wed, 27 Aug 2014 07:44:00 +0200
changeset 26266 2d24bda701dc
parent 25874 83c19f00452c
child 27225 8369cde9152a
permissions -rw-r--r--
8056061: Mark implementations of public interfaces with an annotation Summary: Adding @DefinedBy annotation to mark methods that implement public API methods; annotating the methods; adding a coding rules analyzer to enforce all such methods are annotated. Reviewed-by: jjg, mcimadamore, jfranck Contributed-by: jan.lahoda@oracle.com, jonathan.gibbons@oracle.com
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
810
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
     1
/*
5520
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 4073
diff changeset
     2
 * Copyright (c) 2005, 2009, Oracle and/or its affiliates. All rights reserved.
810
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
     4
 *
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
5520
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 4073
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
810
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
5520
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 4073
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
810
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    10
 *
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    15
 * accompanied this code).
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    16
 *
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    20
 *
5520
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 4073
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 4073
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 4073
diff changeset
    23
 * questions.
810
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    24
 */
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    25
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    26
package com.sun.tools.javac.file;
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    27
1205
b316e32eb90c 6508981: cleanup file separator handling in JavacFileManager
jjg
parents: 810
diff changeset
    28
import java.io.File;
810
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    29
import java.io.IOException;
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    30
import java.io.InputStream;
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    31
import java.io.OutputStream;
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    32
import java.io.Writer;
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    33
import java.net.URI;
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    34
import java.nio.ByteBuffer;
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    35
import java.nio.CharBuffer;
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    36
import java.nio.charset.CharsetDecoder;
1205
b316e32eb90c 6508981: cleanup file separator handling in JavacFileManager
jjg
parents: 810
diff changeset
    37
import java.util.Enumeration;
b316e32eb90c 6508981: cleanup file separator handling in JavacFileManager
jjg
parents: 810
diff changeset
    38
import java.util.HashMap;
b316e32eb90c 6508981: cleanup file separator handling in JavacFileManager
jjg
parents: 810
diff changeset
    39
import java.util.Map;
b316e32eb90c 6508981: cleanup file separator handling in JavacFileManager
jjg
parents: 810
diff changeset
    40
import java.util.Set;
b316e32eb90c 6508981: cleanup file separator handling in JavacFileManager
jjg
parents: 810
diff changeset
    41
import java.util.zip.ZipEntry;
b316e32eb90c 6508981: cleanup file separator handling in JavacFileManager
jjg
parents: 810
diff changeset
    42
import java.util.zip.ZipFile;
b316e32eb90c 6508981: cleanup file separator handling in JavacFileManager
jjg
parents: 810
diff changeset
    43
b316e32eb90c 6508981: cleanup file separator handling in JavacFileManager
jjg
parents: 810
diff changeset
    44
import javax.tools.JavaFileObject;
b316e32eb90c 6508981: cleanup file separator handling in JavacFileManager
jjg
parents: 810
diff changeset
    45
b316e32eb90c 6508981: cleanup file separator handling in JavacFileManager
jjg
parents: 810
diff changeset
    46
import com.sun.tools.javac.file.JavacFileManager.Archive;
b316e32eb90c 6508981: cleanup file separator handling in JavacFileManager
jjg
parents: 810
diff changeset
    47
import com.sun.tools.javac.file.RelativePath.RelativeDirectory;
b316e32eb90c 6508981: cleanup file separator handling in JavacFileManager
jjg
parents: 810
diff changeset
    48
import com.sun.tools.javac.file.RelativePath.RelativeFile;
26266
2d24bda701dc 8056061: Mark implementations of public interfaces with an annotation
jlahoda
parents: 25874
diff changeset
    49
import com.sun.tools.javac.util.DefinedBy;
2d24bda701dc 8056061: Mark implementations of public interfaces with an annotation
jlahoda
parents: 25874
diff changeset
    50
import com.sun.tools.javac.util.DefinedBy.Api;
1205
b316e32eb90c 6508981: cleanup file separator handling in JavacFileManager
jjg
parents: 810
diff changeset
    51
import com.sun.tools.javac.util.List;
4073
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
    52
import java.lang.ref.Reference;
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
    53
import java.lang.ref.SoftReference;
810
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    54
3380
a6c2bcab0fec 6865399: some javac files are missing Sun internal API comment
jjg
parents: 1205
diff changeset
    55
/**
5847
1908176fd6e3 6944312: Potential rebranding issues in openjdk/langtools repository sources
jjg
parents: 5520
diff changeset
    56
 * <p><b>This is NOT part of any supported API.
3380
a6c2bcab0fec 6865399: some javac files are missing Sun internal API comment
jjg
parents: 1205
diff changeset
    57
 * If you write code that depends on this, you do so at your own risk.
a6c2bcab0fec 6865399: some javac files are missing Sun internal API comment
jjg
parents: 1205
diff changeset
    58
 * This code and its internal interfaces are subject to change or
a6c2bcab0fec 6865399: some javac files are missing Sun internal API comment
jjg
parents: 1205
diff changeset
    59
 * deletion without notice.</b>
a6c2bcab0fec 6865399: some javac files are missing Sun internal API comment
jjg
parents: 1205
diff changeset
    60
 */
810
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    61
public class ZipArchive implements Archive {
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    62
4073
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
    63
    public ZipArchive(JavacFileManager fm, ZipFile zfile) throws IOException {
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
    64
        this(fm, zfile, true);
1205
b316e32eb90c 6508981: cleanup file separator handling in JavacFileManager
jjg
parents: 810
diff changeset
    65
    }
b316e32eb90c 6508981: cleanup file separator handling in JavacFileManager
jjg
parents: 810
diff changeset
    66
4073
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
    67
    protected ZipArchive(JavacFileManager fm, ZipFile zfile, boolean initMap) throws IOException {
810
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    68
        this.fileManager = fm;
4073
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
    69
        this.zfile = zfile;
22163
3651128c74eb 8030244: Update langtools to use Diamond
briangoetz
parents: 22159
diff changeset
    70
        this.map = new HashMap<>();
1205
b316e32eb90c 6508981: cleanup file separator handling in JavacFileManager
jjg
parents: 810
diff changeset
    71
        if (initMap)
b316e32eb90c 6508981: cleanup file separator handling in JavacFileManager
jjg
parents: 810
diff changeset
    72
            initMap();
b316e32eb90c 6508981: cleanup file separator handling in JavacFileManager
jjg
parents: 810
diff changeset
    73
    }
b316e32eb90c 6508981: cleanup file separator handling in JavacFileManager
jjg
parents: 810
diff changeset
    74
b316e32eb90c 6508981: cleanup file separator handling in JavacFileManager
jjg
parents: 810
diff changeset
    75
    protected void initMap() throws IOException {
4073
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
    76
        for (Enumeration<? extends ZipEntry> e = zfile.entries(); e.hasMoreElements(); ) {
810
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    77
            ZipEntry entry;
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    78
            try {
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    79
                entry = e.nextElement();
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    80
            } catch (InternalError ex) {
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    81
                IOException io = new IOException();
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    82
                io.initCause(ex); // convenience constructors added in Mustang :-(
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    83
                throw io;
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    84
            }
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    85
            addZipEntry(entry);
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    86
        }
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    87
    }
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    88
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    89
    void addZipEntry(ZipEntry entry) {
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    90
        String name = entry.getName();
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    91
        int i = name.lastIndexOf('/');
1205
b316e32eb90c 6508981: cleanup file separator handling in JavacFileManager
jjg
parents: 810
diff changeset
    92
        RelativeDirectory dirname = new RelativeDirectory(name.substring(0, i+1));
810
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    93
        String basename = name.substring(i+1);
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    94
        if (basename.length() == 0)
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    95
            return;
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    96
        List<String> list = map.get(dirname);
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    97
        if (list == null)
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    98
            list = List.nil();
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    99
        list = list.prepend(basename);
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   100
        map.put(dirname, list);
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   101
    }
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   102
1205
b316e32eb90c 6508981: cleanup file separator handling in JavacFileManager
jjg
parents: 810
diff changeset
   103
    public boolean contains(RelativePath name) {
b316e32eb90c 6508981: cleanup file separator handling in JavacFileManager
jjg
parents: 810
diff changeset
   104
        RelativeDirectory dirname = name.dirname();
b316e32eb90c 6508981: cleanup file separator handling in JavacFileManager
jjg
parents: 810
diff changeset
   105
        String basename = name.basename();
810
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   106
        if (basename.length() == 0)
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   107
            return false;
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   108
        List<String> list = map.get(dirname);
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   109
        return (list != null && list.contains(basename));
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   110
    }
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   111
1205
b316e32eb90c 6508981: cleanup file separator handling in JavacFileManager
jjg
parents: 810
diff changeset
   112
    public List<String> getFiles(RelativeDirectory subdirectory) {
810
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   113
        return map.get(subdirectory);
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   114
    }
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   115
1205
b316e32eb90c 6508981: cleanup file separator handling in JavacFileManager
jjg
parents: 810
diff changeset
   116
    public JavaFileObject getFileObject(RelativeDirectory subdirectory, String file) {
4073
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
   117
        ZipEntry ze = new RelativeFile(subdirectory, file).getZipEntry(zfile);
810
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   118
        return new ZipFileObject(this, file, ze);
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   119
    }
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   120
1205
b316e32eb90c 6508981: cleanup file separator handling in JavacFileManager
jjg
parents: 810
diff changeset
   121
    public Set<RelativeDirectory> getSubdirectories() {
810
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   122
        return map.keySet();
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   123
    }
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   124
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   125
    public void close() throws IOException {
4073
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
   126
        zfile.close();
810
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   127
    }
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   128
3782
ae62279eeb46 6419701: DefaultFileManager clean up: URI.create
jjg
parents: 3380
diff changeset
   129
    @Override
1205
b316e32eb90c 6508981: cleanup file separator handling in JavacFileManager
jjg
parents: 810
diff changeset
   130
    public String toString() {
4073
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
   131
        return "ZipArchive[" + zfile.getName() + "]";
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
   132
    }
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
   133
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
   134
    private File getAbsoluteFile() {
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
   135
        File absFile = (absFileRef == null ? null : absFileRef.get());
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
   136
        if (absFile == null) {
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
   137
            absFile = new File(zfile.getName()).getAbsoluteFile();
22163
3651128c74eb 8030244: Update langtools to use Diamond
briangoetz
parents: 22159
diff changeset
   138
            absFileRef = new SoftReference<>(absFile);
4073
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
   139
        }
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
   140
        return absFile;
1205
b316e32eb90c 6508981: cleanup file separator handling in JavacFileManager
jjg
parents: 810
diff changeset
   141
    }
b316e32eb90c 6508981: cleanup file separator handling in JavacFileManager
jjg
parents: 810
diff changeset
   142
4073
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
   143
    /**
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
   144
     * The file manager that created this archive.
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
   145
     */
810
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   146
    protected JavacFileManager fileManager;
4073
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
   147
    /**
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
   148
     * The index for the contents of this archive.
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
   149
     */
1205
b316e32eb90c 6508981: cleanup file separator handling in JavacFileManager
jjg
parents: 810
diff changeset
   150
    protected final Map<RelativeDirectory,List<String>> map;
4073
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
   151
    /**
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
   152
     * The zip file for the archive.
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
   153
     */
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
   154
    protected final ZipFile zfile;
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
   155
    /**
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
   156
     * A reference to the absolute filename for the zip file for the archive.
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
   157
     */
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
   158
    protected Reference<File> absFileRef;
810
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   159
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   160
    /**
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   161
     * A subclass of JavaFileObject representing zip entries.
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   162
     */
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   163
    public static class ZipFileObject extends BaseFileObject {
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   164
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   165
        private String name;
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   166
        ZipArchive zarch;
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   167
        ZipEntry entry;
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   168
1205
b316e32eb90c 6508981: cleanup file separator handling in JavacFileManager
jjg
parents: 810
diff changeset
   169
        protected ZipFileObject(ZipArchive zarch, String name, ZipEntry entry) {
810
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   170
            super(zarch.fileManager);
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   171
            this.zarch = zarch;
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   172
            this.name = name;
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   173
            this.entry = entry;
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   174
        }
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   175
26266
2d24bda701dc 8056061: Mark implementations of public interfaces with an annotation
jlahoda
parents: 25874
diff changeset
   176
        @DefinedBy(Api.COMPILER)
3995
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   177
        public URI toUri() {
4073
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
   178
            File zipFile = new File(zarch.zfile.getName());
3995
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   179
            return createJarUri(zipFile, entry.getName());
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   180
        }
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   181
26266
2d24bda701dc 8056061: Mark implementations of public interfaces with an annotation
jlahoda
parents: 25874
diff changeset
   182
        @Override @DefinedBy(Api.COMPILER)
3995
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   183
        public String getName() {
4073
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
   184
            return zarch.zfile.getName() + "(" + entry.getName() + ")";
3995
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   185
        }
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   186
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   187
        @Override
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   188
        public String getShortName() {
4073
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
   189
            return new File(zarch.zfile.getName()).getName() + "(" + entry + ")";
3995
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   190
        }
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   191
26266
2d24bda701dc 8056061: Mark implementations of public interfaces with an annotation
jlahoda
parents: 25874
diff changeset
   192
        @Override @DefinedBy(Api.COMPILER)
3995
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   193
        public JavaFileObject.Kind getKind() {
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   194
            return getKind(entry.getName());
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   195
        }
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   196
26266
2d24bda701dc 8056061: Mark implementations of public interfaces with an annotation
jlahoda
parents: 25874
diff changeset
   197
        @Override @DefinedBy(Api.COMPILER)
810
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   198
        public InputStream openInputStream() throws IOException {
4073
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
   199
            return zarch.zfile.getInputStream(entry);
810
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   200
        }
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   201
26266
2d24bda701dc 8056061: Mark implementations of public interfaces with an annotation
jlahoda
parents: 25874
diff changeset
   202
        @Override @DefinedBy(Api.COMPILER)
810
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   203
        public OutputStream openOutputStream() throws IOException {
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   204
            throw new UnsupportedOperationException();
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   205
        }
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   206
26266
2d24bda701dc 8056061: Mark implementations of public interfaces with an annotation
jlahoda
parents: 25874
diff changeset
   207
        @Override @DefinedBy(Api.COMPILER)
810
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   208
        public CharBuffer getCharContent(boolean ignoreEncodingErrors) throws IOException {
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   209
            CharBuffer cb = fileManager.getCachedContent(this);
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   210
            if (cb == null) {
22159
682da512ec17 8030253: Update langtools to use strings-in-switch
briangoetz
parents: 5847
diff changeset
   211
                try (InputStream in = zarch.zfile.getInputStream(entry)) {
810
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   212
                    ByteBuffer bb = fileManager.makeByteBuffer(in);
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   213
                    JavaFileObject prev = fileManager.log.useSource(this);
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   214
                    try {
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   215
                        cb = fileManager.decode(bb, ignoreEncodingErrors);
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   216
                    } finally {
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   217
                        fileManager.log.useSource(prev);
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   218
                    }
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   219
                    fileManager.recycleByteBuffer(bb);
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   220
                    if (!ignoreEncodingErrors) {
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   221
                        fileManager.cache(this, cb);
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   222
                    }
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   223
                }
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   224
            }
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   225
            return cb;
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   226
        }
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   227
26266
2d24bda701dc 8056061: Mark implementations of public interfaces with an annotation
jlahoda
parents: 25874
diff changeset
   228
        @Override @DefinedBy(Api.COMPILER)
3995
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   229
        public Writer openWriter() throws IOException {
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   230
            throw new UnsupportedOperationException();
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   231
        }
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   232
26266
2d24bda701dc 8056061: Mark implementations of public interfaces with an annotation
jlahoda
parents: 25874
diff changeset
   233
        @Override @DefinedBy(Api.COMPILER)
3995
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   234
        public long getLastModified() {
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   235
            return entry.getTime();
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   236
        }
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   237
26266
2d24bda701dc 8056061: Mark implementations of public interfaces with an annotation
jlahoda
parents: 25874
diff changeset
   238
        @Override @DefinedBy(Api.COMPILER)
3995
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   239
        public boolean delete() {
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   240
            throw new UnsupportedOperationException();
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   241
        }
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   242
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   243
        @Override
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   244
        protected CharsetDecoder getDecoder(boolean ignoreEncodingErrors) {
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   245
            return fileManager.getDecoder(fileManager.getEncodingName(), ignoreEncodingErrors);
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   246
        }
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   247
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   248
        @Override
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   249
        protected String inferBinaryName(Iterable<? extends File> path) {
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   250
            String entryName = entry.getName();
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   251
            return removeExtension(entryName).replace('/', '.');
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   252
        }
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   253
26266
2d24bda701dc 8056061: Mark implementations of public interfaces with an annotation
jlahoda
parents: 25874
diff changeset
   254
        @Override @DefinedBy(Api.COMPILER)
3995
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   255
        public boolean isNameCompatible(String cn, JavaFileObject.Kind k) {
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   256
            cn.getClass();
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   257
            // null check
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   258
            if (k == Kind.OTHER && getKind() != k) {
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   259
                return false;
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   260
            }
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   261
            return name.equals(cn + k.extension);
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   262
        }
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   263
4073
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
   264
        /**
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
   265
         * Check if two file objects are equal.
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
   266
         * Two ZipFileObjects are equal if the absolute paths of the underlying
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
   267
         * zip files are equal and if the paths within those zip files are equal.
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
   268
         */
3995
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   269
        @Override
810
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   270
        public boolean equals(Object other) {
4073
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
   271
            if (this == other)
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
   272
                return true;
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
   273
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
   274
            if (!(other instanceof ZipFileObject))
810
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   275
                return false;
4073
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
   276
810
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   277
            ZipFileObject o = (ZipFileObject) other;
4073
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
   278
            return zarch.getAbsoluteFile().equals(o.zarch.getAbsoluteFile())
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
   279
                    && name.equals(o.name);
810
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   280
        }
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   281
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   282
        @Override
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   283
        public int hashCode() {
4073
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
   284
            return zarch.getAbsoluteFile().hashCode() + name.hashCode();
810
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   285
        }
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   286
    }
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   287
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   288
}