JavaFileManager (Java SE 10 & JDK 10 ) (original) (raw)
- All Superinterfaces:
[AutoCloseable](../../java/lang/AutoCloseable.html "interface in java.lang")
,[Closeable](../../java/io/Closeable.html "interface in java.io")
,[Flushable](../../java/io/Flushable.html "interface in java.io")
,[OptionChecker](../../javax/tools/OptionChecker.html "interface in javax.tools")
All Known Subinterfaces:[StandardJavaFileManager](../../javax/tools/StandardJavaFileManager.html "interface in javax.tools")
All Known Implementing Classes:[ForwardingJavaFileManager](../../javax/tools/ForwardingJavaFileManager.html "class in javax.tools")
public interface JavaFileManager
extends Closeable, Flushable, OptionChecker
File manager for tools operating on Java™ programming language source and class files. In this context, file means an abstraction of regular files and other sources of data.
When constructing new JavaFileObjects, the file manager must determine where to create them. For example, if a file manager manages regular files on a file system, it would most likely have a current/working directory to use as default location when creating or finding files. A number of hints can be provided to a file manager as to where to create files. Any file manager might choose to ignore these hints.
Some methods in this interface use class names. Such class names must be given in the Java Virtual Machine internal form of fully qualified class and interface names. For convenience '.' and '/' are interchangeable. The internal form is defined in chapter four ofThe Java™ Virtual Machine Specification.
Discussion: this means that the names "java/lang.package-info", "java/lang/package-info", "java.lang.package-info", are valid and equivalent. Compare to binary name as defined inThe Java™ Language Specification, section 13.1 "The Form of a Binary".
The case of names is significant. All names should be treated as case-sensitive. For example, some file systems have case-insensitive, case-aware file names. File objects representing such files should take care to preserve case by using File.getCanonicalFile() or similar means. If the system is not case-aware, file objects must use other means to preserve case.
Relative names: some methods in this interface use relative names. A relative name is a non-null, non-empty sequence of path segments separated by '/'. '.' or '..' are invalid path segments. A valid relative name must match the "path-rootless" rule of RFC 3986, section 3.3. Informally, this should be true:
URI.create(relativeName).normalize().getPath().equals(relativeName)
All methods in this interface might throw a SecurityException.
An object of this interface is not required to support multi-threaded access, that is, be synchronized. However, it must support concurrent access to different file objects created by this object.
Implementation note: a consequence of this requirement is that a trivial implementation of output to a JarOutputStream is not a sufficient implementation. That is, rather than creating a JavaFileObject that returns the JarOutputStream directly, the contents must be cached until closed and then written to the JarOutputStream.
Unless explicitly allowed, all methods in this interface might throw a NullPointerException if given anull
argument.
Since:
1.6
See Also:
JavaFileObject, FileObject
Method Detail
* #### getClassLoader [ClassLoader](../../java/lang/ClassLoader.html "class in java.lang") getClassLoader([JavaFileManager.Location](../../javax/tools/JavaFileManager.Location.html "interface in javax.tools") location) 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](../../javax/tools/StandardLocation.html#ANNOTATION%5FPROCESSOR%5FPATH) location. 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/lang/SecurityException.html "class in java.lang")` \- if a class loader can not be created in the current security context `[IllegalStateException](../../java/lang/IllegalStateException.html "class in java.lang")` \- if [close()](../../javax/tools/JavaFileManager.html#close%28%29) has been called and this file manager cannot be reopened `[IllegalArgumentException](../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if the location is a module-oriented location * #### list [Iterable](../../java/lang/Iterable.html "interface in java.lang")<[JavaFileObject](../../javax/tools/JavaFileObject.html "interface in javax.tools")> list([JavaFileManager.Location](../../javax/tools/JavaFileManager.Location.html "interface in javax.tools") location, [String](../../java/lang/String.html "class in java.lang") packageName, [Set](../../java/util/Set.html "interface in java.util")<[JavaFileObject.Kind](../../javax/tools/JavaFileObject.Kind.html "enum in javax.tools")> kinds, boolean recurse) throws [IOException](../../java/io/IOException.html "class in java.io") 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. 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/io/IOException.html "class in java.io")` \- if an I/O error occurred, or if [close()](../../javax/tools/JavaFileManager.html#close%28%29) has been called and this file manager cannot be reopened `[IllegalArgumentException](../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if the location is a module-oriented location `[IllegalStateException](../../java/lang/IllegalStateException.html "class in java.lang")` \- if [close()](../../javax/tools/JavaFileManager.html#close%28%29) has been called and this file manager cannot be reopened * #### inferBinaryName [String](../../java/lang/String.html "class in java.lang") inferBinaryName([JavaFileManager.Location](../../javax/tools/JavaFileManager.Location.html "interface in javax.tools") location, [JavaFileObject](../../javax/tools/JavaFileObject.html "interface in javax.tools") file) 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. 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: `[IllegalArgumentException](../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if the location is a module-oriented location `[IllegalStateException](../../java/lang/IllegalStateException.html "class in java.lang")` \- if [close()](../../javax/tools/JavaFileManager.html#close%28%29) has been called and this file manager cannot be reopened * #### isSameFile boolean isSameFile([FileObject](../../javax/tools/FileObject.html "interface in javax.tools") a, [FileObject](../../javax/tools/FileObject.html "interface in javax.tools") b) Compares two file objects and return true if they represent the same underlying object. Parameters: `a` \- a file object `b` \- a file object Returns: true if the given file objects represent the same underlying object Throws: `[IllegalArgumentException](../../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 boolean handleOption([String](../../java/lang/String.html "class in java.lang") current, [Iterator](../../java/util/Iterator.html "interface in java.util")<[String](../../java/lang/String.html "class in java.lang")> remaining) 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. Parameters: `current` \- current option `remaining` \- remaining options Returns: true if this option was handled by this file manager, false otherwise Throws: `[IllegalArgumentException](../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if this option to this file manager is used incorrectly `[IllegalStateException](../../java/lang/IllegalStateException.html "class in java.lang")` \- if [close()](../../javax/tools/JavaFileManager.html#close%28%29) has been called and this file manager cannot be reopened * #### hasLocation boolean hasLocation([JavaFileManager.Location](../../javax/tools/JavaFileManager.Location.html "interface in javax.tools") location) Determines if a location is known to this file manager. Parameters: `location` \- a location Returns: true if the location is known * #### getJavaFileForInput [JavaFileObject](../../javax/tools/JavaFileObject.html "interface in javax.tools") getJavaFileForInput([JavaFileManager.Location](../../javax/tools/JavaFileManager.Location.html "interface in javax.tools") location, [String](../../java/lang/String.html "class in java.lang") className, [JavaFileObject.Kind](../../javax/tools/JavaFileObject.Kind.html "enum in javax.tools") kind) throws [IOException](../../java/io/IOException.html "class in java.io") Returns a [file object](../../javax/tools/JavaFileObject.html "interface in javax.tools") for input representing the specified class of the specified kind in the given package-oriented location. Parameters: `location` \- a location `className` \- the name of a class `kind` \- the kind of file, must be one of [SOURCE](../../javax/tools/JavaFileObject.Kind.html#SOURCE) or [CLASS](../../javax/tools/JavaFileObject.Kind.html#CLASS) Returns: a file object, might return `null` if the file does not exist Throws: `[IllegalArgumentException](../../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 `[IOException](../../java/io/IOException.html "class in java.io")` \- if an I/O error occurred, or if [close()](../../javax/tools/JavaFileManager.html#close%28%29) has been called and this file manager cannot be reopened `[IllegalStateException](../../java/lang/IllegalStateException.html "class in java.lang")` \- if [close()](../../javax/tools/JavaFileManager.html#close%28%29) has been called and this file manager cannot be reopened * #### getJavaFileForOutput [JavaFileObject](../../javax/tools/JavaFileObject.html "interface in javax.tools") getJavaFileForOutput([JavaFileManager.Location](../../javax/tools/JavaFileManager.Location.html "interface in javax.tools") location, [String](../../java/lang/String.html "class in java.lang") className, [JavaFileObject.Kind](../../javax/tools/JavaFileObject.Kind.html "enum in javax.tools") kind, [FileObject](../../javax/tools/FileObject.html "interface in javax.tools") sibling) throws [IOException](../../java/io/IOException.html "class in java.io") Returns a [file object](../../javax/tools/JavaFileObject.html "interface in javax.tools") 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. Parameters: `location` \- a package-oriented location `className` \- the name of a class `kind` \- the kind of file, must be one of [SOURCE](../../javax/tools/JavaFileObject.Kind.html#SOURCE) or [CLASS](../../javax/tools/JavaFileObject.Kind.html#CLASS) `sibling` \- a file object to be used as hint for placement; might be `null` Returns: a file object for output Throws: `[IllegalArgumentException](../../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 `[IOException](../../java/io/IOException.html "class in java.io")` \- if an I/O error occurred, or if [close()](../../javax/tools/JavaFileManager.html#close%28%29) has been called and this file manager cannot be reopened `[IllegalStateException](../../java/lang/IllegalStateException.html "class in java.lang")` \- [close()](../../javax/tools/JavaFileManager.html#close%28%29) has been called and this file manager cannot be reopened * #### getFileForInput [FileObject](../../javax/tools/FileObject.html "interface in javax.tools") getFileForInput([JavaFileManager.Location](../../javax/tools/JavaFileManager.Location.html "interface in javax.tools") location, [String](../../java/lang/String.html "class in java.lang") packageName, [String](../../java/lang/String.html "class in java.lang") relativeName) throws [IOException](../../java/io/IOException.html "class in java.io") Returns a [file object](../../javax/tools/FileObject.html "interface in javax.tools") for input representing the specified [relative name](JavaFileManager.html#relative%5Fname) in the specified package in the given package-oriented location. If the returned object represents a [source](../../javax/tools/JavaFileObject.Kind.html#SOURCE) or [class](../../javax/tools/JavaFileObject.Kind.html#CLASS) file, it must be an instance of [JavaFileObject](../../javax/tools/JavaFileObject.html "interface in javax.tools"). 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](../../javax/tools/StandardLocation.html#SOURCE%5FPATH) 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"`. 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/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 `[IOException](../../java/io/IOException.html "class in java.io")` \- if an I/O error occurred, or if [close()](../../javax/tools/JavaFileManager.html#close%28%29) has been called and this file manager cannot be reopened `[IllegalStateException](../../java/lang/IllegalStateException.html "class in java.lang")` \- if [close()](../../javax/tools/JavaFileManager.html#close%28%29) has been called and this file manager cannot be reopened * #### getFileForOutput [FileObject](../../javax/tools/FileObject.html "interface in javax.tools") getFileForOutput([JavaFileManager.Location](../../javax/tools/JavaFileManager.Location.html "interface in javax.tools") location, [String](../../java/lang/String.html "class in java.lang") packageName, [String](../../java/lang/String.html "class in java.lang") relativeName, [FileObject](../../javax/tools/FileObject.html "interface in javax.tools") sibling) throws [IOException](../../java/io/IOException.html "class in java.io") Returns a [file object](../../javax/tools/FileObject.html "interface in javax.tools") for output representing the specified [relative name](JavaFileManager.html#relative%5Fname) 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](../../javax/tools/JavaFileObject.Kind.html#SOURCE) or [class](../../javax/tools/JavaFileObject.Kind.html#CLASS) file, it must be an instance of [JavaFileObject](../../javax/tools/JavaFileObject.html "interface in javax.tools"). 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](../../javax/tools/JavaFileManager.html#getFileForInput%28javax.tools.JavaFileManager.Location,java.lang.String,java.lang.String%29) for an example. 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/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 `[IOException](../../java/io/IOException.html "class in java.io")` \- if an I/O error occurred, or if [close()](../../javax/tools/JavaFileManager.html#close%28%29) has been called and this file manager cannot be reopened `[IllegalStateException](../../java/lang/IllegalStateException.html "class in java.lang")` \- if [close()](../../javax/tools/JavaFileManager.html#close%28%29) has been called and this file manager cannot be reopened * #### flush void flush() throws [IOException](../../java/io/IOException.html "class in java.io") 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/io/Flushable.html#flush%28%29)` in interface `[Flushable](../../java/io/Flushable.html "interface in java.io")` Throws: `[IOException](../../java/io/IOException.html "class in java.io")` \- if an I/O error occurred See Also: [close()](../../javax/tools/JavaFileManager.html#close%28%29) * #### close void close() throws [IOException](../../java/io/IOException.html "class in java.io") 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/lang/AutoCloseable.html#close%28%29)` in interface `[AutoCloseable](../../java/lang/AutoCloseable.html "interface in java.lang")` Specified by: `[close](../../java/io/Closeable.html#close%28%29)` in interface `[Closeable](../../java/io/Closeable.html "interface in java.io")` Throws: `[IOException](../../java/io/IOException.html "class in java.io")` \- if an I/O error occurred See Also: [flush()](../../javax/tools/JavaFileManager.html#flush%28%29) * #### getLocationForModule default [JavaFileManager.Location](../../javax/tools/JavaFileManager.Location.html "interface in javax.tools") getLocationForModule([JavaFileManager.Location](../../javax/tools/JavaFileManager.Location.html "interface in javax.tools") location, [String](../../java/lang/String.html "class in java.lang") moduleName) throws [IOException](../../java/io/IOException.html "class in java.io") 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. Implementation Requirements: This implementation throws `UnsupportedOperationException`. 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/io/IOException.html "class in java.io")` \- if an I/O error occurred `[UnsupportedOperationException](../../java/lang/UnsupportedOperationException.html "class in java.lang")` \- if this operation if not supported by this file manager `[IllegalArgumentException](../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if the location is neither an output location nor a module-oriented location Since: 9 * #### getLocationForModule default [JavaFileManager.Location](../../javax/tools/JavaFileManager.Location.html "interface in javax.tools") getLocationForModule([JavaFileManager.Location](../../javax/tools/JavaFileManager.Location.html "interface in javax.tools") location, [JavaFileObject](../../javax/tools/JavaFileObject.html "interface in javax.tools") fo) throws [IOException](../../java/io/IOException.html "class in java.io") 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. Implementation Requirements: This implementation throws `UnsupportedOperationException`. Parameters: `location` \- the module-oriented location `fo` \- the file Returns: the module containing the file Throws: `[IOException](../../java/io/IOException.html "class in java.io")` \- if an I/O error occurred `[UnsupportedOperationException](../../java/lang/UnsupportedOperationException.html "class in java.lang")` \- if this operation if not supported by this file manager `[IllegalArgumentException](../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if the location is neither an output location nor a module-oriented location Since: 9 * #### getServiceLoader default <S> [ServiceLoader](../../java/util/ServiceLoader.html "class in java.util")<S> getServiceLoader([JavaFileManager.Location](../../javax/tools/JavaFileManager.Location.html "interface in javax.tools") location, [Class](../../java/lang/Class.html "class in java.lang")<S> service) throws [IOException](../../java/io/IOException.html "class in java.io") 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`. Implementation Requirements: This implementation throws `UnsupportedOperationException`. 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/io/IOException.html "class in java.io")` \- if an I/O error occurred `[UnsupportedOperationException](../../java/lang/UnsupportedOperationException.html "class in java.lang")` \- if this operation if not supported by this file manager Since: 9 * #### inferModuleName default [String](../../java/lang/String.html "class in java.lang") inferModuleName([JavaFileManager.Location](../../javax/tools/JavaFileManager.Location.html "interface in javax.tools") location) throws [IOException](../../java/io/IOException.html "class in java.io") Infer the name of the module from its location, as returned by`getLocationForModule` or `listModuleLocations`. Implementation Requirements: This implementation throws `UnsupportedOperationException`. Parameters: `location` \- a package-oriented location representing a module Returns: the name of the module Throws: `[IOException](../../java/io/IOException.html "class in java.io")` \- if an I/O error occurred `[UnsupportedOperationException](../../java/lang/UnsupportedOperationException.html "class in java.lang")` \- if this operation if not supported by this file manager `[IllegalArgumentException](../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if the location is not one known to this file manager Since: 9 * #### listLocationsForModules default [Iterable](../../java/lang/Iterable.html "interface in java.lang")<[Set](../../java/util/Set.html "interface in java.util")<[JavaFileManager.Location](../../javax/tools/JavaFileManager.Location.html "interface in javax.tools")>> listLocationsForModules([JavaFileManager.Location](../../javax/tools/JavaFileManager.Location.html "interface in javax.tools") location) throws [IOException](../../java/io/IOException.html "class in java.io") 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. Implementation Requirements: This implementation throws `UnsupportedOperationException`. Parameters: `location` \- the module-oriented location for which to list the modules Returns: a series of sets of locations containing modules Throws: `[IOException](../../java/io/IOException.html "class in java.io")` \- if an I/O error occurred `[UnsupportedOperationException](../../java/lang/UnsupportedOperationException.html "class in java.lang")` \- if this operation if not supported by this file manager `[IllegalArgumentException](../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if the location is not a module-oriented location Since: 9 * #### contains default boolean contains([JavaFileManager.Location](../../javax/tools/JavaFileManager.Location.html "interface in javax.tools") location, [FileObject](../../javax/tools/FileObject.html "interface in javax.tools") fo) throws [IOException](../../java/io/IOException.html "class in java.io") 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](../../javax/tools/JavaFileManager.html#isSameFile%28javax.tools.FileObject,javax.tools.FileObject%29) 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. Implementation Requirements: This implementation throws `UnsupportedOperationException`. Parameters: `location` \- the location `fo` \- the file object Returns: whether or not the file is contained in the location Throws: `[IOException](../../java/io/IOException.html "class in java.io")` \- if there is a problem determining the result `[UnsupportedOperationException](../../java/lang/UnsupportedOperationException.html "class in java.lang")` \- if the method is not supported Since: 9