javax.tools: public interface: StandardJavaFileManager

javax.tools
public interface: StandardJavaFileManager [javadoc | source]

All Implemented Interfaces:
JavaFileManager

File manager based on {@linkplain File java.io.File}. A common way to obtain an instance of this class is using {@linkplain JavaCompiler#getStandardFileManager getStandardFileManager}, for example:

  JavaCompiler compiler = ToolProvider.getSystemJavaCompiler();
  {@code DiagnosticCollector} diagnostics =
      new {@code DiagnosticCollector()};
  StandardJavaFileManager fm = compiler.getStandardFileManager(diagnostics, null, null);

This file manager creates file objects representing regular {@linkplain File files}, {@linkplain java.util.zip.ZipEntry 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 {@linkplain FileObject#delete()} is equivalent to {@linkplain File#delete()},
- the method {@linkplain FileObject#getLastModified()} is equivalent to {@linkplain File#lastModified()},
- the methods {@linkplain FileObject#getCharContent(boolean)}, {@linkplain FileObject#openInputStream()}, and {@linkplain FileObject#openReader(boolean)} must succeed if the following would succeed (ignoring encoding issues):
```
new {@linkplain java.io.FileInputStream#FileInputStream(File) FileInputStream}(new {@linkplain File#File(java.net.URI) File}({@linkplain FileObject fileObject}.{@linkplain FileObject#toUri() toUri}()))
```
- and the methods {@linkplain FileObject#openOutputStream()}, and {@linkplain FileObject#openWriter()} must succeed if the following would succeed (ignoring encoding issues):
```
new {@linkplain java.io.FileOutputStream#FileOutputStream(File) FileOutputStream}(new {@linkplain File#File(java.net.URI) File}({@linkplain FileObject fileObject}.{@linkplain FileObject#toUri() toUri}()))
```
The {@linkplain java.net.URI URI} returned from {@linkplain FileObject#toUri()}
- must be {@linkplain java.net.URI#isAbsolute() absolute} (have a schema), and
- must have a {@linkplain java.net.URI#normalize() normalized} {@linkplain java.net.URI#getPath() 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)

author: Peter - von der Ahé

since: 1.6 -

Method from javax.tools.StandardJavaFileManager Summary:
getJavaFileObjects, getJavaFileObjects, getJavaFileObjectsFromFiles, getJavaFileObjectsFromStrings, getLocation, isSameFile, setLocation

Method from javax.tools.StandardJavaFileManager Detail:
public Iterable<JavaFileObject> getJavaFileObjects(File files) Gets file objects representing the given files. Convenience method equivalent to: getJavaFileObjectsFromFiles({@linkplain java.util.Arrays#asList Arrays.asList}(files))
public Iterable<JavaFileObject> getJavaFileObjects(String names) Gets file objects representing the given file names. Convenience method equivalent to: getJavaFileObjectsFromStrings({@linkplain java.util.Arrays#asList Arrays.asList}(names))
public Iterable<JavaFileObject> getJavaFileObjectsFromFiles(Iterable<File> files) Gets file objects representing the given files.
public Iterable<JavaFileObject> getJavaFileObjectsFromStrings(Iterable<String> names) Gets file objects representing the given file names.
public Iterable<File> getLocation(Location location) Gets the path associated with the given location.
public 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.
public void setLocation(Location location, Iterable<File> path) throws IOException Associates the given path with the given location. Any previous value will be discarded.