langtools/src/jdk.compiler/share/classes/com/sun/tools/javac/api/WrappingJavaFileManager.java
author chegar
Sun, 17 Aug 2014 15:52:32 +0100
changeset 25874 83c19f00452c
parent 22163 langtools/src/share/classes/com/sun/tools/javac/api/WrappingJavaFileManager.java@3651128c74eb
child 26266 2d24bda701dc
permissions -rw-r--r--
8054834: Modular Source Code Reviewed-by: alanb, chegar, ihse, mduigou Contributed-by: alan.bateman@oracle.com, alex.buckley@oracle.com, chris.hegarty@oracle.com, erik.joelsson@oracle.com, jonathan.gibbons@oracle.com, karen.kinnear@oracle.com, magnus.ihse.bursie@oracle.com, mandy.chung@oracle.com, mark.reinhold@oracle.com, paul.sandoz@oracle.com
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
10
06bc494ca11e Initial load
duke
parents:
diff changeset
     1
/*
14258
8d2148961366 8000663: clean up langtools imports
jjg
parents: 5847
diff changeset
     2
 * Copyright (c) 2006, 2012, Oracle and/or its affiliates. All rights reserved.
10
06bc494ca11e Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
06bc494ca11e Initial load
duke
parents:
diff changeset
     4
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
06bc494ca11e Initial load
duke
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: 1264
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
10
06bc494ca11e Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
5520
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 1264
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    10
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
06bc494ca11e Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
06bc494ca11e Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
06bc494ca11e Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
06bc494ca11e Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
06bc494ca11e Initial load
duke
parents:
diff changeset
    16
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
06bc494ca11e Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
06bc494ca11e Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
06bc494ca11e Initial load
duke
parents:
diff changeset
    20
 *
5520
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 1264
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 1264
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 1264
diff changeset
    23
 * questions.
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    24
 */
06bc494ca11e Initial load
duke
parents:
diff changeset
    25
06bc494ca11e Initial load
duke
parents:
diff changeset
    26
package com.sun.tools.javac.api;
06bc494ca11e Initial load
duke
parents:
diff changeset
    27
06bc494ca11e Initial load
duke
parents:
diff changeset
    28
import java.io.IOException;
06bc494ca11e Initial load
duke
parents:
diff changeset
    29
import java.net.URI;
06bc494ca11e Initial load
duke
parents:
diff changeset
    30
import java.util.ArrayList;
06bc494ca11e Initial load
duke
parents:
diff changeset
    31
import java.util.Collections;
06bc494ca11e Initial load
duke
parents:
diff changeset
    32
import java.util.List;
06bc494ca11e Initial load
duke
parents:
diff changeset
    33
import java.util.Set;
14258
8d2148961366 8000663: clean up langtools imports
jjg
parents: 5847
diff changeset
    34
8d2148961366 8000663: clean up langtools imports
jjg
parents: 5847
diff changeset
    35
import javax.tools.*;
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    36
import javax.tools.JavaFileObject.Kind;
06bc494ca11e Initial load
duke
parents:
diff changeset
    37
06bc494ca11e Initial load
duke
parents:
diff changeset
    38
/**
06bc494ca11e Initial load
duke
parents:
diff changeset
    39
 * Wraps all calls to a given file manager.  Subclasses of this class
06bc494ca11e Initial load
duke
parents:
diff changeset
    40
 * might override some of these methods and might also provide
06bc494ca11e Initial load
duke
parents:
diff changeset
    41
 * additional fields and methods.
06bc494ca11e Initial load
duke
parents:
diff changeset
    42
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
    43
 * <p>This class might be moved to {@link javax.tools} in a future
06bc494ca11e Initial load
duke
parents:
diff changeset
    44
 * release.
06bc494ca11e Initial load
duke
parents:
diff changeset
    45
 *
5847
1908176fd6e3 6944312: Potential rebranding issues in openjdk/langtools repository sources
jjg
parents: 5520
diff changeset
    46
 * <p><b>This is NOT part of any supported API.
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    47
 * If you write code that depends on this, you do so at your own
06bc494ca11e Initial load
duke
parents:
diff changeset
    48
 * risk.  This code and its internal interfaces are subject to change
06bc494ca11e Initial load
duke
parents:
diff changeset
    49
 * or deletion without notice.</b></p>
06bc494ca11e Initial load
duke
parents:
diff changeset
    50
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
    51
 * @param <M> the type of file manager wrapped to by this object
06bc494ca11e Initial load
duke
parents:
diff changeset
    52
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
    53
 * @author Peter von der Ah&eacute;
06bc494ca11e Initial load
duke
parents:
diff changeset
    54
 * @since 1.6
06bc494ca11e Initial load
duke
parents:
diff changeset
    55
 */
06bc494ca11e Initial load
duke
parents:
diff changeset
    56
public class WrappingJavaFileManager<M extends JavaFileManager> extends ForwardingJavaFileManager<M> {
06bc494ca11e Initial load
duke
parents:
diff changeset
    57
06bc494ca11e Initial load
duke
parents:
diff changeset
    58
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    59
     * Creates a new instance of WrappingJavaFileManager.
06bc494ca11e Initial load
duke
parents:
diff changeset
    60
     * @param fileManager file manager to be wrapped
06bc494ca11e Initial load
duke
parents:
diff changeset
    61
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
    62
    protected WrappingJavaFileManager(M fileManager) {
06bc494ca11e Initial load
duke
parents:
diff changeset
    63
        super(fileManager);
06bc494ca11e Initial load
duke
parents:
diff changeset
    64
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
    65
06bc494ca11e Initial load
duke
parents:
diff changeset
    66
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    67
     * This implementation returns the given file object.  Subclasses
06bc494ca11e Initial load
duke
parents:
diff changeset
    68
     * may override this behavior.
06bc494ca11e Initial load
duke
parents:
diff changeset
    69
     *
06bc494ca11e Initial load
duke
parents:
diff changeset
    70
     * @param fileObject a file object
06bc494ca11e Initial load
duke
parents:
diff changeset
    71
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
    72
    protected FileObject wrap(FileObject fileObject) {
06bc494ca11e Initial load
duke
parents:
diff changeset
    73
        return fileObject;
06bc494ca11e Initial load
duke
parents:
diff changeset
    74
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
    75
06bc494ca11e Initial load
duke
parents:
diff changeset
    76
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    77
     * This implementation forwards to {@link #wrap(FileObject)}.
06bc494ca11e Initial load
duke
parents:
diff changeset
    78
     * Subclasses may override this behavior.
06bc494ca11e Initial load
duke
parents:
diff changeset
    79
     *
06bc494ca11e Initial load
duke
parents:
diff changeset
    80
     * @param fileObject a file object
06bc494ca11e Initial load
duke
parents:
diff changeset
    81
     * @throws ClassCastException if the file object returned from the
06bc494ca11e Initial load
duke
parents:
diff changeset
    82
     * forwarded call is not a subtype of {@linkplain JavaFileObject}
06bc494ca11e Initial load
duke
parents:
diff changeset
    83
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
    84
    protected JavaFileObject wrap(JavaFileObject fileObject) {
06bc494ca11e Initial load
duke
parents:
diff changeset
    85
        return (JavaFileObject)wrap((FileObject)fileObject);
06bc494ca11e Initial load
duke
parents:
diff changeset
    86
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
    87
06bc494ca11e Initial load
duke
parents:
diff changeset
    88
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    89
     * This implementation returns the given file object.  Subclasses
06bc494ca11e Initial load
duke
parents:
diff changeset
    90
     * may override this behavior.
06bc494ca11e Initial load
duke
parents:
diff changeset
    91
     *
06bc494ca11e Initial load
duke
parents:
diff changeset
    92
     * @param fileObject a file object
06bc494ca11e Initial load
duke
parents:
diff changeset
    93
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
    94
    protected FileObject unwrap(FileObject fileObject) {
06bc494ca11e Initial load
duke
parents:
diff changeset
    95
        return fileObject;
06bc494ca11e Initial load
duke
parents:
diff changeset
    96
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
    97
06bc494ca11e Initial load
duke
parents:
diff changeset
    98
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    99
     * This implementation forwards to {@link #unwrap(FileObject)}.
06bc494ca11e Initial load
duke
parents:
diff changeset
   100
     * Subclasses may override this behavior.
06bc494ca11e Initial load
duke
parents:
diff changeset
   101
     *
06bc494ca11e Initial load
duke
parents:
diff changeset
   102
     * @param fileObject a file object
06bc494ca11e Initial load
duke
parents:
diff changeset
   103
     * @throws ClassCastException if the file object returned from the
06bc494ca11e Initial load
duke
parents:
diff changeset
   104
     * forwarded call is not a subtype of {@linkplain JavaFileObject}
06bc494ca11e Initial load
duke
parents:
diff changeset
   105
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
   106
    protected JavaFileObject unwrap(JavaFileObject fileObject) {
06bc494ca11e Initial load
duke
parents:
diff changeset
   107
        return (JavaFileObject)unwrap((FileObject)fileObject);
06bc494ca11e Initial load
duke
parents:
diff changeset
   108
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   109
06bc494ca11e Initial load
duke
parents:
diff changeset
   110
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
   111
     * This implementation maps the given list of file objects by
06bc494ca11e Initial load
duke
parents:
diff changeset
   112
     * calling wrap on each.  Subclasses may override this behavior.
06bc494ca11e Initial load
duke
parents:
diff changeset
   113
     *
06bc494ca11e Initial load
duke
parents:
diff changeset
   114
     * @param fileObjects a list of file objects
06bc494ca11e Initial load
duke
parents:
diff changeset
   115
     * @return the mapping
06bc494ca11e Initial load
duke
parents:
diff changeset
   116
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
   117
    protected Iterable<JavaFileObject> wrap(Iterable<JavaFileObject> fileObjects) {
22163
3651128c74eb 8030244: Update langtools to use Diamond
briangoetz
parents: 14258
diff changeset
   118
        List<JavaFileObject> mapped = new ArrayList<>();
10
06bc494ca11e Initial load
duke
parents:
diff changeset
   119
        for (JavaFileObject fileObject : fileObjects)
06bc494ca11e Initial load
duke
parents:
diff changeset
   120
            mapped.add(wrap(fileObject));
06bc494ca11e Initial load
duke
parents:
diff changeset
   121
        return Collections.unmodifiableList(mapped);
06bc494ca11e Initial load
duke
parents:
diff changeset
   122
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   123
06bc494ca11e Initial load
duke
parents:
diff changeset
   124
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
   125
     * This implementation returns the given URI.  Subclasses may
06bc494ca11e Initial load
duke
parents:
diff changeset
   126
     * override this behavior.
06bc494ca11e Initial load
duke
parents:
diff changeset
   127
     *
06bc494ca11e Initial load
duke
parents:
diff changeset
   128
     * @param uri a URI
06bc494ca11e Initial load
duke
parents:
diff changeset
   129
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
   130
    protected URI unwrap(URI uri) {
06bc494ca11e Initial load
duke
parents:
diff changeset
   131
        return uri;
06bc494ca11e Initial load
duke
parents:
diff changeset
   132
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   133
06bc494ca11e Initial load
duke
parents:
diff changeset
   134
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
   135
     * @throws IllegalStateException {@inheritDoc}
06bc494ca11e Initial load
duke
parents:
diff changeset
   136
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
   137
    public Iterable<JavaFileObject> list(Location location,
06bc494ca11e Initial load
duke
parents:
diff changeset
   138
                                         String packageName,
06bc494ca11e Initial load
duke
parents:
diff changeset
   139
                                         Set<Kind> kinds,
06bc494ca11e Initial load
duke
parents:
diff changeset
   140
                                         boolean recurse)
06bc494ca11e Initial load
duke
parents:
diff changeset
   141
        throws IOException
06bc494ca11e Initial load
duke
parents:
diff changeset
   142
    {
06bc494ca11e Initial load
duke
parents:
diff changeset
   143
        return wrap(super.list(location, packageName, kinds, recurse));
06bc494ca11e Initial load
duke
parents:
diff changeset
   144
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   145
06bc494ca11e Initial load
duke
parents:
diff changeset
   146
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
   147
     * @throws IllegalStateException {@inheritDoc}
06bc494ca11e Initial load
duke
parents:
diff changeset
   148
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
   149
    public String inferBinaryName(Location location, JavaFileObject file) {
06bc494ca11e Initial load
duke
parents:
diff changeset
   150
        return super.inferBinaryName(location, unwrap(file));
06bc494ca11e Initial load
duke
parents:
diff changeset
   151
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   152
06bc494ca11e Initial load
duke
parents:
diff changeset
   153
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
   154
     * @throws IllegalArgumentException {@inheritDoc}
06bc494ca11e Initial load
duke
parents:
diff changeset
   155
     * @throws UnsupportedOperationException {@inheritDoc}
06bc494ca11e Initial load
duke
parents:
diff changeset
   156
     * @throws IllegalStateException {@inheritDoc}
06bc494ca11e Initial load
duke
parents:
diff changeset
   157
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
   158
    public JavaFileObject getJavaFileForInput(Location location,
06bc494ca11e Initial load
duke
parents:
diff changeset
   159
                                              String className,
06bc494ca11e Initial load
duke
parents:
diff changeset
   160
                                              Kind kind)
06bc494ca11e Initial load
duke
parents:
diff changeset
   161
        throws IOException
06bc494ca11e Initial load
duke
parents:
diff changeset
   162
    {
06bc494ca11e Initial load
duke
parents:
diff changeset
   163
        return wrap(super.getJavaFileForInput(location, className, kind));
06bc494ca11e Initial load
duke
parents:
diff changeset
   164
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   165
06bc494ca11e Initial load
duke
parents:
diff changeset
   166
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
   167
     * @throws IllegalArgumentException {@inheritDoc}
06bc494ca11e Initial load
duke
parents:
diff changeset
   168
     * @throws UnsupportedOperationException {@inheritDoc}
06bc494ca11e Initial load
duke
parents:
diff changeset
   169
     * @throws IllegalStateException {@inheritDoc}
06bc494ca11e Initial load
duke
parents:
diff changeset
   170
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
   171
    public JavaFileObject getJavaFileForOutput(Location location,
06bc494ca11e Initial load
duke
parents:
diff changeset
   172
                                               String className,
06bc494ca11e Initial load
duke
parents:
diff changeset
   173
                                               Kind kind,
06bc494ca11e Initial load
duke
parents:
diff changeset
   174
                                               FileObject sibling)
06bc494ca11e Initial load
duke
parents:
diff changeset
   175
        throws IOException
06bc494ca11e Initial load
duke
parents:
diff changeset
   176
    {
06bc494ca11e Initial load
duke
parents:
diff changeset
   177
        return wrap(super.getJavaFileForOutput(location, className, kind, unwrap(sibling)));
06bc494ca11e Initial load
duke
parents:
diff changeset
   178
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   179
06bc494ca11e Initial load
duke
parents:
diff changeset
   180
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
   181
     * @throws IllegalArgumentException {@inheritDoc}
06bc494ca11e Initial load
duke
parents:
diff changeset
   182
     * @throws IllegalStateException {@inheritDoc}
06bc494ca11e Initial load
duke
parents:
diff changeset
   183
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
   184
    public FileObject getFileForInput(Location location,
06bc494ca11e Initial load
duke
parents:
diff changeset
   185
                                      String packageName,
06bc494ca11e Initial load
duke
parents:
diff changeset
   186
                                      String relativeName)
06bc494ca11e Initial load
duke
parents:
diff changeset
   187
        throws IOException
06bc494ca11e Initial load
duke
parents:
diff changeset
   188
    {
06bc494ca11e Initial load
duke
parents:
diff changeset
   189
        return wrap(super.getFileForInput(location, packageName, relativeName));
06bc494ca11e Initial load
duke
parents:
diff changeset
   190
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   191
06bc494ca11e Initial load
duke
parents:
diff changeset
   192
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
   193
     * @throws IllegalArgumentException {@inheritDoc}
06bc494ca11e Initial load
duke
parents:
diff changeset
   194
     * @throws IllegalStateException {@inheritDoc}
06bc494ca11e Initial load
duke
parents:
diff changeset
   195
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
   196
    public FileObject getFileForOutput(Location location,
06bc494ca11e Initial load
duke
parents:
diff changeset
   197
                                       String packageName,
06bc494ca11e Initial load
duke
parents:
diff changeset
   198
                                       String relativeName,
06bc494ca11e Initial load
duke
parents:
diff changeset
   199
                                       FileObject sibling)
06bc494ca11e Initial load
duke
parents:
diff changeset
   200
        throws IOException
06bc494ca11e Initial load
duke
parents:
diff changeset
   201
    {
06bc494ca11e Initial load
duke
parents:
diff changeset
   202
        return wrap(super.getFileForOutput(location,
06bc494ca11e Initial load
duke
parents:
diff changeset
   203
                                           packageName,
06bc494ca11e Initial load
duke
parents:
diff changeset
   204
                                           relativeName,
06bc494ca11e Initial load
duke
parents:
diff changeset
   205
                                           unwrap(sibling)));
06bc494ca11e Initial load
duke
parents:
diff changeset
   206
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   207
06bc494ca11e Initial load
duke
parents:
diff changeset
   208
}