Java™ Platform
Standard Ed. 6

javax.tools
Interface StandardJavaFileManager

All Superinterfaces:
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 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: According to these rules, the following URIs, for example, are allowed: Whereas these are not (reason in parentheses):

Since:
1.6

Nested Class Summary
 
Nested classes/interfaces inherited from interface javax.tools.JavaFileManager
JavaFileManager.Location
 
Method Summary
 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
close, flush, getClassLoader, getFileForInput, getFileForOutput, getJavaFileForInput, getJavaFileForOutput, handleOption, hasLocation, inferBinaryName, list
 
Methods inherited from interface javax.tools.OptionChecker
isSupportedOption
 

Method Detail

isSameFile

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.

Specified by:
isSameFile in interface JavaFileManager
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 - if either of the arguments were created with another file manager implementation

getJavaFileObjectsFromFiles

Iterable<? extends JavaFileObject> getJavaFileObjectsFromFiles(Iterable<? extends File> files)
Gets 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

getJavaFileObjects

Iterable<? extends JavaFileObject> getJavaFileObjects(File... files)
Gets 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

getJavaFileObjectsFromStrings

Iterable<? extends JavaFileObject> getJavaFileObjectsFromStrings(Iterable<String> names)
Gets 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

getJavaFileObjects

Iterable<? extends JavaFileObject> getJavaFileObjects(String... names)
Gets 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

setLocation

void setLocation(JavaFileManager.Location location,
                 Iterable<? extends File> 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 null use the default path for this location
Throws:
IllegalArgumentException - if location is an output location and path does not contain exactly one element
IOException - if location is an output location and path does not represent an existing directory
See Also:
getLocation(javax.tools.JavaFileManager.Location)

getLocation

Iterable<? extends File> getLocation(JavaFileManager.Location 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)

Java™ Platform
Standard Ed. 6

Submit a bug or feature
For further API reference and developer documentation, see Java SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Copyright © 1993, 2011, Oracle and/or its affiliates. All rights reserved.

Scripting on this page tracks web page traffic, but does not change the content in any way.