ForwardingJavaFileManager (Java SE 16 & JDK 16) (original) (raw)

Type Parameters:

M - the kind of file manager forwarded to by this object

All Implemented Interfaces:

[Closeable](../../../java.base/java/io/Closeable.html "interface in java.io"), [Flushable](../../../java.base/java/io/Flushable.html "interface in java.io"), [AutoCloseable](../../../java.base/java/lang/AutoCloseable.html "interface in java.lang"), [JavaFileManager](JavaFileManager.html "interface in javax.tools"), [OptionChecker](OptionChecker.html "interface in javax.tools")

Forwards calls to a given file manager. Subclasses of this class might override some of these methods and might also provide additional fields and methods.

Since:

1.6

• Nested Class Summary

• Field Summary

Fields
protected [M](ForwardingJavaFileManager.html "type parameter in ForwardingJavaFileManager")
The file manager which all methods are delegated to.

• Constructor Summary

Constructors
protected
[ForwardingJavaFileManager](#%3Cinit%3E%28M%29)​([M](ForwardingJavaFileManager.html "type parameter in ForwardingJavaFileManager") fileManager)
Creates a new instance of ForwardingJavaFileManager.

• Method Summary

void
[close](#close%28%29)()
Releases any resources opened by this file manager directly or indirectly.
boolean
Determines whether or not a given file object is "contained in" a specified location.
void
[flush](#flush%28%29)()
Flushes any resources opened for output by this file manager directly or indirectly.
Returns a class loader for loading plug-ins from the given package-oriented location.
Returns a file object for input representing the specified relative name in the specified package in the given package-oriented location.
Returns a file object for output representing the specified relative name in the specified package in the given location.
Returns a file object for input representing the specified class of the specified kind in the given package-oriented location.
Returns a file object for output representing the specified class of the specified kind in the given package-oriented location.
Gets a location for a named module within a location, which may be either a module-oriented location or an output location.
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.
Get a service loader for a specific service class from a given location.
boolean
boolean
Determines if a location is known to this file manager.
Infers a binary name of a file object based on a package-oriented location.
Infer the name of the module from its location, as returned bygetLocationForModule or listModuleLocations.
boolean
Compares two file objects and return true if they represent the same underlying object.
int
Determines if the given option is supported and if so, the number of arguments the option takes.
Lists all file objects matching the given criteria in the given package-oriented location.
Lists the locations for all the modules in a module-oriented location or an output location.

Methods declared in class java.lang.Object

[clone](../../../java.base/java/lang/Object.html#clone%28%29), [equals](../../../java.base/java/lang/Object.html#equals%28java.lang.Object%29), [finalize](../../../java.base/java/lang/Object.html#finalize%28%29), [getClass](../../../java.base/java/lang/Object.html#getClass%28%29), [hashCode](../../../java.base/java/lang/Object.html#hashCode%28%29), [notify](../../../java.base/java/lang/Object.html#notify%28%29), [notifyAll](../../../java.base/java/lang/Object.html#notifyAll%28%29), [toString](../../../java.base/java/lang/Object.html#toString%28%29), [wait](../../../java.base/java/lang/Object.html#wait%28%29), [wait](../../../java.base/java/lang/Object.html#wait%28long%29), [wait](../../../java.base/java/lang/Object.html#wait%28long,int%29)

• Field Details

  • fileManager

  The file manager which all methods are delegated to.

• Constructor Details

  • ForwardingJavaFileManager

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

• Method Details

  • getClassLoader

  Returns a class loader for loading plug-ins from the given package-oriented location. For example, to load annotation processors, a compiler will request a class loader for the ANNOTATION_PROCESSOR_PATH location.
  Specified by:
  [getClassLoader](JavaFileManager.html#getClassLoader%28javax.tools.JavaFileManager.Location%29) in interface [JavaFileManager](JavaFileManager.html "interface in javax.tools")
  Parameters:
  location - a location
  Returns:
  a class loader for the given location; or null if loading plug-ins from the given location is disabled or if the location is not known
  Throws:
  [SecurityException](../../../java.base/java/lang/SecurityException.html "class in java.lang") - if a class loader can not be created in the current security context
  [IllegalStateException](../../../java.base/java/lang/IllegalStateException.html "class in java.lang") - if JavaFileManager.close() has been called and this file manager cannot be reopened

  • list

  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](JavaFileManager.html#list%28javax.tools.JavaFileManager.Location,java.lang.String,java.util.Set,boolean%29) in interface [JavaFileManager](JavaFileManager.html "interface in javax.tools")
  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](../../../java.base/java/io/IOException.html "class in java.io") - if an I/O error occurred, or if JavaFileManager.close() has been called and this file manager cannot be reopened
  [IllegalStateException](../../../java.base/java/lang/IllegalStateException.html "class in java.lang") - if JavaFileManager.close() has been called and this file manager cannot be reopened

  • inferBinaryName

  Infers a binary name of a file object based on a package-oriented location. The binary name returned might not be a valid binary name according toThe Java Language Specification.
  Specified by:
  [inferBinaryName](JavaFileManager.html#inferBinaryName%28javax.tools.JavaFileManager.Location,javax.tools.JavaFileObject%29) in interface [JavaFileManager](JavaFileManager.html "interface in javax.tools")
  Parameters:
  location - a location
  file - a file object
  Returns:
  a binary name or null the file object is not found in the given location
  Throws:
  [IllegalStateException](../../../java.base/java/lang/IllegalStateException.html "class in java.lang") - if JavaFileManager.close() has been called and this file manager cannot be reopened

  • isSameFile

  Compares two file objects and return true if they represent the same underlying object.
  Specified by:
  [isSameFile](JavaFileManager.html#isSameFile%28javax.tools.FileObject,javax.tools.FileObject%29) in interface [JavaFileManager](JavaFileManager.html "interface in javax.tools")
  Parameters:
  a - a file object
  b - a file object
  Returns:
  true if the given file objects represent the same underlying object
  Throws:
  [IllegalArgumentException](../../../java.base/java/lang/IllegalArgumentException.html "class in java.lang") - if either of the arguments were created with another file manager and this file manager does not support foreign file objects

  • handleOption

  Handles one option. If current is an option to this file manager it will consume any arguments to that option fromremaining and return true, otherwise return false.
  Specified by:
  [handleOption](JavaFileManager.html#handleOption%28java.lang.String,java.util.Iterator%29) in interface [JavaFileManager](JavaFileManager.html "interface in javax.tools")
  Parameters:
  current - current option
  remaining - remaining options
  Returns:
  true if this option was handled by this file manager, false otherwise
  Throws:
  [IllegalArgumentException](../../../java.base/java/lang/IllegalArgumentException.html "class in java.lang") - if this option to this file manager is used incorrectly
  [IllegalStateException](../../../java.base/java/lang/IllegalStateException.html "class in java.lang") - if JavaFileManager.close() has been called and this file manager cannot be reopened

  • hasLocation

  Determines if a location is known to this file manager.
  Specified by:
  [hasLocation](JavaFileManager.html#hasLocation%28javax.tools.JavaFileManager.Location%29) in interface [JavaFileManager](JavaFileManager.html "interface in javax.tools")
  Parameters:
  location - a location
  Returns:
  true if the location is known

  • isSupportedOption

  public int isSupportedOption​(String option)
  Determines if the given option is supported and if so, the number of arguments the option takes.
  Specified by:
  [isSupportedOption](OptionChecker.html#isSupportedOption%28java.lang.String%29) in interface [OptionChecker](OptionChecker.html "interface in javax.tools")
  Parameters:
  option - an option
  Returns:
  the number of arguments the given option takes or -1 if the option is not supported

  • getJavaFileForInput

  Returns a file object for input representing the specified class of the specified kind in the given package-oriented location.
  Specified by:
  [getJavaFileForInput](JavaFileManager.html#getJavaFileForInput%28javax.tools.JavaFileManager.Location,java.lang.String,javax.tools.JavaFileObject.Kind%29) in interface [JavaFileManager](JavaFileManager.html "interface in javax.tools")
  Parameters:
  location - a location
  className - the name of a class
  kind - the kind of file, must be one of SOURCE or CLASS
  Returns:
  a file object, might return null if the file does not exist
  Throws:
  [IllegalArgumentException](../../../java.base/java/lang/IllegalArgumentException.html "class in java.lang") - 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 a module-oriented location
  [IllegalStateException](../../../java.base/java/lang/IllegalStateException.html "class in java.lang") - if JavaFileManager.close() has been called and this file manager cannot be reopened
  [IOException](../../../java.base/java/io/IOException.html "class in java.io") - if an I/O error occurred, or if JavaFileManager.close() has been called and this file manager cannot be reopened

  • getJavaFileForOutput

  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](JavaFileManager.html#getJavaFileForOutput%28javax.tools.JavaFileManager.Location,java.lang.String,javax.tools.JavaFileObject.Kind,javax.tools.FileObject%29) in interface [JavaFileManager](JavaFileManager.html "interface in javax.tools")
  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](../../../java.base/java/lang/IllegalArgumentException.html "class in java.lang") - 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](../../../java.base/java/lang/IllegalStateException.html "class in java.lang") - JavaFileManager.close() has been called and this file manager cannot be reopened
  [IOException](../../../java.base/java/io/IOException.html "class in java.io") - if an I/O error occurred, or if JavaFileManager.close() has been called and this file manager cannot be reopened

  • getFileForInput

  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](JavaFileManager.html#getFileForInput%28javax.tools.JavaFileManager.Location,java.lang.String,java.lang.String%29) in interface [JavaFileManager](JavaFileManager.html "interface in javax.tools")
  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](../../../java.base/java/lang/IllegalArgumentException.html "class in java.lang") - 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](../../../java.base/java/lang/IllegalStateException.html "class in java.lang") - if JavaFileManager.close() has been called and this file manager cannot be reopened
  [IOException](../../../java.base/java/io/IOException.html "class in java.io") - if an I/O error occurred, or if JavaFileManager.close() has been called and this file manager cannot be reopened

  • getFileForOutput

  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](JavaFileManager.html#getFileForOutput%28javax.tools.JavaFileManager.Location,java.lang.String,java.lang.String,javax.tools.FileObject%29) in interface [JavaFileManager](JavaFileManager.html "interface in javax.tools")
  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](../../../java.base/java/lang/IllegalArgumentException.html "class in java.lang") - 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](../../../java.base/java/lang/IllegalStateException.html "class in java.lang") - if JavaFileManager.close() has been called and this file manager cannot be reopened
  [IOException](../../../java.base/java/io/IOException.html "class in java.io") - if an I/O error occurred, or if JavaFileManager.close() has been called and this file manager cannot be reopened

  • flush

  Flushes any resources opened for output by this file manager directly or indirectly. Flushing a closed file manager has no effect.
  Specified by:
  [flush](../../../java.base/java/io/Flushable.html#flush%28%29) in interface [Flushable](../../../java.base/java/io/Flushable.html "interface in java.io")
  Specified by:
  [flush](JavaFileManager.html#flush%28%29) in interface [JavaFileManager](JavaFileManager.html "interface in javax.tools")
  Throws:
  [IOException](../../../java.base/java/io/IOException.html "class in java.io") - if an I/O error occurred
  See Also:
  JavaFileManager.close()

  • close

  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](../../../java.base/java/lang/AutoCloseable.html#close%28%29) in interface [AutoCloseable](../../../java.base/java/lang/AutoCloseable.html "interface in java.lang")
  Specified by:
  [close](../../../java.base/java/io/Closeable.html#close%28%29) in interface [Closeable](../../../java.base/java/io/Closeable.html "interface in java.io")
  Specified by:
  [close](JavaFileManager.html#close%28%29) in interface [JavaFileManager](JavaFileManager.html "interface in javax.tools")
  Throws:
  [IOException](../../../java.base/java/io/IOException.html "class in java.io") - if an I/O error occurred
  See Also:
  JavaFileManager.flush()

  • getLocationForModule

  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](JavaFileManager.html#getLocationForModule%28javax.tools.JavaFileManager.Location,java.lang.String%29) in interface [JavaFileManager](JavaFileManager.html "interface in javax.tools")
  Parameters:
  location - the module-oriented location
  moduleName - the name of the module to be found
  Returns:
  the location for the named module
  Throws:
  [IOException](../../../java.base/java/io/IOException.html "class in java.io") - if an I/O error occurred
  Since:
  9

  • getLocationForModule

  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](JavaFileManager.html#getLocationForModule%28javax.tools.JavaFileManager.Location,javax.tools.JavaFileObject%29) in interface [JavaFileManager](JavaFileManager.html "interface in javax.tools")
  Parameters:
  location - the module-oriented location
  fo - the file
  Returns:
  the module containing the file
  Throws:
  [IOException](../../../java.base/java/io/IOException.html "class in java.io") - if an I/O error occurred
  Since:
  9

  • getServiceLoader

  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](JavaFileManager.html#getServiceLoader%28javax.tools.JavaFileManager.Location,java.lang.Class%29) in interface [JavaFileManager](JavaFileManager.html "interface in javax.tools")
  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](../../../java.base/java/io/IOException.html "class in java.io") - if an I/O error occurred
  Since:
  9

  • inferModuleName

  Infer the name of the module from its location, as returned bygetLocationForModule or listModuleLocations.
  Specified by:
  [inferModuleName](JavaFileManager.html#inferModuleName%28javax.tools.JavaFileManager.Location%29) in interface [JavaFileManager](JavaFileManager.html "interface in javax.tools")
  Parameters:
  location - a package-oriented location representing a module
  Returns:
  the name of the module
  Throws:
  [IOException](../../../java.base/java/io/IOException.html "class in java.io") - if an I/O error occurred
  Since:
  9

  • listLocationsForModules

  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](JavaFileManager.html#listLocationsForModules%28javax.tools.JavaFileManager.Location%29) in interface [JavaFileManager](JavaFileManager.html "interface in javax.tools")
  Parameters:
  location - the module-oriented location for which to list the modules
  Returns:
  a series of sets of locations containing modules
  Throws:
  [IOException](../../../java.base/java/io/IOException.html "class in java.io") - if an I/O error occurred
  Since:
  9

  • contains

  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](JavaFileManager.html#contains%28javax.tools.JavaFileManager.Location,javax.tools.FileObject%29) in interface [JavaFileManager](JavaFileManager.html "interface in javax.tools")
  Parameters:
  location - the location
  fo - the file object
  Returns:
  whether or not the file is contained in the location
  Throws:
  [IOException](../../../java.base/java/io/IOException.html "class in java.io") - if there is a problem determining the result
  Since:
  9