javax.tools
interface StandardJavaFileManager

All Superinterfaces:

JavaFileManager, OptionChecker

public interface StandardJavaFileManager
extends 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);
 

• 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).

• 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)

getJavaFileObjects

public Iterable getJavaFileObjects(File[] files)

Gets file objects representing the given files. Convenience method equivalent to:

     getJavaFileObjectsFromFiles({@linkplain java.util.Arrays#asList Arrays.asList}(files))
 

Parameters:

files - an array of files

Returns:

a list of file objects

getJavaFileObjects

public Iterable getJavaFileObjects(String[] names)

Gets file objects representing the given file names. Convenience method equivalent to:

     getJavaFileObjectsFromStrings({@linkplain java.util.Arrays#asList Arrays.asList}(names))
 

Parameters:

names - a list of file names

Returns:

a list of file objects

getJavaFileObjectsFromFiles

public Iterable getJavaFileObjectsFromFiles(Iterable files)

Gets file objects representing the given files.

Parameters:

files - a list of files

Returns:

a list of file objects

getJavaFileObjectsFromStrings

public Iterable getJavaFileObjectsFromStrings(Iterable names)

Gets file objects representing the given file names.

Parameters:

names - a list of file names

Returns:

a list of file objects

getLocation

public Iterable getLocation(JavaFileManager.Location location)

Gets the path associated with the given location.

Parameters:

location - a location

Returns:

a list of files or {@code null} if this location has no associated path

isSameFile

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.

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

setLocation

public void setLocation(JavaFileManager.Location location,
                        Iterable path)
                 throws IOException

Associates the given path with the given location. Any previous value will be discarded.

Parameters:

location - a location

path - a list of files, if {@code null} use the default path for this location

Throws:

IOException - if location is an output location and path does not represent an existing directory