StandardJavaFileManager (Java Platform SE 7 ) (original) (raw)

All Superinterfaces:
AutoCloseable, Closeable, Flushable, JavaFileManager, OptionChecker

public interface StandardJavaFileManager
extends JavaFileManager
File manager based on java.io.File. A common way to obtain an instance of this class is using getStandardFileManager, for example:
JavaCompiler compiler = ToolProvider.getSystemJavaCompiler();
DiagnosticCollector<JavaFileObject> diagnostics =
new DiagnosticCollector<JavaFileObject>();
StandardJavaFileManager fm = compiler.getStandardFileManager(diagnostics, null, null);

This file manager creates file objects representing regularfiles,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:

File names need not be canonical.
For file objects representing regular files
* the method [FileObject.delete()](../../javax/tools/FileObject.html#delete%28%29) is equivalent to [File.delete()](../../java/io/File.html#delete%28%29),
* the method [FileObject.getLastModified()](../../javax/tools/FileObject.html#getLastModified%28%29) is equivalent to [File.lastModified()](../../java/io/File.html#lastModified%28%29),
* the methods [FileObject.getCharContent(boolean)](../../javax/tools/FileObject.html#getCharContent%28boolean%29),[FileObject.openInputStream()](../../javax/tools/FileObject.html#openInputStream%28%29), and[FileObject.openReader(boolean)](../../javax/tools/FileObject.html#openReader%28boolean%29) must succeed if the following would succeed (ignoring encoding issues):
> new FileInputStream(new File(fileObject.toUri()))
* and the methods[FileObject.openOutputStream()](../../javax/tools/FileObject.html#openOutputStream%28%29), and[FileObject.openWriter()](../../javax/tools/FileObject.html#openWriter%28%29) must succeed if the following would succeed (ignoring encoding issues):
> new FileOutputStream(new File(fileObject.toUri()))
The URI returned from[FileObject.toUri()](../../javax/tools/FileObject.html#toUri%28%29)
* 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).

According to these rules, the following URIs, for example, are allowed:

file:///C:/Documents%20and%20Settings/UncleBob/BobsApp/Test.java
jar:///C:/Documents%20and%20Settings/UncleBob/lib/vendorA.jar!com/vendora/LibraryClass.class
Whereas these are not (reason in parentheses):
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)
Since:
1.6

Nested Class Summary

 * ### Nested classes/interfaces inherited from interface javax.tools.[JavaFileManager](../../javax/tools/JavaFileManager.html "interface in javax.tools")  
 `[JavaFileManager.Location](../../javax/tools/JavaFileManager.Location.html "interface in javax.tools")`

Method Summary

Methods

Modifier and Type	Method and Description
Iterable<? extends JavaFileObject>	getJavaFileObjects(File... files) Gets file objects representing the given files.
Iterable<? extends JavaFileObject>	getJavaFileObjects(String... names) Gets file objects representing the given file names.
Iterable<? extends JavaFileObject>	getJavaFileObjectsFromFiles(Iterable<? extends File> files) Gets file objects representing the given files.
Iterable<? extends JavaFileObject>	getJavaFileObjectsFromStrings(Iterable<String> names) Gets file objects representing the given file names.
Iterable<? extends File>	getLocation(JavaFileManager.Location location) Gets the path associated with the given location.
boolean	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.
void	setLocation(JavaFileManager.Location location,Iterable<? extends File> path) Associates the given path with the given location.

   * ### Methods inherited from interface javax.tools.[JavaFileManager](../../javax/tools/JavaFileManager.html "interface in javax.tools")  
   `[close](../../javax/tools/JavaFileManager.html#close%28%29), [flush](../../javax/tools/JavaFileManager.html#flush%28%29), [getClassLoader](../../javax/tools/JavaFileManager.html#getClassLoader%28javax.tools.JavaFileManager.Location%29), [getFileForInput](../../javax/tools/JavaFileManager.html#getFileForInput%28javax.tools.JavaFileManager.Location,%20java.lang.String,%20java.lang.String%29), [getFileForOutput](../../javax/tools/JavaFileManager.html#getFileForOutput%28javax.tools.JavaFileManager.Location,%20java.lang.String,%20java.lang.String,%20javax.tools.FileObject%29), [getJavaFileForInput](../../javax/tools/JavaFileManager.html#getJavaFileForInput%28javax.tools.JavaFileManager.Location,%20java.lang.String,%20javax.tools.JavaFileObject.Kind%29), [getJavaFileForOutput](../../javax/tools/JavaFileManager.html#getJavaFileForOutput%28javax.tools.JavaFileManager.Location,%20java.lang.String,%20javax.tools.JavaFileObject.Kind,%20javax.tools.FileObject%29), [handleOption](../../javax/tools/JavaFileManager.html#handleOption%28java.lang.String,%20java.util.Iterator%29), [hasLocation](../../javax/tools/JavaFileManager.html#hasLocation%28javax.tools.JavaFileManager.Location%29), [inferBinaryName](../../javax/tools/JavaFileManager.html#inferBinaryName%28javax.tools.JavaFileManager.Location,%20javax.tools.JavaFileObject%29), [list](../../javax/tools/JavaFileManager.html#list%28javax.tools.JavaFileManager.Location,%20java.lang.String,%20java.util.Set,%20boolean%29)`  
   * ### Methods inherited from interface javax.tools.[OptionChecker](../../javax/tools/OptionChecker.html "interface in javax.tools")  
   `[isSupportedOption](../../javax/tools/OptionChecker.html#isSupportedOption%28java.lang.String%29)`

Method Detail

 * #### 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 canonical file, zip file entry, or entry in any file system based container.  
 **Specified by:**  
 `[isSameFile](../../javax/tools/JavaFileManager.html#isSameFile%28javax.tools.FileObject,%20javax.tools.FileObject%29)` in interface `[JavaFileManager](../../javax/tools/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 canonical file or zip file entry; false otherwise  
 Throws:  
 `[IllegalArgumentException](../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if either of the arguments were created with another file manager implementation  
 * #### getJavaFileObjectsFromFiles  
 [Iterable](../../java/lang/Iterable.html "interface in java.lang")<? extends [JavaFileObject](../../javax/tools/JavaFileObject.html "interface in javax.tools")> getJavaFileObjectsFromFiles([Iterable](../../java/lang/Iterable.html "interface in java.lang")<? extends [File](../../java/io/File.html "class in java.io")> files)  
 Gets file objects representing the given files.  
 Parameters:  
 `files` \- a list of files  
 Returns:  
 a list of file objects  
 Throws:  
 `[IllegalArgumentException](../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if the list of files includes a directory  
 * #### getJavaFileObjects  
 [Iterable](../../java/lang/Iterable.html "interface in java.lang")<? extends [JavaFileObject](../../javax/tools/JavaFileObject.html "interface in javax.tools")> getJavaFileObjects([File](../../java/io/File.html "class in java.io")... files)  
 Gets file objects representing the given files. Convenience method equivalent to:  
      getJavaFileObjectsFromFiles([Arrays.asList](../../java/util/Arrays.html#asList%28T...%29)(files))  
        
 Parameters:  
 `files` \- an array of files  
 Returns:  
 a list of file objects  
 Throws:  
 `[IllegalArgumentException](../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if the array of files includes a directory  
 `[NullPointerException](../../java/lang/NullPointerException.html "class in java.lang")` \- if the given array contains null elements  
 * #### getJavaFileObjectsFromStrings  
 [Iterable](../../java/lang/Iterable.html "interface in java.lang")<? extends [JavaFileObject](../../javax/tools/JavaFileObject.html "interface in javax.tools")> getJavaFileObjectsFromStrings([Iterable](../../java/lang/Iterable.html "interface in java.lang")<[String](../../java/lang/String.html "class in java.lang")> names)  
 Gets file objects representing the given file names.  
 Parameters:  
 `names` \- a list of file names  
 Returns:  
 a list of file objects  
 Throws:  
 `[IllegalArgumentException](../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if the list of file names includes a directory  
 * #### getJavaFileObjects  
 [Iterable](../../java/lang/Iterable.html "interface in java.lang")<? extends [JavaFileObject](../../javax/tools/JavaFileObject.html "interface in javax.tools")> getJavaFileObjects([String](../../java/lang/String.html "class in java.lang")... names)  
 Gets file objects representing the given file names. Convenience method equivalent to:  
      getJavaFileObjectsFromStrings([Arrays.asList](../../java/util/Arrays.html#asList%28T...%29)(names))  
        
 Parameters:  
 `names` \- a list of file names  
 Returns:  
 a list of file objects  
 Throws:  
 `[IllegalArgumentException](../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if the array of file names includes a directory  
 `[NullPointerException](../../java/lang/NullPointerException.html "class in java.lang")` \- if the given array contains null elements  
 * #### setLocation  
 void setLocation([JavaFileManager.Location](../../javax/tools/JavaFileManager.Location.html "interface in javax.tools") location,  
                [Iterable](../../java/lang/Iterable.html "interface in java.lang")<? extends [File](../../java/io/File.html "class in java.io")> path)  
                  throws [IOException](../../java/io/IOException.html "class in java.io")  
 Associates the given path with the given location. Any previous value will be discarded.  
 Parameters:  
 `location` \- a location  
 `path` \- a list of files, if `null` use the default path for this location  
 Throws:  
 `[IllegalArgumentException](../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if location is an output location and path does not contain exactly one element  
 `[IOException](../../java/io/IOException.html "class in java.io")` \- if location is an output location and path does not represent an existing directory  
 See Also:  
 [getLocation(javax.tools.JavaFileManager.Location)](../../javax/tools/StandardJavaFileManager.html#getLocation%28javax.tools.JavaFileManager.Location%29)  
 * #### getLocation  
 [Iterable](../../java/lang/Iterable.html "interface in java.lang")<? extends [File](../../java/io/File.html "class in java.io")> getLocation([JavaFileManager.Location](../../javax/tools/JavaFileManager.Location.html "interface in javax.tools") location)  
 Gets the path associated with the given location.  
 Parameters:  
 `location` \- a location  
 Returns:  
 a list of files or `null` if this location has no associated path  
 See Also:  
 [setLocation(javax.tools.JavaFileManager.Location, java.lang.Iterable<? extends java.io.File>)](../../javax/tools/StandardJavaFileManager.html#setLocation%28javax.tools.JavaFileManager.Location,%20java.lang.Iterable%29)

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2020, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.

StandardJavaFileManager (Java Platform SE 7 ) (original) (raw)

Nested Class Summary

Method Summary

Method Detail