Package Summary  Overview Summary

class:StandardJavaFileManager [NONE]

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

method:isSameFile(javax.tools.FileObject, javax.tools.FileObject) [NONE]

  • 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

method:getJavaFileObjectsFromFiles(java.lang.Iterable) [NONE]

  • 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

method:getJavaFileObjects(java.io.File...) [NONE]

  • 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

method:getJavaFileObjectsFromStrings(java.lang.Iterable) [NONE]

  • 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

method:getJavaFileObjects(java.lang.String...) [NONE]

  • 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

method:setLocation(javax.tools.JavaFileManager.Location, java.lang.Iterable) [NONE]

method:getLocation(javax.tools.JavaFileManager.Location) [NONE]