Package com.sun.tools.javac.nio

Class JavacPathFileManager

java.lang.Object

com.sun.tools.javac.util.BaseFileManager

com.sun.tools.javac.nio.JavacPathFileManager

All Implemented Interfaces:

PathFileManager, Closeable, Flushable, AutoCloseable, JavaFileManager, OptionChecker

public class JavacPathFileManager
extends BaseFileManager
implements PathFileManager

Implementation of PathFileManager: a JavaFileManager based on the use of java.nio.file.Path.

Just as a Path is somewhat analagous to a File, so too is this JavacPathFileManager analogous to JavacFileManager, as it relates to the support of FileObjects based on File objects (i.e. just RegularFileObject, not ZipFileObject and its variants.)

The default values for the standard locations supported by this file manager are the same as the default values provided by JavacFileManager -- i.e. as determined by the javac.file.Paths class. To override these values, call setLocation(javax.tools.JavaFileManager.Location, java.lang.Iterable<? extends java.nio.file.Path>).

To reduce confusion with Path objects, the locations such as "class path", "source path", etc, are generically referred to here as "search paths".

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 class com.sun.tools.javac.util.BaseFileManager

BaseFileManager.ContentCacheEntry

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

JavaFileManager.Location

Field Summary

Fields

Modifier and Type	Field and Description
protected FileSystem	defaultFileSystem

Fields inherited from class com.sun.tools.javac.util.BaseFileManager

charset, classLoaderClass, contentCache, locations, log, options

Constructor Summary

Constructors

Constructor and Description
JavacPathFileManager(Context context, boolean register, Charset charset) Create a JavacPathFileManager using a given context, optionally registering it as the JavaFileManager for that context.

Method Summary

Modifier and Type	Method and Description
void	close()
void	flush()
ClassLoader	getClassLoader(JavaFileManager.Location location)
FileSystem	getDefaultFileSystem() Get the default file system used to create paths.
FileObject	getFileForInput(JavaFileManager.Location location, String packageName, String relativeName)
FileObject	getFileForOutput(JavaFileManager.Location location, String packageName, String relativeName, FileObject sibling)
JavaFileObject	getJavaFileForInput(JavaFileManager.Location location, String className, JavaFileObject.Kind kind)
JavaFileObject	getJavaFileForOutput(JavaFileManager.Location location, String className, JavaFileObject.Kind kind, FileObject sibling)
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.
boolean	hasLocation(JavaFileManager.Location location)
String	inferBinaryName(JavaFileManager.Location location, JavaFileObject fo)
boolean	isDefaultBootClassPath()
boolean	isSameFile(FileObject a, FileObject b)
Iterable<JavaFileObject>	list(JavaFileManager.Location location, String packageName, Set<JavaFileObject.Kind> kinds, boolean recurse)
void	setContext(Context context) Set the context for JavacPathFileManager.
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 class com.sun.tools.javac.util.BaseFileManager

cache, createLocations, decode, flushCache, getCachedContent, getClassLoader, getDecoder, getEncodingName, getKind, getSource, handleOption, isSupportedOption, makeByteBuffer, nullCheck, nullCheck, recycleByteBuffer

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.tools.JavaFileManager

contains, getLocationForModule, getLocationForModule, getServiceLoader, handleOption, inferModuleName, listLocationsForModules

Methods inherited from interface javax.tools.OptionChecker

isSupportedOption

Field Detail

defaultFileSystem

protected FileSystem defaultFileSystem

Constructor Detail

JavacPathFileManager

public JavacPathFileManager(Context context,
                            boolean register,
                            Charset charset)

Create a JavacPathFileManager using a given context, optionally registering it as the JavaFileManager for that context.

Method Detail

setContext

public void setContext(Context context)

Set the context for JavacPathFileManager.

Overrides:

setContext in class BaseFileManager

getDefaultFileSystem

public FileSystem getDefaultFileSystem()

Description copied from interface: PathFileManager

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

Specified by:

getDefaultFileSystem in interface PathFileManager

setDefaultFileSystem

public void setDefaultFileSystem(FileSystem fs)

Description copied from interface: PathFileManager

Set the default file system used to create paths.

Specified by:

setDefaultFileSystem in interface PathFileManager

Parameters:

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

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Specified by:

flush in interface JavaFileManager

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface JavaFileManager

Throws:

IOException

getClassLoader

public ClassLoader getClassLoader(JavaFileManager.Location location)

Specified by:

getClassLoader in interface JavaFileManager

isDefaultBootClassPath

public boolean isDefaultBootClassPath()

Specified by:

isDefaultBootClassPath in class BaseFileManager

hasLocation

public boolean hasLocation(JavaFileManager.Location location)

Specified by:

hasLocation in interface JavaFileManager

getLocation

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

Description copied from interface: PathFileManager

Get the search path associated with the given location.

Specified by:

getLocation in interface PathFileManager

Parameters:

location - a location

Returns:

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

See Also:

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

setLocation

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

Description copied from interface: PathFileManager

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

Specified by:

setLocation in interface PathFileManager

Parameters:

location - a location

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

Throws:

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

See Also:

PathFileManager.getLocation(javax.tools.JavaFileManager.Location)

getPath

public Path getPath(FileObject fo)

Description copied from interface: PathFileManager

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

Specified by:

getPath in interface PathFileManager

Parameters:

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

Returns:

The underlying Path object.

isSameFile

public boolean isSameFile(FileObject a,
                          FileObject b)

Specified by:

isSameFile in interface JavaFileManager

list

public Iterable<JavaFileObject> list(JavaFileManager.Location location,
                                     String packageName,
                                     Set<JavaFileObject.Kind> kinds,
                                     boolean recurse)
                              throws IOException

Specified by:

list in interface JavaFileManager

Throws:

IOException

getJavaFileObjectsFromPaths

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

Description copied from interface: PathFileManager

Get file objects representing the given files.

Specified by:

getJavaFileObjectsFromPaths in interface PathFileManager

Parameters:

paths - a list of paths

Returns:

a list of file objects

getJavaFileObjects

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

Description copied from interface: PathFileManager

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

     getJavaFileObjectsFromPaths(Arrays.asList(paths))
 

Specified by:

getJavaFileObjects in interface PathFileManager

Parameters:

paths - an array of paths

Returns:

a list of file objects

getJavaFileForInput

public JavaFileObject getJavaFileForInput(JavaFileManager.Location location,
                                          String className,
                                          JavaFileObject.Kind kind)
                                   throws IOException

Specified by:

getJavaFileForInput in interface JavaFileManager

Throws:

IOException

getFileForInput

public FileObject getFileForInput(JavaFileManager.Location location,
                                  String packageName,
                                  String relativeName)
                           throws IOException

Specified by:

getFileForInput in interface JavaFileManager

Throws:

IOException

getJavaFileForOutput

public JavaFileObject getJavaFileForOutput(JavaFileManager.Location location,
                                           String className,
                                           JavaFileObject.Kind kind,
                                           FileObject sibling)
                                    throws IOException

Specified by:

getJavaFileForOutput in interface JavaFileManager

Throws:

IOException

getFileForOutput

public FileObject getFileForOutput(JavaFileManager.Location location,
                                   String packageName,
                                   String relativeName,
                                   FileObject sibling)
                            throws IOException

Specified by:

getFileForOutput in interface JavaFileManager

Throws:

IOException

inferBinaryName

public String inferBinaryName(JavaFileManager.Location location,
                              JavaFileObject fo)

Specified by:

inferBinaryName in interface JavaFileManager