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() Releases any resources opened by this file manager directly or indirectly.
void	flush() Flushes any resources opened for output by this file manager directly or indirectly.
ClassLoader	getClassLoader(JavaFileManager.Location location) Gets a class loader for loading plug-ins from the given location.
FileSystem	getDefaultFileSystem() Get the default file system used to create paths.
FileObject	getFileForInput(JavaFileManager.Location location, String packageName, String relativeName) Gets a file object for input representing the specified relative name in the specified package in the given location.
FileObject	getFileForOutput(JavaFileManager.Location location, String packageName, String relativeName, FileObject sibling) Gets a file object for output representing the specified relative name in the specified package in the given location.
JavaFileObject	getJavaFileForInput(JavaFileManager.Location location, String className, JavaFileObject.Kind kind) Gets a file object for input representing the specified class of the specified kind in the given location.
JavaFileObject	getJavaFileForOutput(JavaFileManager.Location location, String className, JavaFileObject.Kind kind, FileObject sibling) Gets a file object for output representing the specified class of the specified kind in the given location.
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) Determines if a location is known to this file manager.
String	inferBinaryName(JavaFileManager.Location location, JavaFileObject fo) Infers a binary name of a file object based on a location.
boolean	isDefaultBootClassPath()
boolean	isSameFile(FileObject a, FileObject b) Compares two file objects and return true if they represent the same underlying object.
Iterable<JavaFileObject>	list(JavaFileManager.Location location, String packageName, Set<JavaFileObject.Kind> kinds, boolean recurse) Lists all file objects matching the given criteria in the given location.
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

handleOption

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

Description copied from interface: JavaFileManager

Flushes any resources opened for output by this file manager directly or indirectly. Flushing a closed file manager has no effect.

Specified by:

flush in interface Flushable

Specified by:

flush in interface JavaFileManager

Throws:

IOException - if an I/O error occurred

See Also:

JavaFileManager.close()

close

public void close()
           throws IOException

Description copied from interface: JavaFileManager

Releases any resources opened by this file manager directly or indirectly. This might render this file manager useless and the effect of subsequent calls to methods on this object or any objects obtained through this object is undefined unless explicitly allowed. However, closing a file manager which has already been closed has no effect.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface JavaFileManager

Throws:

IOException - if an I/O error occurred

See Also:

JavaFileManager.flush()

getClassLoader

public ClassLoader getClassLoader(JavaFileManager.Location location)

Description copied from interface: JavaFileManager

Gets a class loader for loading plug-ins from the given location. For example, to load annotation processors, a compiler will request a class loader for the ANNOTATION_PROCESSOR_PATH location.

Specified by:

getClassLoader in interface JavaFileManager

Parameters:

location - a location

Returns:

a class loader for the given location; or null if loading plug-ins from the given location is disabled or if the location is not known

isDefaultBootClassPath

public boolean isDefaultBootClassPath()

Specified by:

isDefaultBootClassPath in class BaseFileManager

hasLocation

public boolean hasLocation(JavaFileManager.Location location)

Description copied from interface: JavaFileManager

Determines if a location is known to this file manager.

Specified by:

hasLocation in interface JavaFileManager

Parameters:

location - a location

Returns:

true if the location is known

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)

Description copied from interface: JavaFileManager

Compares two file objects and return true if they represent the same underlying object.

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 underlying object

list

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

Description copied from interface: JavaFileManager

Lists all file objects matching the given criteria in the given location. List file objects in "subpackages" if recurse is true.

Note: even if the given location is unknown to this file manager, it may not return null. Also, an unknown location may not cause an exception.

Specified by:

list in interface JavaFileManager

Parameters:

location - a location

packageName - a package name

kinds - return objects only of these kinds

recurse - if true include "subpackages"

Returns:

an Iterable of file objects matching the given criteria

Throws:

IOException - if an I/O error occurred, or if JavaFileManager.close() has been called and this file manager cannot be reopened

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

Description copied from interface: JavaFileManager

Gets a file object for input representing the specified class of the specified kind in the given location.

Specified by:

getJavaFileForInput in interface JavaFileManager

Parameters:

location - a location

className - the name of a class

kind - the kind of file, must be one of SOURCE or CLASS

Returns:

a file object, might return null if the file does not exist

Throws:

IOException - if an I/O error occurred, or if JavaFileManager.close() has been called and this file manager cannot be reopened

getFileForInput

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

Description copied from interface: JavaFileManager

Gets a file object for input representing the specified relative name in the specified package in the given location.

If the returned object represents a source or class file, it must be an instance of JavaFileObject.

Informally, the file object returned by this method is located in the concatenation of the location, package name, and relative name. For example, to locate the properties file "resources/compiler.properties" in the package "com.sun.tools.javac" in the SOURCE_PATH location, this method might be called like so:

getFileForInput(SOURCE_PATH, "com.sun.tools.javac", "resources/compiler.properties");

If the call was executed on Windows, with SOURCE_PATH set to "C:\Documents and Settings\UncleBob\src\share\classes", a valid result would be a file object representing the file "C:\Documents and Settings\UncleBob\src\share\classes\com\sun\tools\javac\resources\compiler.properties".

Specified by:

getFileForInput in interface JavaFileManager

Parameters:

location - a location

packageName - a package name

relativeName - a relative name

Returns:

a file object, might return null if the file does not exist

Throws:

IOException - if an I/O error occurred, or if JavaFileManager.close() has been called and this file manager cannot be reopened

getJavaFileForOutput

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

Description copied from interface: JavaFileManager

Gets a file object for output representing the specified class of the specified kind in the given location.

Optionally, this file manager might consider the sibling as a hint for where to place the output. The exact semantics of this hint is unspecified. The JDK compiler, javac, for example, will place class files in the same directories as originating source files unless a class file output directory is provided. To facilitate this behavior, javac might provide the originating source file as sibling when calling this method.

Specified by:

getJavaFileForOutput in interface JavaFileManager

Parameters:

location - a location

className - the name of a class

kind - the kind of file, must be one of SOURCE or CLASS

sibling - a file object to be used as hint for placement; might be null

Returns:

a file object for output

Throws:

IOException - if an I/O error occurred, or if JavaFileManager.close() has been called and this file manager cannot be reopened

getFileForOutput

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

Description copied from interface: JavaFileManager

Gets a file object for output representing the specified relative name in the specified package in the given location.

Optionally, this file manager might consider the sibling as a hint for where to place the output. The exact semantics of this hint is unspecified. The JDK compiler, javac, for example, will place class files in the same directories as originating source files unless a class file output directory is provided. To facilitate this behavior, javac might provide the originating source file as sibling when calling this method.

If the returned object represents a source or class file, it must be an instance of JavaFileObject.

Informally, the file object returned by this method is located in the concatenation of the location, package name, and relative name or next to the sibling argument. See getFileForInput for an example.

Specified by:

getFileForOutput in interface JavaFileManager

Parameters:

location - a location

packageName - a package name

relativeName - a relative name

sibling - a file object to be used as hint for placement; might be null

Returns:

a file object

Throws:

IOException - if an I/O error occurred, or if JavaFileManager.close() has been called and this file manager cannot be reopened

inferBinaryName

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

Description copied from interface: JavaFileManager

Infers a binary name of a file object based on a location. The binary name returned might not be a valid binary name according to The Java™ Language Specification.

Specified by:

inferBinaryName in interface JavaFileManager

Parameters:

location - a location

fo - a file object

Returns:

a binary name or null the file object is not found in the given location