- 
- All Superinterfaces:
- AutoCloseable,- Closeable,- Flushable,- JavaFileManager,- OptionChecker
 
 public interface StandardJavaFileManager extends JavaFileManager File manager based on 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);- File names need not be canonical.
- 
     For file objects representing regular files
     - 
         the method FileObject.delete()is equivalent toFile.delete(),
- 
         the method FileObject.getLastModified()is equivalent toFile.lastModified(),
- 
         the methods FileObject.getCharContent(boolean),FileObject.openInputStream(), andFileObject.openReader(boolean)must succeed if the following would succeed (ignoring encoding issues):new FileInputStream(new File(fileObject.toUri())) 
- 
         and the methods
         FileObject.openOutputStream(), andFileObject.openWriter()must succeed if the following would succeed (ignoring encoding issues):new FileOutputStream(new File(fileObject.toUri())) 
 
- 
         the method 
- 
     The URI returned from
     FileObject.toUri()- must be absolute (have a schema), and
- must have a normalized path component which can be resolved without any process-specific context such as the current directory (file names must be absolute).
 
 - 
     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. - API Note:
- Some methods on this interface take a Collection<? extends Path>instead ofIterable<? extends Path>. This is to prevent the possibility of accidentally calling the method with a singlePathas such an argument, because althoughPathimplementsIterable<Path>, it would almost never be correct to call these methods with a singlePathand have it be treated as anIterableof its components.
- Since:
- 1.6
 
- 
- 
Nested Class SummaryNested Classes Modifier and Type Interface Description static interfaceStandardJavaFileManager.PathFactoryFactory to createPathobjects from strings.- 
Nested classes/interfaces declared in interface javax.tools.JavaFileManagerJavaFileManager.Location
 
- 
 - 
Method SummaryAll Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default PathasPath(FileObject file)Returns the path, if any, underlying this file object (optional operation).Iterable<? extends JavaFileObject>getJavaFileObjects(File... files)Returns file objects representing the given files.Iterable<? extends JavaFileObject>getJavaFileObjects(String... names)Returns file objects representing the given file names.default Iterable<? extends JavaFileObject>getJavaFileObjects(Path... paths)Returns file objects representing the given paths.Iterable<? extends JavaFileObject>getJavaFileObjectsFromFiles(Iterable<? extends File> files)Returns file objects representing the given files.default Iterable<? extends JavaFileObject>getJavaFileObjectsFromPaths(Iterable<? extends Path> paths)Returns file objects representing the given paths.Iterable<? extends JavaFileObject>getJavaFileObjectsFromStrings(Iterable<String> names)Returns file objects representing the given file names.Iterable<? extends File>getLocation(JavaFileManager.Location location)Returns the search path associated with the given location.default Iterable<? extends Path>getLocationAsPaths(JavaFileManager.Location location)Returns the search path associated with the given location.booleanisSameFile(FileObject a, FileObject b)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.voidsetLocation(JavaFileManager.Location location, Iterable<? extends File> files)Associates the given search path with the given location.default voidsetLocationForModule(JavaFileManager.Location location, String moduleName, Collection<? extends Path> paths)Associates the given search path with the given module and location, which must be a module-oriented or output location.default voidsetLocationFromPaths(JavaFileManager.Location location, Collection<? extends Path> paths)Associates the given search path with the given location.default voidsetPathFactory(StandardJavaFileManager.PathFactory f)Specify a factory that can be used to generate a path from a string, or series of strings.- 
Methods declared in interface javax.tools.JavaFileManagerclose, contains, flush, getClassLoader, getFileForInput, getFileForOutput, getJavaFileForInput, getJavaFileForOutput, getLocationForModule, getLocationForModule, getServiceLoader, handleOption, hasLocation, inferBinaryName, inferModuleName, list, listLocationsForModules
 - 
Methods declared in interface javax.tools.OptionCheckerisSupportedOption
 
- 
 
- 
- 
- 
Method Detail- 
isSameFileboolean isSameFile(FileObject a, FileObject b) 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.- Specified by:
- isSameFilein interface- JavaFileManager
- Parameters:
- a- a file object
- b- a file object
- Returns:
- true if the given file objects represent the same canonical file, zip file entry or path; false otherwise
- Throws:
- IllegalArgumentException- if either of the arguments were created with another file manager implementation
 
 - 
getJavaFileObjectsFromFilesIterable<? extends JavaFileObject> getJavaFileObjectsFromFiles(Iterable<? extends File> files) Returns file objects representing the given files.- Parameters:
- files- a list of files
- Returns:
- a list of file objects
- Throws:
- IllegalArgumentException- if the list of files includes a directory
 
 - 
getJavaFileObjectsFromPathsdefault Iterable<? extends JavaFileObject> getJavaFileObjectsFromPaths(Iterable<? extends Path> paths) Returns file objects representing the given paths.- Implementation Requirements:
- The default implementation converts each path to a file and calls
 getJavaObjectsFromFiles. IllegalArgumentException will be thrown if any of the paths cannot be converted to a file.
- Parameters:
- paths- a list of paths
- Returns:
- a list of file objects
- Throws:
- IllegalArgumentException- if the list of paths includes a directory or if this file manager does not support any of the given paths.
- Since:
- 9
 
 - 
getJavaFileObjectsIterable<? extends JavaFileObject> getJavaFileObjects(File... files) Returns file objects representing the given files. Convenience method equivalent to:getJavaFileObjectsFromFiles(Arrays.asList(files))- Parameters:
- files- an array of files
- Returns:
- a list of file objects
- Throws:
- IllegalArgumentException- if the array of files includes a directory
- NullPointerException- if the given array contains null elements
 
 - 
getJavaFileObjectsdefault Iterable<? extends JavaFileObject> getJavaFileObjects(Path... paths) Returns file objects representing the given paths. Convenience method equivalent to:getJavaFileObjectsFromPaths(Arrays.asList(paths))- Parameters:
- paths- an array of paths
- Returns:
- a list of file objects
- Throws:
- IllegalArgumentException- if the array of files includes a directory
- NullPointerException- if the given array contains null elements
- Since:
- 9
 
 - 
getJavaFileObjectsFromStringsIterable<? extends JavaFileObject> getJavaFileObjectsFromStrings(Iterable<String> names) Returns file objects representing the given file names.- Parameters:
- names- a list of file names
- Returns:
- a list of file objects
- Throws:
- IllegalArgumentException- if the list of file names includes a directory
 
 - 
getJavaFileObjectsIterable<? extends JavaFileObject> getJavaFileObjects(String... names) Returns file objects representing the given file names. Convenience method equivalent to:getJavaFileObjectsFromStrings(Arrays.asList(names))- Parameters:
- names- a list of file names
- Returns:
- a list of file objects
- Throws:
- IllegalArgumentException- if the array of file names includes a directory
- NullPointerException- if the given array contains null elements
 
 - 
setLocationvoid setLocation(JavaFileManager.Location location, Iterable<? extends File> files) throws IOException Associates the given search path with the given location. Any previous value will be discarded. If the location is a module-oriented or output location, any module-specific associations set up by setLocationForModule will be cancelled.- Parameters:
- location- a location
- files- a list of files, if- nulluse the default search path for this location
- Throws:
- IllegalArgumentException- if- locationis an output location and- filesdoes not contain exactly one element
- IOException- if- locationis an output location and does not represent an existing directory
- See Also:
- getLocation(javax.tools.JavaFileManager.Location)
 
 - 
setLocationFromPathsdefault void setLocationFromPaths(JavaFileManager.Location location, Collection<? extends Path> paths) throws IOException Associates the given search path with the given location. Any previous value will be discarded. If the location is a module-oriented or output location, any module-specific associations set up by setLocationForModule will be cancelled.- Implementation Requirements:
- The default implementation converts each path to a file and calls
 getJavaObjectsFromFiles. IllegalArgumentException will be thrown if any of the paths cannot be converted to a file.
- Parameters:
- location- a location
- paths- a list of paths, if- nulluse the default search path for this location
- Throws:
- IllegalArgumentException- if- locationis an output location and- pathsdoes not contain exactly one element or if this file manager does not support any of the given paths
- IOException- if- locationis an output location and- pathsdoes not represent an existing directory
- Since:
- 9
- See Also:
- getLocation(javax.tools.JavaFileManager.Location)
 
 - 
setLocationForModuledefault void setLocationForModule(JavaFileManager.Location location, String moduleName, Collection<? extends Path> paths) throws IOException Associates the given search path with the given module and location, which must be a module-oriented or output location. Any previous value will be discarded. This overrides any default association derived from the search path associated with the location itself. All such module-specific associations will be cancelled if a new search path is associated with the location by calling setLocation or setLocationFromPaths.- Parameters:
- location- the location
- moduleName- the name of the module
- paths- the search path to associate with the location and module.
- Throws:
- 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- locationis an output location and- pathsdoes not represent an existing directory
- Since:
- 9
- See Also:
- setLocation(javax.tools.JavaFileManager.Location,java.lang.Iterable<? extends java.io.File>),- setLocationFromPaths(javax.tools.JavaFileManager.Location,java.util.Collection<? extends java.nio.file.Path>)
 
 - 
getLocationIterable<? extends File> getLocation(JavaFileManager.Location location) Returns the search path associated with the given location.- Parameters:
- location- a location
- Returns:
- a list of files or nullif this location has no associated search path
- Throws:
- IllegalStateException- 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.
- See Also:
- setLocation(javax.tools.JavaFileManager.Location, java.lang.Iterable<? extends java.io.File>),- Path.toFile()
 
 - 
getLocationAsPathsdefault Iterable<? extends Path> getLocationAsPaths(JavaFileManager.Location location) Returns the search path associated with the given location.- Implementation Requirements:
- The default implementation calls getLocationand then returns anIterableformed by callingtoPath()on eachFilereturned fromgetLocation.
- Parameters:
- location- a location
- Returns:
- a list of paths or nullif this location has no associated search path
- Throws:
- IllegalStateException- if the search path cannot be represented as a simple series of paths.
- Since:
- 9
- See Also:
- setLocationFromPaths(javax.tools.JavaFileManager.Location, java.util.Collection<? extends java.nio.file.Path>)
 
 - 
asPathdefault Path asPath(FileObject file) Returns the path, if any, underlying this file object (optional operation). File objects derived from aFileSystem, including the default file system, typically have a corresponding underlyingPathobject. In such cases, this method may be used to access that object.- Implementation Requirements:
- The default implementation throws UnsupportedOperationExceptionfor all files.
- Parameters:
- file- a file object
- Returns:
- a path representing the same underlying file system artifact
- Throws:
- IllegalArgumentException- if the file object does not have an underlying path
- UnsupportedOperationException- if the operation is not supported by this file manager
- Since:
- 9
 
 - 
setPathFactorydefault void setPathFactory(StandardJavaFileManager.PathFactory f) Specify a factory that can be used to generate a path from a string, or series of strings. If this method is not called, a factory whosegetPathmethod is equivalent to callingjava.nio.file.Paths.get(first, more)will be used.- Implementation Requirements:
- The default implementation of this method ignores the factory that is provided.
- Parameters:
- f- the factory
- Since:
- 9
 
 
- 
 
-