Package com.sun.tools.javac.file

Class JavacFileManager

java.lang.Object

com.sun.tools.javac.util.BaseFileManager

com.sun.tools.javac.file.JavacFileManager

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable, JavaFileManager, OptionChecker, StandardJavaFileManager

public class JavacFileManager
extends BaseFileManager
implements StandardJavaFileManager

This class provides access to the source, class and other files used by the compiler and related tools.

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

Modifier and Type	Class and Description
static interface	JavacFileManager.Archive An archive provides a flat directory structure of a ZipFile by mapping directory names to lists of files (basenames).
class	JavacFileManager.MissingArchive
protected static class	JavacFileManager.SortFiles

Nested classes/interfaces inherited from class com.sun.tools.javac.util.BaseFileManager

BaseFileManager.ContentCacheEntry

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

StandardJavaFileManager.PathFactory

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

JavaFileManager.Location

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	mmappedIO
protected JavacFileManager.SortFiles	sortFiles
protected boolean	symbolFileEnabled

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

charset, classLoaderClass, contentCache, locations, log, options

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	close() Close the JavaFileManager, releasing resources.
void	flush() Flush any output resources.
ClassLoader	getClassLoader(JavaFileManager.Location location)
FileObject	getFileForInput(JavaFileManager.Location location, String packageName, String relativeName)
JavaFileObject	getFileForInput(String name)
FileObject	getFileForOutput(JavaFileManager.Location location, String packageName, String relativeName, FileObject sibling)
JavaFileObject	getFileForOutput(String classname, JavaFileObject.Kind kind, JavaFileObject 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(File... files)
Iterable<? extends JavaFileObject>	getJavaFileObjects(String... names)
Iterable<? extends JavaFileObject>	getJavaFileObjectsFromFiles(Iterable<? extends File> files)
Iterable<? extends JavaFileObject>	getJavaFileObjectsFromStrings(Iterable<String> names)
Iterable<? extends File>	getLocation(JavaFileManager.Location location)
static String	getMessage(IOException e) Get a detail message from an IOException.
JavaFileObject	getRegularFile(File file)
static String	getRelativeName(File file) Converts a relative file name to a relative URI.
boolean	hasLocation(JavaFileManager.Location location)
String	inferBinaryName(JavaFileManager.Location location, JavaFileObject file)
boolean	isDefaultBootClassPath()
protected static boolean	isRelativeUri(String u)
protected static boolean	isRelativeUri(URI uri) Enforces the specification of a "relative" name as used in getFileForInput.
boolean	isSameFile(FileObject a, FileObject b)
Iterable<JavaFileObject>	list(JavaFileManager.Location location, String packageName, Set<JavaFileObject.Kind> kinds, boolean recurse)
protected JavacFileManager.Archive	openArchive(File zipFilename)
static void	preRegister(Context context) Register a Context.Factory to create a JavacFileManager.
void	setContext(Context context) Set the context for JavacFileManager.
void	setLocation(JavaFileManager.Location location, Iterable<? extends File> path)
void	setSymbolFileEnabled(boolean b) Set whether or not to use ct.sym as an alternate to rt.jar.
static void	testName(String name, boolean isValidPackageName, boolean isValidClassName)
static char[]	toArray(CharBuffer buffer)

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.StandardJavaFileManager

asPath, getJavaFileObjects, getJavaFileObjectsFromPaths, getLocationAsPaths, setLocationForModule, setLocationFromPaths, setPathFactory

Methods inherited from interface javax.tools.JavaFileManager

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

Methods inherited from interface javax.tools.OptionChecker

isSupportedOption

Field Detail

mmappedIO

protected boolean mmappedIO

symbolFileEnabled

protected boolean symbolFileEnabled

sortFiles

protected JavacFileManager.SortFiles sortFiles

Constructor Detail

JavacFileManager

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

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

Method Detail

toArray

public static char[] toArray(CharBuffer buffer)

preRegister

public static void preRegister(Context context)

Register a Context.Factory to create a JavacFileManager.

setContext

public void setContext(Context context)

Set the context for JavacFileManager.

Overrides:

setContext in class BaseFileManager

setSymbolFileEnabled

public void setSymbolFileEnabled(boolean b)

Set whether or not to use ct.sym as an alternate to rt.jar.

isDefaultBootClassPath

public boolean isDefaultBootClassPath()

Specified by:

isDefaultBootClassPath in class BaseFileManager

getFileForInput

public JavaFileObject getFileForInput(String name)

getRegularFile

public JavaFileObject getRegularFile(File file)

getFileForOutput

public JavaFileObject getFileForOutput(String classname,
                                       JavaFileObject.Kind kind,
                                       JavaFileObject sibling)
                                throws IOException

Throws:

IOException

getJavaFileObjectsFromStrings

public Iterable<? extends JavaFileObject> getJavaFileObjectsFromStrings(Iterable<String> names)

Specified by:

getJavaFileObjectsFromStrings in interface StandardJavaFileManager

getJavaFileObjects

public Iterable<? extends JavaFileObject> getJavaFileObjects(String... names)

Specified by:

getJavaFileObjects in interface StandardJavaFileManager

testName

public static void testName(String name,
                            boolean isValidPackageName,
                            boolean isValidClassName)

openArchive

protected JavacFileManager.Archive openArchive(File zipFilename)
                                        throws IOException

Throws:

IOException

flush

public void flush()

Flush any output resources.

Specified by:

flush in interface Flushable

Specified by:

flush in interface JavaFileManager

close

public void close()

Close the JavaFileManager, releasing resources.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface JavaFileManager

getClassLoader

public ClassLoader getClassLoader(JavaFileManager.Location location)

Specified by:

getClassLoader 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

inferBinaryName

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

Specified by:

inferBinaryName in interface JavaFileManager

isSameFile

public boolean isSameFile(FileObject a,
                          FileObject b)

Specified by:

isSameFile in interface JavaFileManager

Specified by:

isSameFile in interface StandardJavaFileManager

hasLocation

public boolean hasLocation(JavaFileManager.Location location)

Specified by:

hasLocation in interface JavaFileManager

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

getJavaFileObjectsFromFiles

public Iterable<? extends JavaFileObject> getJavaFileObjectsFromFiles(Iterable<? extends File> files)

Specified by:

getJavaFileObjectsFromFiles in interface StandardJavaFileManager

getJavaFileObjects

public Iterable<? extends JavaFileObject> getJavaFileObjects(File... files)

Specified by:

getJavaFileObjects in interface StandardJavaFileManager

setLocation

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

Specified by:

setLocation in interface StandardJavaFileManager

Throws:

IOException

getLocation

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

Specified by:

getLocation in interface StandardJavaFileManager

isRelativeUri

protected static boolean isRelativeUri(URI uri)

Enforces the specification of a "relative" name as used in getFileForInput. This method must follow the rules defined in that method, do not make any changes without consulting the specification.

isRelativeUri

protected static boolean isRelativeUri(String u)

getRelativeName

public static String getRelativeName(File file)

Converts a relative file name to a relative URI. This is different from File.toURI as this method does not canonicalize the file before creating the URI. Furthermore, no schema is used.

Parameters:

file - a relative file name

Returns:

a relative URI

Throws:

IllegalArgumentException - if the file name is not relative according to the definition given in JavaFileManager.getFileForInput(javax.tools.JavaFileManager.Location, java.lang.String, java.lang.String)

getMessage

public static String getMessage(IOException e)

Get a detail message from an IOException. Most, but not all, instances of IOException provide a non-null result for getLocalizedMessage(). But some instances return null: in these cases, fallover to getMessage(), and if even that is null, return the name of the exception itself.

Parameters:

e - an IOException

Returns:

a string to include in a compiler diagnostic