langtools/src/jdk.compiler/share/classes/com/sun/tools/javac/file/RegularFileObject.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
/*
22448
a85fbad9d687 8029230: Update copyright year to match last edit in jdk8 langtools repository for 2013
ksrini
parents: 20239
diff changeset
     2
 * Copyright (c) 2005, 2013, 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
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    28
import java.io.File;
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    29
import java.io.FileInputStream;
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    30
import java.io.FileOutputStream;
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    31
import java.io.IOException;
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    32
import java.io.InputStream;
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    33
import java.io.OutputStream;
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    34
import java.io.OutputStreamWriter;
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    35
import java.io.Writer;
4073
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
    36
import java.lang.ref.Reference;
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
    37
import java.lang.ref.SoftReference;
810
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    38
import java.net.URI;
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    39
import java.nio.ByteBuffer;
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    40
import java.nio.CharBuffer;
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    41
import java.nio.charset.CharsetDecoder;
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    42
import javax.tools.JavaFileObject;
20239
3cedbfa2946b 8017248: Compiler Diacritics Issue
kizune
parents: 10461
diff changeset
    43
import java.text.Normalizer;
810
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    44
26266
2d24bda701dc 8056061: Mark implementations of public interfaces with an annotation
jlahoda
parents: 25874
diff changeset
    45
import com.sun.tools.javac.util.DefinedBy;
2d24bda701dc 8056061: Mark implementations of public interfaces with an annotation
jlahoda
parents: 25874
diff changeset
    46
import com.sun.tools.javac.util.DefinedBy.Api;
2d24bda701dc 8056061: Mark implementations of public interfaces with an annotation
jlahoda
parents: 25874
diff changeset
    47
810
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    48
/**
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    49
 * A subclass of JavaFileObject representing regular files.
3380
a6c2bcab0fec 6865399: some javac files are missing Sun internal API comment
jjg
parents: 1479
diff changeset
    50
 *
5847
1908176fd6e3 6944312: Potential rebranding issues in openjdk/langtools repository sources
jjg
parents: 5520
diff changeset
    51
 * <p><b>This is NOT part of any supported API.
3380
a6c2bcab0fec 6865399: some javac files are missing Sun internal API comment
jjg
parents: 1479
diff changeset
    52
 * 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: 1479
diff changeset
    53
 * This code and its internal interfaces are subject to change or
a6c2bcab0fec 6865399: some javac files are missing Sun internal API comment
jjg
parents: 1479
diff changeset
    54
 * deletion without notice.</b>
810
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    55
 */
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    56
class RegularFileObject extends BaseFileObject {
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    57
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    58
    /** Have the parent directories been created?
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    59
     */
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    60
    private boolean hasParents = false;
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    61
    private String name;
4073
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
    62
    final File file;
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
    63
    private Reference<File> absFileRef;
20239
3cedbfa2946b 8017248: Compiler Diacritics Issue
kizune
parents: 10461
diff changeset
    64
    final static boolean isMacOS = System.getProperty("os.name", "").contains("OS X");
810
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    65
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    66
    public RegularFileObject(JavacFileManager fileManager, File f) {
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    67
        this(fileManager, f.getName(), f);
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    68
    }
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    69
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    70
    public RegularFileObject(JavacFileManager fileManager, String name, File f) {
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    71
        super(fileManager);
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    72
        if (f.isDirectory()) {
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    73
            throw new IllegalArgumentException("directories not supported");
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    74
        }
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    75
        this.name = name;
4073
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
    76
        this.file = f;
23128
c91951cf65f0 6533516: Warning needed for file with future time stamps
jjg
parents: 22449
diff changeset
    77
        if (f.lastModified() > System.currentTimeMillis())
c91951cf65f0 6533516: Warning needed for file with future time stamps
jjg
parents: 22449
diff changeset
    78
            fileManager.log.warning("file.from.future", f);
810
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    79
    }
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
    80
26266
2d24bda701dc 8056061: Mark implementations of public interfaces with an annotation
jlahoda
parents: 25874
diff changeset
    81
    @Override @DefinedBy(Api.COMPILER)
3995
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
    82
    public URI toUri() {
4073
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
    83
        return file.toURI().normalize();
3995
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
    84
    }
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
    85
26266
2d24bda701dc 8056061: Mark implementations of public interfaces with an annotation
jlahoda
parents: 25874
diff changeset
    86
    @Override @DefinedBy(Api.COMPILER)
3995
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
    87
    public String getName() {
4073
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
    88
        return file.getPath();
3995
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
    89
    }
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
    90
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
    91
    @Override
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
    92
    public String getShortName() {
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
    93
        return name;
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
    94
    }
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
    95
26266
2d24bda701dc 8056061: Mark implementations of public interfaces with an annotation
jlahoda
parents: 25874
diff changeset
    96
    @Override @DefinedBy(Api.COMPILER)
3995
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
    97
    public JavaFileObject.Kind getKind() {
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
    98
        return getKind(name);
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
    99
    }
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   100
26266
2d24bda701dc 8056061: Mark implementations of public interfaces with an annotation
jlahoda
parents: 25874
diff changeset
   101
    @Override @DefinedBy(Api.COMPILER)
810
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   102
    public InputStream openInputStream() throws IOException {
4073
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
   103
        return new FileInputStream(file);
810
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   104
    }
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   105
26266
2d24bda701dc 8056061: Mark implementations of public interfaces with an annotation
jlahoda
parents: 25874
diff changeset
   106
    @Override @DefinedBy(Api.COMPILER)
810
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   107
    public OutputStream openOutputStream() throws IOException {
10461
998e642f9811 7068451: Regression: javac compiles fixed sources against previous, not current, version of generated sources
jjg
parents: 5847
diff changeset
   108
        fileManager.flushCache(this);
810
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   109
        ensureParentDirectoriesExist();
4073
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
   110
        return new FileOutputStream(file);
810
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   111
    }
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   112
26266
2d24bda701dc 8056061: Mark implementations of public interfaces with an annotation
jlahoda
parents: 25874
diff changeset
   113
    @Override @DefinedBy(Api.COMPILER)
810
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   114
    public CharBuffer getCharContent(boolean ignoreEncodingErrors) throws IOException {
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   115
        CharBuffer cb = fileManager.getCachedContent(this);
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   116
        if (cb == null) {
22159
682da512ec17 8030253: Update langtools to use strings-in-switch
briangoetz
parents: 20239
diff changeset
   117
            try (InputStream in = new FileInputStream(file)) {
810
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   118
                ByteBuffer bb = fileManager.makeByteBuffer(in);
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   119
                JavaFileObject prev = fileManager.log.useSource(this);
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   120
                try {
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   121
                    cb = fileManager.decode(bb, ignoreEncodingErrors);
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   122
                } finally {
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   123
                    fileManager.log.useSource(prev);
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
                fileManager.recycleByteBuffer(bb);
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   126
                if (!ignoreEncodingErrors) {
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   127
                    fileManager.cache(this, cb);
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   128
                }
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   129
            }
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   130
        }
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   131
        return cb;
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   132
    }
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   133
26266
2d24bda701dc 8056061: Mark implementations of public interfaces with an annotation
jlahoda
parents: 25874
diff changeset
   134
    @Override @DefinedBy(Api.COMPILER)
3995
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   135
    public Writer openWriter() throws IOException {
10461
998e642f9811 7068451: Regression: javac compiles fixed sources against previous, not current, version of generated sources
jjg
parents: 5847
diff changeset
   136
        fileManager.flushCache(this);
3995
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   137
        ensureParentDirectoriesExist();
4073
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
   138
        return new OutputStreamWriter(new FileOutputStream(file), fileManager.getEncodingName());
3995
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   139
    }
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   140
26266
2d24bda701dc 8056061: Mark implementations of public interfaces with an annotation
jlahoda
parents: 25874
diff changeset
   141
    @Override @DefinedBy(Api.COMPILER)
3995
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   142
    public long getLastModified() {
4073
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
   143
        return file.lastModified();
3995
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   144
    }
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   145
26266
2d24bda701dc 8056061: Mark implementations of public interfaces with an annotation
jlahoda
parents: 25874
diff changeset
   146
    @Override @DefinedBy(Api.COMPILER)
3995
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   147
    public boolean delete() {
4073
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
   148
        return file.delete();
3995
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   149
    }
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   150
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   151
    @Override
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   152
    protected CharsetDecoder getDecoder(boolean ignoreEncodingErrors) {
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   153
        return fileManager.getDecoder(fileManager.getEncodingName(), ignoreEncodingErrors);
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   154
    }
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   155
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   156
    @Override
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   157
    protected String inferBinaryName(Iterable<? extends File> path) {
4073
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
   158
        String fPath = file.getPath();
3995
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   159
        //System.err.println("RegularFileObject " + file + " " +r.getPath());
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   160
        for (File dir: path) {
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   161
            //System.err.println("dir: " + dir);
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   162
            String dPath = dir.getPath();
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   163
            if (dPath.length() == 0)
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   164
                dPath = System.getProperty("user.dir");
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   165
            if (!dPath.endsWith(File.separator))
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   166
                dPath += File.separator;
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   167
            if (fPath.regionMatches(true, 0, dPath, 0, dPath.length())
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   168
                && new File(fPath.substring(0, dPath.length())).equals(new File(dPath))) {
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   169
                String relativeName = fPath.substring(dPath.length());
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   170
                return removeExtension(relativeName).replace(File.separatorChar, '.');
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   171
            }
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   172
        }
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   173
        return null;
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   174
    }
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   175
26266
2d24bda701dc 8056061: Mark implementations of public interfaces with an annotation
jlahoda
parents: 25874
diff changeset
   176
    @Override @DefinedBy(Api.COMPILER)
3995
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   177
    public boolean isNameCompatible(String cn, JavaFileObject.Kind kind) {
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   178
        cn.getClass();
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   179
        // null check
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   180
        if (kind == Kind.OTHER && getKind() != kind) {
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   181
            return false;
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   182
        }
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   183
        String n = cn + kind.extension;
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   184
        if (name.equals(n)) {
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   185
            return true;
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   186
        }
20239
3cedbfa2946b 8017248: Compiler Diacritics Issue
kizune
parents: 10461
diff changeset
   187
        if (isMacOS && Normalizer.isNormalized(name, Normalizer.Form.NFD)
3cedbfa2946b 8017248: Compiler Diacritics Issue
kizune
parents: 10461
diff changeset
   188
            && Normalizer.isNormalized(n, Normalizer.Form.NFC)) {
3cedbfa2946b 8017248: Compiler Diacritics Issue
kizune
parents: 10461
diff changeset
   189
            // On Mac OS X it is quite possible to file name and class
3cedbfa2946b 8017248: Compiler Diacritics Issue
kizune
parents: 10461
diff changeset
   190
            // name normalized in a different way - in that case we have to normalize file name
3cedbfa2946b 8017248: Compiler Diacritics Issue
kizune
parents: 10461
diff changeset
   191
            // to the Normal Form Compised (NFC)
3cedbfa2946b 8017248: Compiler Diacritics Issue
kizune
parents: 10461
diff changeset
   192
            String normName = Normalizer.normalize(name, Normalizer.Form.NFC);
3cedbfa2946b 8017248: Compiler Diacritics Issue
kizune
parents: 10461
diff changeset
   193
            if (normName.equals(n)) {
3cedbfa2946b 8017248: Compiler Diacritics Issue
kizune
parents: 10461
diff changeset
   194
                this.name = normName;
3cedbfa2946b 8017248: Compiler Diacritics Issue
kizune
parents: 10461
diff changeset
   195
                return true;
3cedbfa2946b 8017248: Compiler Diacritics Issue
kizune
parents: 10461
diff changeset
   196
            }
3cedbfa2946b 8017248: Compiler Diacritics Issue
kizune
parents: 10461
diff changeset
   197
        }
3cedbfa2946b 8017248: Compiler Diacritics Issue
kizune
parents: 10461
diff changeset
   198
3cedbfa2946b 8017248: Compiler Diacritics Issue
kizune
parents: 10461
diff changeset
   199
            if (name.equalsIgnoreCase(n)) {
3995
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   200
            try {
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   201
                // allow for Windows
4073
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
   202
                return file.getCanonicalFile().getName().equals(n);
3995
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   203
            } catch (IOException e) {
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   204
            }
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   205
        }
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   206
        return false;
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   207
    }
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   208
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   209
    private void ensureParentDirectoriesExist() throws IOException {
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   210
        if (!hasParents) {
4073
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
   211
            File parent = file.getParentFile();
3995
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   212
            if (parent != null && !parent.exists()) {
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   213
                if (!parent.mkdirs()) {
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   214
                    if (!parent.exists() || !parent.isDirectory()) {
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   215
                        throw new IOException("could not create parent directories");
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   216
                    }
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   217
                }
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   218
            }
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   219
            hasParents = true;
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   220
        }
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   221
    }
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   222
4073
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
   223
    /**
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
   224
     * Check if two file objects are equal.
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
   225
     * Two RegularFileObjects 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
   226
     * files are equal.
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
   227
     */
3995
73af8b6fb8bc 6410637: Make decision on deprecated methods in DefaultFileManager and BaseFileObject.
jjg
parents: 3782
diff changeset
   228
    @Override
810
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   229
    public boolean equals(Object other) {
4073
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
   230
        if (this == other)
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
   231
            return true;
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
   232
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
   233
        if (!(other instanceof RegularFileObject))
810
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   234
            return false;
4073
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
   235
810
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   236
        RegularFileObject o = (RegularFileObject) other;
4073
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
   237
        return getAbsoluteFile().equals(o.getAbsoluteFile());
810
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   238
    }
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   239
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   240
    @Override
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   241
    public int hashCode() {
4073
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
   242
        return getAbsoluteFile().hashCode();
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
   243
    }
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
   244
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
   245
    private File getAbsoluteFile() {
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
   246
        File absFile = (absFileRef == null ? null : absFileRef.get());
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
   247
        if (absFile == null) {
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
   248
            absFile = file.getAbsoluteFile();
22163
3651128c74eb 8030244: Update langtools to use Diamond
briangoetz
parents: 22159
diff changeset
   249
            absFileRef = new SoftReference<>(absFile);
4073
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
   250
        }
9788f4549740 6838467: JSR199 FileObjects don't obey general contract of equals.
jjg
parents: 3998
diff changeset
   251
        return absFile;
810
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   252
    }
e4b6a6d206e6 6714365: refactor JavacFileManager to move nested classes to top level
jjg
parents:
diff changeset
   253
}