polyglot.filemanager

Class ExtFileManager

java.lang.Object

javax.tools.ForwardingJavaFileManager<javax.tools.StandardJavaFileManager>

polyglot.filemanager.ExtFileManager

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable, javax.tools.JavaFileManager, javax.tools.OptionChecker, javax.tools.StandardJavaFileManager, FileManager, SourceLoader, ClassFileLoader

public class ExtFileManager
extends javax.tools.ForwardingJavaFileManager<javax.tools.StandardJavaFileManager>
implements FileManager

FileManager implementation - A class that provides input and output access to the local file system. (NOTE: Extensions may extend this implementation and are not forced to use local file system for i/o.)

Nested Class Summary

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

javax.tools.JavaFileManager.Location

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.util.Set<javax.tools.JavaFileObject.Kind>	ALL_KINDS
protected static int	BUF_SIZE
protected int	caseInsensitive Indicates if the file system is case-insensitive.
protected boolean	caseInsensitivityComputed Indicates if the file system case-sensitivity is set
protected static java.util.List<javax.tools.JavaFileManager.Location>	default_locations
protected ExtensionInfo	extInfo
protected boolean	inMemory Indicates whether to keep output files in memory.
protected static javax.tools.JavaCompiler	javaCompiler
protected java.util.Map<java.lang.String,FileSource>	loadedSources Map of sources already loaded
protected static java.util.Set<java.lang.String>	nocache A cache for the class files that don't exist
protected static java.lang.Object	not_found
protected java.util.Map<javax.tools.JavaFileManager.Location,java.util.Map<java.lang.String,javax.tools.JavaFileObject>>	objectMap Map for storing in-memory FileObjects and associated fully qualified names
protected static java.util.Map<java.lang.String,java.lang.Boolean>	packageCache A cache for package look ups
protected static java.util.Collection<java.lang.String>	report_topics
protected static java.util.Collection<java.lang.String>	verbose
protected static java.util.Map<java.io.File,java.lang.Object>	zipCache

Fields inherited from class javax.tools.ForwardingJavaFileManager

fileManager

Constructor Summary

Constructors

Constructor and Description
ExtFileManager(ExtensionInfo extInfo)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	caseInsensitive()
protected FileSource	checkForSource(javax.tools.JavaFileManager.Location location, java.lang.String className) Load the source file for the given class name using the source path.
FileSource	classSource(javax.tools.JavaFileManager.Location location, java.lang.String className)
FileSource	classSource(java.lang.String className)
protected void	clearCache()
protected java.lang.String	fileKey(javax.tools.JavaFileManager.Location location, java.lang.String packageName, java.lang.String fileName)
protected java.lang.String	fileKey(java.lang.String packageName, java.lang.String relativeName)
FileSource	fileSource(javax.tools.JavaFileManager.Location location, java.lang.String fileName) Obtains a FileSource for a dependency.
FileSource	fileSource(javax.tools.JavaFileManager.Location location, java.lang.String fileName, boolean userSpecified) Deprecated.
FileSource	fileSource(javax.tools.JavaFileManager.Location location, java.lang.String fileName, Source.Kind kind)
FileSource	fileSource(java.lang.String fileName) Obtains a FileSource for a dependency.
FileSource	fileSource(java.lang.String fileName, boolean userSpecified) Deprecated.
FileSource	fileSource(java.lang.String fileName, Source.Kind kind)
static byte[]	getBytes(javax.tools.FileObject fo) Convenience method for extracting bytes from a FileObject
javax.tools.FileObject	getFileForInput(javax.tools.JavaFileManager.Location location, java.lang.String packageName, java.lang.String relativeName)
javax.tools.FileObject	getFileForOutput(javax.tools.JavaFileManager.Location location, java.lang.String packageName, java.lang.String relativeName, javax.tools.FileObject sibling)
javax.tools.JavaFileObject	getJavaFileForInput(javax.tools.JavaFileManager.Location location, java.lang.String className, javax.tools.JavaFileObject.Kind kind)
javax.tools.JavaFileObject	getJavaFileForOutput(javax.tools.JavaFileManager.Location location, java.lang.String className, javax.tools.JavaFileObject.Kind kind, javax.tools.FileObject sibling)
java.lang.Iterable<? extends javax.tools.JavaFileObject>	getJavaFileObjects(java.io.File... files)
java.lang.Iterable<? extends javax.tools.JavaFileObject>	getJavaFileObjects(java.lang.String... names)
java.lang.Iterable<? extends javax.tools.JavaFileObject>	getJavaFileObjectsFromFiles(java.lang.Iterable<? extends java.io.File> files)
java.lang.Iterable<? extends javax.tools.JavaFileObject>	getJavaFileObjectsFromStrings(java.lang.Iterable<java.lang.String> names)
java.lang.Iterable<? extends java.io.File>	getLocation(javax.tools.JavaFileManager.Location location)
boolean	hasLocation(javax.tools.JavaFileManager.Location location)
java.lang.String	inferBinaryName(javax.tools.JavaFileManager.Location location, javax.tools.JavaFileObject file)
boolean	isSameFile(javax.tools.FileObject a, javax.tools.FileObject b)
protected javax.tools.JavaFileObject.Kind	kindFromExtension(java.lang.String name)
java.lang.Iterable<javax.tools.JavaFileObject>	list(javax.tools.JavaFileManager.Location location, java.lang.String packageName, java.util.Set<javax.tools.JavaFileObject.Kind> kinds, boolean recurse)
ClassFile	loadFile(javax.tools.JavaFileManager.Location location, java.lang.String name)
ClassFile	loadFile(java.lang.String name)
protected static java.util.zip.ZipFile	loadZip(java.io.File dir)
boolean	packageExists(javax.tools.JavaFileManager.Location location, java.lang.String name)
boolean	packageExists(java.lang.String name)
void	setLocation(javax.tools.JavaFileManager.Location location, java.lang.Iterable<? extends java.io.File> path)

Methods inherited from class javax.tools.ForwardingJavaFileManager

close, flush, getClassLoader, handleOption, isSupportedOption

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

close, flush, getClassLoader, handleOption

Methods inherited from interface javax.tools.OptionChecker

isSupportedOption

Field Detail

javaCompiler

protected static final javax.tools.JavaCompiler javaCompiler

extInfo

protected final ExtensionInfo extInfo

loadedSources

protected final java.util.Map<java.lang.String,FileSource> loadedSources

Map of sources already loaded

packageCache

protected static final java.util.Map<java.lang.String,java.lang.Boolean> packageCache

A cache for package look ups

nocache

protected static final java.util.Set<java.lang.String> nocache

A cache for the class files that don't exist

zipCache

protected static final java.util.Map<java.io.File,java.lang.Object> zipCache

not_found

protected static final java.lang.Object not_found

BUF_SIZE

protected static final int BUF_SIZE

See Also:

Constant Field Values

report_topics

protected static final java.util.Collection<java.lang.String> report_topics

ALL_KINDS

protected static final java.util.Set<javax.tools.JavaFileObject.Kind> ALL_KINDS

objectMap

protected final java.util.Map<javax.tools.JavaFileManager.Location,java.util.Map<java.lang.String,javax.tools.JavaFileObject>> objectMap

Map for storing in-memory FileObjects and associated fully qualified names

caseInsensitive

protected int caseInsensitive

Indicates if the file system is case-insensitive.

caseInsensitivityComputed

protected boolean caseInsensitivityComputed

Indicates if the file system case-sensitivity is set

inMemory

protected final boolean inMemory

Indicates whether to keep output files in memory.

default_locations

protected static java.util.List<javax.tools.JavaFileManager.Location> default_locations

verbose

protected static java.util.Collection<java.lang.String> verbose

Constructor Detail

ExtFileManager

public ExtFileManager(ExtensionInfo extInfo)

Method Detail

clearCache

protected void clearCache()

getFileForInput

public javax.tools.FileObject getFileForInput(javax.tools.JavaFileManager.Location location,
                                     java.lang.String packageName,
                                     java.lang.String relativeName)
                                       throws java.io.IOException

Specified by:

getFileForInput in interface javax.tools.JavaFileManager

Overrides:

getFileForInput in class javax.tools.ForwardingJavaFileManager<javax.tools.StandardJavaFileManager>

Throws:

java.io.IOException

getJavaFileForInput

public javax.tools.JavaFileObject getJavaFileForInput(javax.tools.JavaFileManager.Location location,
                                             java.lang.String className,
                                             javax.tools.JavaFileObject.Kind kind)
                                               throws java.io.IOException

Specified by:

getJavaFileForInput in interface javax.tools.JavaFileManager

Overrides:

getJavaFileForInput in class javax.tools.ForwardingJavaFileManager<javax.tools.StandardJavaFileManager>

Throws:

java.io.IOException

kindFromExtension

protected javax.tools.JavaFileObject.Kind kindFromExtension(java.lang.String name)

getFileForOutput

public javax.tools.FileObject getFileForOutput(javax.tools.JavaFileManager.Location location,
                                      java.lang.String packageName,
                                      java.lang.String relativeName,
                                      javax.tools.FileObject sibling)
                                        throws java.io.IOException

Specified by:

getFileForOutput in interface javax.tools.JavaFileManager

Overrides:

getFileForOutput in class javax.tools.ForwardingJavaFileManager<javax.tools.StandardJavaFileManager>

Throws:

java.io.IOException

fileKey

protected java.lang.String fileKey(java.lang.String packageName,
                       java.lang.String relativeName)

getJavaFileForOutput

public javax.tools.JavaFileObject getJavaFileForOutput(javax.tools.JavaFileManager.Location location,
                                              java.lang.String className,
                                              javax.tools.JavaFileObject.Kind kind,
                                              javax.tools.FileObject sibling)
                                                throws java.io.IOException

Specified by:

getJavaFileForOutput in interface javax.tools.JavaFileManager

Overrides:

getJavaFileForOutput in class javax.tools.ForwardingJavaFileManager<javax.tools.StandardJavaFileManager>

Throws:

java.io.IOException

hasLocation

public boolean hasLocation(javax.tools.JavaFileManager.Location location)

Specified by:

hasLocation in interface javax.tools.JavaFileManager

Overrides:

hasLocation in class javax.tools.ForwardingJavaFileManager<javax.tools.StandardJavaFileManager>

inferBinaryName

public java.lang.String inferBinaryName(javax.tools.JavaFileManager.Location location,
                               javax.tools.JavaFileObject file)

Specified by:

inferBinaryName in interface javax.tools.JavaFileManager

Overrides:

inferBinaryName in class javax.tools.ForwardingJavaFileManager<javax.tools.StandardJavaFileManager>

list

public java.lang.Iterable<javax.tools.JavaFileObject> list(javax.tools.JavaFileManager.Location location,
                                                  java.lang.String packageName,
                                                  java.util.Set<javax.tools.JavaFileObject.Kind> kinds,
                                                  boolean recurse)
                                                    throws java.io.IOException

Specified by:

list in interface javax.tools.JavaFileManager

Overrides:

list in class javax.tools.ForwardingJavaFileManager<javax.tools.StandardJavaFileManager>

Throws:

java.io.IOException

getJavaFileObjects

public java.lang.Iterable<? extends javax.tools.JavaFileObject> getJavaFileObjects(java.io.File... files)

Specified by:

getJavaFileObjects in interface javax.tools.StandardJavaFileManager

getJavaFileObjects

public java.lang.Iterable<? extends javax.tools.JavaFileObject> getJavaFileObjects(java.lang.String... names)

Specified by:

getJavaFileObjects in interface javax.tools.StandardJavaFileManager

getJavaFileObjectsFromFiles

public java.lang.Iterable<? extends javax.tools.JavaFileObject> getJavaFileObjectsFromFiles(java.lang.Iterable<? extends java.io.File> files)

Specified by:

getJavaFileObjectsFromFiles in interface javax.tools.StandardJavaFileManager

getJavaFileObjectsFromStrings

public java.lang.Iterable<? extends javax.tools.JavaFileObject> getJavaFileObjectsFromStrings(java.lang.Iterable<java.lang.String> names)

Specified by:

getJavaFileObjectsFromStrings in interface javax.tools.StandardJavaFileManager

getLocation

public java.lang.Iterable<? extends java.io.File> getLocation(javax.tools.JavaFileManager.Location location)

Specified by:

getLocation in interface javax.tools.StandardJavaFileManager

isSameFile

public boolean isSameFile(javax.tools.FileObject a,
                 javax.tools.FileObject b)

Specified by:

isSameFile in interface javax.tools.JavaFileManager

Specified by:

isSameFile in interface javax.tools.StandardJavaFileManager

Overrides:

isSameFile in class javax.tools.ForwardingJavaFileManager<javax.tools.StandardJavaFileManager>

setLocation

public void setLocation(javax.tools.JavaFileManager.Location location,
               java.lang.Iterable<? extends java.io.File> path)
                 throws java.io.IOException

Specified by:

setLocation in interface javax.tools.StandardJavaFileManager

Throws:

java.io.IOException

packageExists

public boolean packageExists(java.lang.String name)

Specified by:

packageExists in interface SourceLoader

Specified by:

packageExists in interface ClassFileLoader

Parameters:

name - A package name

Returns:

true if a package name exists, otherwise false

loadZip

protected static java.util.zip.ZipFile loadZip(java.io.File dir)
                                        throws java.io.IOException

Throws:

java.io.IOException

packageExists

public boolean packageExists(javax.tools.JavaFileManager.Location location,
                    java.lang.String name)

Specified by:

packageExists in interface SourceLoader

Specified by:

packageExists in interface ClassFileLoader

Parameters:

location - A location to search a package name in

name - A package name

Returns:

true if a package name exists, otherwise false

loadFile

public ClassFile loadFile(java.lang.String name)

Specified by:

loadFile in interface ClassFileLoader

Parameters:

name - A class name

Returns:

A ClassFile if name.class file exists, otherwise null

loadFile

public ClassFile loadFile(javax.tools.JavaFileManager.Location location,
                 java.lang.String name)

Specified by:

loadFile in interface ClassFileLoader

Parameters:

location - A location to load a ClassFile from

name - A class name

Returns:

A ClassFile if name.class file exists in the location, otherwise null

fileSource

public FileSource fileSource(java.lang.String fileName)
                      throws java.io.IOException

Description copied from interface: SourceLoader

Obtains a FileSource for a dependency.

Specified by:

fileSource in interface SourceLoader

Parameters:

fileName - A source file name

Returns:

A FileSource if a source file fileName exists in source path

Throws:

java.io.IOException

fileSource

@Deprecated
public FileSource fileSource(java.lang.String fileName,
                               boolean userSpecified)
                      throws java.io.IOException

Deprecated.

Specified by:

fileSource in interface SourceLoader

Parameters:

fileName - A source file name

userSpecified - If the user has specified this source file explicitly

Returns:

A FileSource if a source file fileName exists in source path

Throws:

java.io.IOException

fileSource

public FileSource fileSource(java.lang.String fileName,
                    Source.Kind kind)
                      throws java.io.IOException

Specified by:

fileSource in interface SourceLoader

Parameters:

fileName - A source file name

kind - How the source was found

Returns:

A FileSource if a source file fileName exists in source path

Throws:

java.io.IOException

fileSource

public FileSource fileSource(javax.tools.JavaFileManager.Location location,
                    java.lang.String fileName)
                      throws java.io.IOException

Description copied from interface: SourceLoader

Obtains a FileSource for a dependency.

Specified by:

fileSource in interface SourceLoader

Parameters:

location - A location to search a source file in

fileName - A source file name

Returns:

A FileSource if a source file fileName exists

Throws:

java.io.IOException

fileSource

@Deprecated
public FileSource fileSource(javax.tools.JavaFileManager.Location location,
                               java.lang.String fileName,
                               boolean userSpecified)
                      throws java.io.IOException

Deprecated.

Specified by:

fileSource in interface SourceLoader

Parameters:

location - A location to search a source file in

fileName - A source file name

userSpecified - If the user has specified this source file explicitly

Returns:

A FileSource if a source file fileName exists

Throws:

java.io.IOException

fileSource

public FileSource fileSource(javax.tools.JavaFileManager.Location location,
                    java.lang.String fileName,
                    Source.Kind kind)
                      throws java.io.IOException

Specified by:

fileSource in interface SourceLoader

Parameters:

location - A location to search a source file in

kind - How the source was found

Returns:

A FileSource if a source file fileName exists

Throws:

java.io.IOException

classSource

public FileSource classSource(java.lang.String className)

Specified by:

classSource in interface SourceLoader

Parameters:

className - A class name

Returns:

A FileSource containing definition of the class className if it exists in source path, otherwise null

classSource

public FileSource classSource(javax.tools.JavaFileManager.Location location,
                     java.lang.String className)

Specified by:

classSource in interface SourceLoader

Parameters:

location - A location to search a file in, that contains definition of the class className

className - A class name

Returns:

A FileSource containing definition of the class className if it exists in location, otherwise null

checkForSource

protected FileSource checkForSource(javax.tools.JavaFileManager.Location location,
                        java.lang.String className)

Load the source file for the given class name using the source path.

fileKey

protected java.lang.String fileKey(javax.tools.JavaFileManager.Location location,
                       java.lang.String packageName,
                       java.lang.String fileName)

caseInsensitive

public boolean caseInsensitive()

Specified by:

caseInsensitive in interface SourceLoader

Returns:

true if the file system is case-insensitive, otherwise false.

getBytes

public static byte[] getBytes(javax.tools.FileObject fo)
                       throws java.io.IOException

Convenience method for extracting bytes from a FileObject

Throws:

java.io.IOException