Package com.sun.tools.javac.nio

Interface PathFileManager

All Superinterfaces:

AutoCloseable, Closeable, Flushable, JavaFileManager, OptionChecker

All Known Implementing Classes:

JavacPathFileManager

public interface PathFileManager
extends JavaFileManager

File manager based on Path. Eventually, this should be moved to javax.tools. Also, JavaCompiler might reasonably provide a method getPathFileManager, similar to getStandardFileManager. However, would need to be handled carefully as another forward reference from langtools to jdk.

This is NOT part of any supported API. If you write code that depends on this, you do so at your own risk. This code and its internal interfaces are subject to change or deletion without notice.

Nested Class Summary

Nested classes/interfaces inherited from interface javax.tools.JavaFileManager

JavaFileManager.Location

Method Summary

Modifier and Type	Method and Description
FileSystem	getDefaultFileSystem() Get the default file system used to create paths.
Iterable<? extends JavaFileObject>	getJavaFileObjects(Path... paths) Get file objects representing the given paths.
Iterable<? extends JavaFileObject>	getJavaFileObjectsFromPaths(Iterable<? extends Path> paths) Get file objects representing the given files.
Iterable<? extends Path>	getLocation(JavaFileManager.Location location) Get the search path associated with the given location.
Path	getPath(FileObject fo) Return the Path for a file object that has been obtained from this file manager.
void	setDefaultFileSystem(FileSystem fs) Set the default file system used to create paths.
void	setLocation(JavaFileManager.Location location, Iterable<? extends Path> searchPath) Associate the given search path with the given location.

Methods inherited from interface javax.tools.JavaFileManager

close, contains, flush, getClassLoader, getFileForInput, getFileForOutput, getJavaFileForInput, getJavaFileForOutput, getLocationForModule, getLocationForModule, getServiceLoader, handleOption, hasLocation, inferBinaryName, inferModuleName, isSameFile, list, listLocationsForModules

Methods inherited from interface javax.tools.OptionChecker

isSupportedOption

Method Detail

getDefaultFileSystem

FileSystem getDefaultFileSystem()

Get the default file system used to create paths. If no value has been set, the default file system is FileSystems.getDefault().

setDefaultFileSystem

void setDefaultFileSystem(FileSystem fs)

Set the default file system used to create paths.

Parameters:

fs - the default file system used to create any new paths.

getJavaFileObjectsFromPaths

Iterable<? extends JavaFileObject> getJavaFileObjectsFromPaths(Iterable<? extends Path> paths)

Get file objects representing the given files.

Parameters:

paths - a list of paths

Returns:

a list of file objects

Throws:

IllegalArgumentException - if the list of paths includes a directory

getJavaFileObjects

Iterable<? extends JavaFileObject> getJavaFileObjects(Path... paths)

Get file objects representing the given paths. Convenience method equivalent to:

     getJavaFileObjectsFromPaths(Arrays.asList(paths))
 

Parameters:

paths - an array of paths

Returns:

a list of file objects

Throws:

IllegalArgumentException - if the array of files includes a directory

NullPointerException - if the given array contains null elements

getPath

Path getPath(FileObject fo)

Return the Path for a file object that has been obtained from this file manager.

Parameters:

fo - A file object that has been obtained from this file manager.

Returns:

The underlying Path object.

Throws:

IllegalArgumentException - is the file object was not obtained from from this file manager.

getLocation

Iterable<? extends Path> getLocation(JavaFileManager.Location location)

Get the search path associated with the given location.

Parameters:

location - a location

Returns:

a list of paths or null if this location has no associated search path

See Also:

setLocation(javax.tools.JavaFileManager.Location, java.lang.Iterable<? extends java.nio.file.Path>)

setLocation

void setLocation(JavaFileManager.Location location,
                 Iterable<? extends Path> searchPath)
          throws IOException

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

Parameters:

location - a location

searchPath - a list of files, if null use the default search path for this location

Throws:

IllegalArgumentException - if location is an output location and searchpath does not contain exactly one element

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

See Also:

getLocation(javax.tools.JavaFileManager.Location)