langtools/src/share/classes/javax/tools/ForwardingJavaFileManager.java
author ohair
Tue, 25 May 2010 15:54:51 -0700
changeset 5520 86e4b9a9da40
parent 10 06bc494ca11e
child 14258 8d2148961366
permissions -rw-r--r--
6943119: Rebrand source copyright notices Reviewed-by: darcy
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
10
06bc494ca11e Initial load
duke
parents:
diff changeset
     1
/*
5520
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 10
diff changeset
     2
 * Copyright (c) 2005, 2006, 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: 10
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: 10
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: 10
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 10
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 10
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 javax.tools;
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.Iterator;
06bc494ca11e Initial load
duke
parents:
diff changeset
    31
import java.util.Set;
06bc494ca11e Initial load
duke
parents:
diff changeset
    32
import javax.tools.JavaFileObject.Kind;
06bc494ca11e Initial load
duke
parents:
diff changeset
    33
06bc494ca11e Initial load
duke
parents:
diff changeset
    34
/**
06bc494ca11e Initial load
duke
parents:
diff changeset
    35
 * Forwards calls to a given file manager.  Subclasses of this class
06bc494ca11e Initial load
duke
parents:
diff changeset
    36
 * might override some of these methods and might also provide
06bc494ca11e Initial load
duke
parents:
diff changeset
    37
 * additional fields and methods.
06bc494ca11e Initial load
duke
parents:
diff changeset
    38
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
    39
 * @param <M> the kind of file manager forwarded to by this object
06bc494ca11e Initial load
duke
parents:
diff changeset
    40
 * @author Peter von der Ah&eacute;
06bc494ca11e Initial load
duke
parents:
diff changeset
    41
 * @since 1.6
06bc494ca11e Initial load
duke
parents:
diff changeset
    42
 */
06bc494ca11e Initial load
duke
parents:
diff changeset
    43
public class ForwardingJavaFileManager<M extends JavaFileManager> implements JavaFileManager {
06bc494ca11e Initial load
duke
parents:
diff changeset
    44
06bc494ca11e Initial load
duke
parents:
diff changeset
    45
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    46
     * The file manager which all methods are delegated to.
06bc494ca11e Initial load
duke
parents:
diff changeset
    47
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
    48
    protected final M fileManager;
06bc494ca11e Initial load
duke
parents:
diff changeset
    49
06bc494ca11e Initial load
duke
parents:
diff changeset
    50
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    51
     * Creates a new instance of ForwardingJavaFileManager.
06bc494ca11e Initial load
duke
parents:
diff changeset
    52
     * @param fileManager delegate to this file manager
06bc494ca11e Initial load
duke
parents:
diff changeset
    53
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
    54
    protected ForwardingJavaFileManager(M fileManager) {
06bc494ca11e Initial load
duke
parents:
diff changeset
    55
        fileManager.getClass(); // null check
06bc494ca11e Initial load
duke
parents:
diff changeset
    56
        this.fileManager = fileManager;
06bc494ca11e Initial load
duke
parents:
diff changeset
    57
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
    58
06bc494ca11e Initial load
duke
parents:
diff changeset
    59
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    60
     * @throws SecurityException {@inheritDoc}
06bc494ca11e Initial load
duke
parents:
diff changeset
    61
     * @throws IllegalStateException {@inheritDoc}
06bc494ca11e Initial load
duke
parents:
diff changeset
    62
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
    63
    public ClassLoader getClassLoader(Location location) {
06bc494ca11e Initial load
duke
parents:
diff changeset
    64
        return fileManager.getClassLoader(location);
06bc494ca11e Initial load
duke
parents:
diff changeset
    65
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
    66
06bc494ca11e Initial load
duke
parents:
diff changeset
    67
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    68
     * @throws IOException {@inheritDoc}
06bc494ca11e Initial load
duke
parents:
diff changeset
    69
     * @throws IllegalStateException {@inheritDoc}
06bc494ca11e Initial load
duke
parents:
diff changeset
    70
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
    71
    public Iterable<JavaFileObject> list(Location location,
06bc494ca11e Initial load
duke
parents:
diff changeset
    72
                                         String packageName,
06bc494ca11e Initial load
duke
parents:
diff changeset
    73
                                         Set<Kind> kinds,
06bc494ca11e Initial load
duke
parents:
diff changeset
    74
                                         boolean recurse)
06bc494ca11e Initial load
duke
parents:
diff changeset
    75
        throws IOException
06bc494ca11e Initial load
duke
parents:
diff changeset
    76
    {
06bc494ca11e Initial load
duke
parents:
diff changeset
    77
        return fileManager.list(location, packageName, kinds, recurse);
06bc494ca11e Initial load
duke
parents:
diff changeset
    78
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
    79
06bc494ca11e Initial load
duke
parents:
diff changeset
    80
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    81
     * @throws IllegalStateException {@inheritDoc}
06bc494ca11e Initial load
duke
parents:
diff changeset
    82
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
    83
    public String inferBinaryName(Location location, JavaFileObject file) {
06bc494ca11e Initial load
duke
parents:
diff changeset
    84
        return fileManager.inferBinaryName(location, file);
06bc494ca11e Initial load
duke
parents:
diff changeset
    85
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
    86
06bc494ca11e Initial load
duke
parents:
diff changeset
    87
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    88
     * @throws IllegalArgumentException {@inheritDoc}
06bc494ca11e Initial load
duke
parents:
diff changeset
    89
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
    90
    public boolean isSameFile(FileObject a, FileObject b) {
06bc494ca11e Initial load
duke
parents:
diff changeset
    91
        return fileManager.isSameFile(a, b);
06bc494ca11e Initial load
duke
parents:
diff changeset
    92
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
    93
06bc494ca11e Initial load
duke
parents:
diff changeset
    94
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    95
     * @throws IllegalArgumentException {@inheritDoc}
06bc494ca11e Initial load
duke
parents:
diff changeset
    96
     * @throws IllegalStateException {@inheritDoc}
06bc494ca11e Initial load
duke
parents:
diff changeset
    97
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
    98
    public boolean handleOption(String current, Iterator<String> remaining) {
06bc494ca11e Initial load
duke
parents:
diff changeset
    99
        return fileManager.handleOption(current, remaining);
06bc494ca11e Initial load
duke
parents:
diff changeset
   100
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   101
06bc494ca11e Initial load
duke
parents:
diff changeset
   102
    public boolean hasLocation(Location location) {
06bc494ca11e Initial load
duke
parents:
diff changeset
   103
        return fileManager.hasLocation(location);
06bc494ca11e Initial load
duke
parents:
diff changeset
   104
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   105
06bc494ca11e Initial load
duke
parents:
diff changeset
   106
    public int isSupportedOption(String option) {
06bc494ca11e Initial load
duke
parents:
diff changeset
   107
        return fileManager.isSupportedOption(option);
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
     * @throws IllegalArgumentException {@inheritDoc}
06bc494ca11e Initial load
duke
parents:
diff changeset
   112
     * @throws IllegalStateException {@inheritDoc}
06bc494ca11e Initial load
duke
parents:
diff changeset
   113
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
   114
    public JavaFileObject getJavaFileForInput(Location location,
06bc494ca11e Initial load
duke
parents:
diff changeset
   115
                                              String className,
06bc494ca11e Initial load
duke
parents:
diff changeset
   116
                                              Kind kind)
06bc494ca11e Initial load
duke
parents:
diff changeset
   117
        throws IOException
06bc494ca11e Initial load
duke
parents:
diff changeset
   118
    {
06bc494ca11e Initial load
duke
parents:
diff changeset
   119
        return fileManager.getJavaFileForInput(location, className, kind);
06bc494ca11e Initial load
duke
parents:
diff changeset
   120
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   121
06bc494ca11e Initial load
duke
parents:
diff changeset
   122
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
   123
     * @throws IllegalArgumentException {@inheritDoc}
06bc494ca11e Initial load
duke
parents:
diff changeset
   124
     * @throws IllegalStateException {@inheritDoc}
06bc494ca11e Initial load
duke
parents:
diff changeset
   125
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
   126
    public JavaFileObject getJavaFileForOutput(Location location,
06bc494ca11e Initial load
duke
parents:
diff changeset
   127
                                               String className,
06bc494ca11e Initial load
duke
parents:
diff changeset
   128
                                               Kind kind,
06bc494ca11e Initial load
duke
parents:
diff changeset
   129
                                               FileObject sibling)
06bc494ca11e Initial load
duke
parents:
diff changeset
   130
        throws IOException
06bc494ca11e Initial load
duke
parents:
diff changeset
   131
    {
06bc494ca11e Initial load
duke
parents:
diff changeset
   132
        return fileManager.getJavaFileForOutput(location, className, kind, sibling);
06bc494ca11e Initial load
duke
parents:
diff changeset
   133
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   134
06bc494ca11e Initial load
duke
parents:
diff changeset
   135
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
   136
     * @throws IllegalArgumentException {@inheritDoc}
06bc494ca11e Initial load
duke
parents:
diff changeset
   137
     * @throws IllegalStateException {@inheritDoc}
06bc494ca11e Initial load
duke
parents:
diff changeset
   138
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
   139
    public FileObject getFileForInput(Location location,
06bc494ca11e Initial load
duke
parents:
diff changeset
   140
                                      String packageName,
06bc494ca11e Initial load
duke
parents:
diff changeset
   141
                                      String relativeName)
06bc494ca11e Initial load
duke
parents:
diff changeset
   142
        throws IOException
06bc494ca11e Initial load
duke
parents:
diff changeset
   143
    {
06bc494ca11e Initial load
duke
parents:
diff changeset
   144
        return fileManager.getFileForInput(location, packageName, relativeName);
06bc494ca11e Initial load
duke
parents:
diff changeset
   145
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   146
06bc494ca11e Initial load
duke
parents:
diff changeset
   147
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
   148
     * @throws IllegalArgumentException {@inheritDoc}
06bc494ca11e Initial load
duke
parents:
diff changeset
   149
     * @throws IllegalStateException {@inheritDoc}
06bc494ca11e Initial load
duke
parents:
diff changeset
   150
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
   151
    public FileObject getFileForOutput(Location location,
06bc494ca11e Initial load
duke
parents:
diff changeset
   152
                                       String packageName,
06bc494ca11e Initial load
duke
parents:
diff changeset
   153
                                       String relativeName,
06bc494ca11e Initial load
duke
parents:
diff changeset
   154
                                       FileObject sibling)
06bc494ca11e Initial load
duke
parents:
diff changeset
   155
        throws IOException
06bc494ca11e Initial load
duke
parents:
diff changeset
   156
    {
06bc494ca11e Initial load
duke
parents:
diff changeset
   157
        return fileManager.getFileForOutput(location, packageName, relativeName, sibling);
06bc494ca11e Initial load
duke
parents:
diff changeset
   158
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   159
06bc494ca11e Initial load
duke
parents:
diff changeset
   160
    public void flush() throws IOException {
06bc494ca11e Initial load
duke
parents:
diff changeset
   161
        fileManager.flush();
06bc494ca11e Initial load
duke
parents:
diff changeset
   162
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   163
06bc494ca11e Initial load
duke
parents:
diff changeset
   164
    public void close() throws IOException {
06bc494ca11e Initial load
duke
parents:
diff changeset
   165
        fileManager.close();
06bc494ca11e Initial load
duke
parents:
diff changeset
   166
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   167
}