Module java.compiler
Package javax.tools

Class ForwardingJavaFileManager<M extends JavaFileManager>

    • Field Detail

      • fileManager

        protected final M extends JavaFileManager fileManager
        The file manager which all methods are delegated to.

    • Constructor Detail

      • ForwardingJavaFileManager

        protected ForwardingJavaFileManager​(M fileManager)
        Creates a new instance of ForwardingJavaFileManager.
        Parameters:
        fileManager - delegate to this file manager

    • Method Detail

      • list

        public Iterable<JavaFileObject> list​(JavaFileManager.Location location,
                                     String packageName,
                                     Set<JavaFileObject.Kind> kinds,
                                     boolean recurse)
                              throws IOException
        Description copied from interface: JavaFileManager
        Lists all file objects matching the given criteria in the given package-oriented location. List file objects in "subpackages" if recurse is true.

        Note: even if the given location is unknown to this file manager, it may not return null. Also, an unknown location may not cause an exception.

        Specified by:
        list in interface JavaFileManager
        Parameters:
        location - a location
        packageName - a package name
        kinds - return objects only of these kinds
        recurse - if true include "subpackages"
        Returns:
        an Iterable of file objects matching the given criteria
        Throws:
        IOException - if an I/O error occurred, or if JavaFileManager.close() has been called and this file manager cannot be reopened
        IllegalStateException - if JavaFileManager.close() has been called and this file manager cannot be reopened

      • isSameFile

        public boolean isSameFile​(FileObject a,
                          FileObject b)
        Description copied from interface: JavaFileManager
        Compares two file objects and return true if they represent the same underlying object.
        Specified by:
        isSameFile in interface JavaFileManager
        Parameters:
        a - a file object
        b - a file object
        Returns:
        true if the given file objects represent the same underlying object
        Throws:
        IllegalArgumentException - if either of the arguments were created with another file manager and this file manager does not support foreign file objects

      • handleOption

        public boolean handleOption​(String current,
                            Iterator<String> remaining)
        Description copied from interface: JavaFileManager
        Handles one option. If current is an option to this file manager it will consume any arguments to that option from remaining and return true, otherwise return false.
        Specified by:
        handleOption in interface JavaFileManager
        Parameters:
        current - current option
        remaining - remaining options
        Returns:
        true if this option was handled by this file manager, false otherwise
        Throws:
        IllegalArgumentException - if this option to this file manager is used incorrectly
        IllegalStateException - if JavaFileManager.close() has been called and this file manager cannot be reopened

      • isSupportedOption

        public int isSupportedOption​(String option)
        Description copied from interface: OptionChecker
        Determines if the given option is supported and if so, the number of arguments the option takes.
        Specified by:
        isSupportedOption in interface OptionChecker
        Parameters:
        option - an option
        Returns:
        the number of arguments the given option takes or -1 if the option is not supported

      • getJavaFileForOutput

        public JavaFileObject getJavaFileForOutput​(JavaFileManager.Location location,
                                           String className,
                                           JavaFileObject.Kind kind,
                                           FileObject sibling)
                                    throws IOException
        Description copied from interface: JavaFileManager
        Returns a file object for output representing the specified class of the specified kind in the given package-oriented location.

        Optionally, this file manager might consider the sibling as a hint for where to place the output. The exact semantics of this hint is unspecified. The JDK compiler, javac, for example, will place class files in the same directories as originating source files unless a class file output directory is provided. To facilitate this behavior, javac might provide the originating source file as sibling when calling this method.

        Specified by:
        getJavaFileForOutput in interface JavaFileManager
        Parameters:
        location - a package-oriented location
        className - the name of a class
        kind - the kind of file, must be one of SOURCE or CLASS
        sibling - a file object to be used as hint for placement; might be null
        Returns:
        a file object for output
        Throws:
        IllegalArgumentException - if sibling is not known to this file manager, or if the location is not known to this file manager and the file manager does not support unknown locations, or if the kind is not valid, or if the location is not an output location
        IllegalStateException - JavaFileManager.close() has been called and this file manager cannot be reopened
        IOException - if an I/O error occurred, or if JavaFileManager.close() has been called and this file manager cannot be reopened

      • getFileForInput

        public FileObject getFileForInput​(JavaFileManager.Location location,
                                  String packageName,
                                  String relativeName)
                           throws IOException
        Description copied from interface: JavaFileManager
        Returns a file object for input representing the specified relative name in the specified package in the given package-oriented location.

        If the returned object represents a source or class file, it must be an instance of JavaFileObject.

        Informally, the file object returned by this method is located in the concatenation of the location, package name, and relative name. For example, to locate the properties file "resources/compiler.properties" in the package "com.sun.tools.javac" in the SOURCE_PATH location, this method might be called like so: 

        getFileForInput(SOURCE_PATH, "com.sun.tools.javac", "resources/compiler.properties");

        If the call was executed on Windows, with SOURCE_PATH set to "C:\Documents and Settings\UncleBob\src\share\classes", a valid result would be a file object representing the file "C:\Documents and Settings\UncleBob\src\share\classes\com\sun\tools\javac\resources\compiler.properties".

        Specified by:
        getFileForInput in interface JavaFileManager
        Parameters:
        location - a package-oriented location
        packageName - a package name
        relativeName - a relative name
        Returns:
        a file object, might return null if the file does not exist
        Throws:
        IllegalArgumentException - if the location is not known to this file manager and the file manager does not support unknown locations, or if relativeName is not valid, or if the location is a module-oriented location
        IllegalStateException - if JavaFileManager.close() has been called and this file manager cannot be reopened
        IOException - if an I/O error occurred, or if JavaFileManager.close() has been called and this file manager cannot be reopened

      • getFileForOutput

        public FileObject getFileForOutput​(JavaFileManager.Location location,
                                   String packageName,
                                   String relativeName,
                                   FileObject sibling)
                            throws IOException
        Description copied from interface: JavaFileManager
        Returns a file object for output representing the specified relative name in the specified package in the given location.

        Optionally, this file manager might consider the sibling as a hint for where to place the output. The exact semantics of this hint is unspecified. The JDK compiler, javac, for example, will place class files in the same directories as originating source files unless a class file output directory is provided. To facilitate this behavior, javac might provide the originating source file as sibling when calling this method.

        If the returned object represents a source or class file, it must be an instance of JavaFileObject.

        Informally, the file object returned by this method is located in the concatenation of the location, package name, and relative name or next to the sibling argument. See getFileForInput for an example.

        Specified by:
        getFileForOutput in interface JavaFileManager
        Parameters:
        location - an output location
        packageName - a package name
        relativeName - a relative name
        sibling - a file object to be used as hint for placement; might be null
        Returns:
        a file object
        Throws:
        IllegalArgumentException - if sibling is not known to this file manager, or if the location is not known to this file manager and the file manager does not support unknown locations, or if relativeName is not valid, or if the location is not an output location
        IllegalStateException - if JavaFileManager.close() has been called and this file manager cannot be reopened
        IOException - if an I/O error occurred, or if JavaFileManager.close() has been called and this file manager cannot be reopened

      • close

        public void close​()
           throws IOException
        Description copied from interface: JavaFileManager
        Releases any resources opened by this file manager directly or indirectly. This might render this file manager useless and the effect of subsequent calls to methods on this object or any objects obtained through this object is undefined unless explicitly allowed. However, closing a file manager which has already been closed has no effect.
        Specified by:
        close in interface AutoCloseable
        Specified by:
        close in interface Closeable
        Specified by:
        close in interface JavaFileManager
        Throws:
        IOException - if an I/O error occurred
        See Also:
        JavaFileManager.flush()

      • getLocationForModule

        public JavaFileManager.Location getLocationForModule​(JavaFileManager.Location location,
                                                     String moduleName)
                                              throws IOException
        Description copied from interface: JavaFileManager
        Gets a location for a named module within a location, which may be either a module-oriented location or an output location. The result will be an output location if the given location is an output location, or it will be a package-oriented location.
        Specified by:
        getLocationForModule in interface JavaFileManager
        Parameters:
        location - the module-oriented location
        moduleName - the name of the module to be found
        Returns:
        the location for the named module
        Throws:
        IOException - if an I/O error occurred
        Since:
        9

      • getLocationForModule

        public JavaFileManager.Location getLocationForModule​(JavaFileManager.Location location,
                                                     JavaFileObject fo)
                                              throws IOException
        Description copied from interface: JavaFileManager
        Gets a location for the module containing a specific file to be found within a location, which may be either a module-oriented location or an output location. The result will be an output location if the given location is an output location, or it will be a package-oriented location.
        Specified by:
        getLocationForModule in interface JavaFileManager
        Parameters:
        location - the module-oriented location
        fo - the file
        Returns:
        the module containing the file
        Throws:
        IOException - if an I/O error occurred
        Since:
        9

      • getServiceLoader

        public <S> ServiceLoader<S> getServiceLoader​(JavaFileManager.Location location,
                                             Class<S> service)
                                      throws IOException
        Description copied from interface: JavaFileManager
        Get a service loader for a specific service class from a given location. If the location is a module-oriented location, the service loader will use the service declarations in the modules found in that location. Otherwise, a service loader is created using the package-oriented location, in which case, the services are determined using the provider-configuration files in META-INF/services.
        Specified by:
        getServiceLoader in interface JavaFileManager
        Type Parameters:
        S - the service class
        Parameters:
        location - the module-oriented location
        service - the Class object of the service class
        Returns:
        a service loader for the given service class
        Throws:
        IOException - if an I/O error occurred
        Since:
        9

      • inferModuleName

        public String inferModuleName​(JavaFileManager.Location location)
                       throws IOException
        Description copied from interface: JavaFileManager
        Infer the name of the module from its location, as returned by getLocationForModule or listModuleLocations.
        Specified by:
        inferModuleName in interface JavaFileManager
        Parameters:
        location - a package-oriented location representing a module
        Returns:
        the name of the module
        Throws:
        IOException - if an I/O error occurred
        Since:
        9

      • listLocationsForModules

        public Iterable<Set<JavaFileManager.Location>> listLocationsForModules​(JavaFileManager.Location location)
                                                                throws IOException
        Description copied from interface: JavaFileManager
        Lists the locations for all the modules in a module-oriented location or an output location. The locations that are returned will be output locations if the given location is an output, or it will be a package-oriented locations.
        Specified by:
        listLocationsForModules in interface JavaFileManager
        Parameters:
        location - the module-oriented location for which to list the modules
        Returns:
        a series of sets of locations containing modules
        Throws:
        IOException - if an I/O error occurred
        Since:
        9

      • contains

        public boolean contains​(JavaFileManager.Location location,
                        FileObject fo)
                 throws IOException
        Description copied from interface: JavaFileManager
        Determines whether or not a given file object is "contained in" a specified location.

        For a package-oriented location, a file object is contained in the location if there exist values for packageName and relativeName such that either of the following calls would return the same file object: 

             getFileForInput(location, packageName, relativeName)
     getFileForOutput(location, packageName, relativeName, null)

        For a module-oriented location, a file object is contained in the location if there exists a module that may be obtained by the call: 

             getLocationForModule(location, moduleName)
        such that the file object is contained in the (package-oriented) location for that module.
        Specified by:
        contains in interface JavaFileManager
        Parameters:
        location - the location
        fo - the file object
        Returns:
        whether or not the file is contained in the location
        Throws:
        IOException - if there is a problem determining the result
        Since:
        9