AutoCloseable
, Closeable
, Flushable
, JavaFileManager
, OptionChecker
public interface StandardJavaFileManager extends JavaFileManager
java.io.File
and java.nio.file.Path
. A common way to obtain an instance of this class is using getStandardFileManager, for example: JavaCompiler compiler = ToolProvider.getSystemJavaCompiler();This file manager creates file objects representing regular files, zip file entries, or entries in similar file system based containers. Any file object returned from a file manager implementing this interface must observe the following behavior:DiagnosticCollector<JavaFileObject>
diagnostics = newDiagnosticCollector<JavaFileObject>()
; StandardJavaFileManager fm = compiler.getStandardFileManager(diagnostics, null, null);
FileObject.delete()
is equivalent to File.delete()
, FileObject.getLastModified()
is equivalent to File.lastModified()
, FileObject.getCharContent(boolean)
, FileObject.openInputStream()
, and FileObject.openReader(boolean)
must succeed if the following would succeed (ignoring encoding issues): new FileInputStream
(new File
(fileObject
.toUri
()))
FileObject.openOutputStream()
, and FileObject.openWriter()
must succeed if the following would succeed (ignoring encoding issues): new FileOutputStream
(new File
(fileObject
.toUri
()))
FileObject.toUri()
file:///C:/Documents%20and%20Settings/UncleBob/BobsApp/Test.java
jar:///C:/Documents%20and%20Settings/UncleBob/lib/vendorA.jar!/com/vendora/LibraryClass.class
file:BobsApp/Test.java
(the file name is relative and depend on the current directory) jar:lib/vendorA.jar!/com/vendora/LibraryClass.class
(the first half of the path depends on the current directory, whereas the component after ! is legal) Test.java
(this URI depends on the current directory and does not have a schema) jar:///C:/Documents%20and%20Settings/UncleBob/BobsApp/../lib/vendorA.jar!com/vendora/LibraryClass.class
(the path is not normalized) All implementations of this interface must support Path objects representing files in the default file system. It is recommended that implementations should support Path objects from any filesystem.
Collection<? extends Path>
instead of Iterable<? extends Path>
. This is to prevent the possibility of accidentally calling the method with a single Path
as such an argument, because although Path
implements Iterable<Path>
, it would almost never be correct to call these methods with a single Path
and have it be treated as an Iterable
of its components.Modifier and Type | Interface | Description |
---|---|---|
static interface |
StandardJavaFileManager.PathFactory |
Factory to create Path objects from strings. |
JavaFileManager.Location
Modifier and Type | Method | Description |
---|---|---|
default Path |
asPath |
Returns the path, if any, underlying this file object (optional operation). |
Iterable |
getJavaFileObjects |
Returns file objects representing the given files. |
Iterable |
getJavaFileObjects |
Returns file objects representing the given file names. |
default Iterable |
getJavaFileObjects |
Returns file objects representing the given paths. |
Iterable |
getJavaFileObjectsFromFiles |
Returns file objects representing the given files. |
default Iterable |
getJavaFileObjectsFromPaths |
Deprecated. |
default Iterable |
getJavaFileObjectsFromPaths |
Returns file objects representing the given paths. |
Iterable |
getJavaFileObjectsFromStrings |
Returns file objects representing the given file names. |
Iterable |
getLocation |
Returns the search path associated with the given location. |
default Iterable |
getLocationAsPaths |
Returns the search path associated with the given location. |
boolean |
isSameFile |
Compares two file objects and return true if they represent the same canonical file, zip file entry, or entry in any file system based container. |
void |
setLocation |
Associates the given search path with the given location. |
default void |
setLocationForModule |
Associates the given search path with the given module and location, which must be a module-oriented or output location. |
default void |
setLocationFromPaths |
Associates the given search path with the given location. |
default void |
setPathFactory |
Specify a factory that can be used to generate a path from a string, or series of strings. |
close, contains, flush, getClassLoader, getFileForInput, getFileForOutput, getFileForOutputForOriginatingFiles, getJavaFileForInput, getJavaFileForOutput, getJavaFileForOutputForOriginatingFiles, getLocationForModule, getLocationForModule, getServiceLoader, handleOption, hasLocation, inferBinaryName, inferModuleName, list, listLocationsForModules
isSupportedOption
boolean isSameFile(FileObject a, FileObject b)
isSameFile
in interface JavaFileManager
a
- a file objectb
- a file objectIllegalArgumentException
- if either of the arguments were created with another file manager implementationIterable<? extends JavaFileObject> getJavaFileObjectsFromFiles(Iterable<? extends File> files)
files
- a list of filesIllegalArgumentException
- if the list of files includes a directorydefault Iterable<? extends JavaFileObject> getJavaFileObjectsFromPaths(Collection<? extends Path> paths)
getJavaFileObjectsFromFiles
. IllegalArgumentException
will be thrown if any of the paths cannot be converted to a file at the point the conversion happens.paths
- a list of pathsIllegalArgumentException
- if the list of paths includes a directory or if this file manager does not support any of the given paths@Deprecated(since="13") default Iterable<? extends JavaFileObject> getJavaFileObjectsFromPaths(Iterable<? extends Path> paths)
getJavaFileObjectsFromPaths(Collection)
instead, to prevent the possibility of accidentally calling the method with a single Path
as such an argument. Although Path
implements Iterable<Path>
, it would almost never be correct to pass a single Path
and have it be treated as an Iterable
of its components.getJavaFileObjectsFromPaths
. IllegalArgumentException
will be thrown if any of the paths cannot be converted to a file at the point the conversion happens.paths
- a list of pathsIllegalArgumentException
- if the list of paths includes a directory or if this file manager does not support any of the given paths.Iterable<? extends JavaFileObject> getJavaFileObjects(File... files)
getJavaFileObjectsFromFiles(Arrays.asList
(files))
files
- an array of filesIllegalArgumentException
- if the array of files includes a directory or if this file manager does not support any of the given pathsNullPointerException
- if the given array contains null elementsdefault Iterable<? extends JavaFileObject> getJavaFileObjects(Path... paths)
getJavaFileObjectsFromPaths(Arrays.asList
(paths))
NullPointerException
if getJavaFileObjectsFromPaths(Collection) throws it.paths
- an array of pathsIllegalArgumentException
- if the array of files includes a directory or if this file manager does not support any of the given pathsNullPointerException
- if the given array contains null elementsIterable<? extends JavaFileObject> getJavaFileObjectsFromStrings(Iterable<String> names)
names
- a list of file namesIllegalArgumentException
- if the list of file names includes a directoryIterable<? extends JavaFileObject> getJavaFileObjects(String... names)
getJavaFileObjectsFromStrings(Arrays.asList
(names))
names
- a list of file namesIllegalArgumentException
- if the array of file names includes a directoryNullPointerException
- if the given array contains null elementsvoid setLocation(JavaFileManager.Location location, Iterable<? extends File> files) throws IOException
location
- a locationfiles
- a list of files, if null
use the default search path for this locationIllegalArgumentException
- if location
is an output location and files
does not contain exactly one elementIOException
- if location
is an output location and does not represent an existing directorydefault void setLocationFromPaths(JavaFileManager.Location location, Collection<? extends Path> paths) throws IOException
setLocation
. IllegalArgumentException
will be thrown if any of the paths cannot be converted to a file at the point the conversion happens.location
- a locationpaths
- a list of paths, if null
use the default search path for this locationIllegalArgumentException
- if location
is an output location and paths
does not contain exactly one element or if this file manager does not support any of the given pathsIOException
- if location
is an output location and paths
does not represent an existing directorydefault void setLocationForModule(JavaFileManager.Location location, String moduleName, Collection<? extends Path> paths) throws IOException
UnsupportedOperationException
.location
- the locationmoduleName
- the name of the modulepaths
- the search path to associate with the location and module.IllegalStateException
- if the location is not a module-oriented or output location.UnsupportedOperationException
- if this operation is not supported by this file manager.IOException
- if location
is an output location and paths
does not represent an existing directoryIterable<? extends File> getLocation(JavaFileManager.Location location)
location
- a locationnull
if this location has no associated search pathIllegalStateException
- if any element of the search path cannot be converted to a File, or if the search path cannot be represented as a simple series of files.default Iterable<? extends Path> getLocationAsPaths(JavaFileManager.Location location)
getLocation
and then returns an Iterable
formed by calling toPath()
on each File
returned from getLocation
.location
- a locationnull
if this location has no associated search pathIllegalStateException
- if the search path cannot be represented as a simple series of paths.default Path asPath(FileObject file)
FileSystem
, including the default file system, typically have a corresponding underlying Path
object. In such cases, this method may be used to access that object.UnsupportedOperationException
for all files.file
- a file objectIllegalArgumentException
- if the file object does not have an underlying pathUnsupportedOperationException
- if the operation is not supported by this file managerdefault void setPathFactory(StandardJavaFileManager.PathFactory f)
getPath
method is equivalent to calling java.nio.file.Paths.get(first, more)
will be used.f
- the factory
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.compiler/javax/tools/StandardJavaFileManager.html
getJavaFileObjectsFromPaths(Collection)
instead, to prevent the possibility of accidentally calling the method with a singlePath
as such an argument.