java.lang.Objectjavax.tools.ForwardingJavaFileManager<M>
M
- the kind of file manager forwarded to by this objectpublic class ForwardingJavaFileManager<M extends JavaFileManager>
Forwards calls to a given file manager. Subclasses of this class might override some of these methods and might also provide additional fields and methods.
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface javax.tools.JavaFileManager |
---|
JavaFileManager.Location |
Field Summary | |
---|---|
protected M |
fileManager
The file manager which all methods are delegated to. |
Constructor Summary | |
---|---|
protected |
ForwardingJavaFileManager(M fileManager)
Creates a new instance of ForwardingJavaFileManager. |
Method Summary | |
---|---|
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. |
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. |
boolean |
handleOption(String current,
Iterator<String> remaining)
Handles one option. |
boolean |
hasLocation(JavaFileManager.Location location)
Determines if a location is known to this file manager. |
String |
inferBinaryName(JavaFileManager.Location location,
JavaFileObject file)
Infers a binary name of a file object based on a location. |
boolean |
isSameFile(FileObject a,
FileObject b)
Compares two file objects and return true if they represent the same underlying object. |
int |
isSupportedOption(String option)
Determines if the given option is supported and if so, the number of arguments the option takes. |
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. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected final M extends JavaFileManager fileManager
Constructor Detail |
---|
protected ForwardingJavaFileManager(M fileManager)
fileManager
- delegate to this file managerMethod Detail |
---|
public ClassLoader getClassLoader(JavaFileManager.Location location)
JavaFileManager
ANNOTATION_PROCESSOR_PATH
location.
getClassLoader
in interface JavaFileManager
location
- a location
null
if loading plug-ins from the given location is disabled or if
the location is not known
SecurityException
- if a class loader can not be created
in the current security context
IllegalStateException
- if JavaFileManager.close()
has been called
and this file manager cannot be reopenedpublic Iterable<JavaFileObject> list(JavaFileManager.Location location, String packageName, Set<JavaFileObject.Kind> kinds, boolean recurse) throws IOException
JavaFileManager
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.
list
in interface JavaFileManager
location
- a locationpackageName
- a package namekinds
- return objects only of these kindsrecurse
- if true include "subpackages"
IOException
- if an I/O error occurred, or if JavaFileManager.close()
has been called and this file manager cannot be
reopened
IllegalStateException
- if JavaFileManager.close()
has been called
and this file manager cannot be reopenedpublic String inferBinaryName(JavaFileManager.Location location, JavaFileObject file)
JavaFileManager
inferBinaryName
in interface JavaFileManager
location
- a locationfile
- a file object
null
the file object is not
found in the given location
IllegalStateException
- if JavaFileManager.close()
has been called
and this file manager cannot be reopenedpublic boolean isSameFile(FileObject a, FileObject b)
JavaFileManager
isSameFile
in interface JavaFileManager
a
- a file objectb
- a file object
IllegalArgumentException
- if either of the arguments
were created with another file manager and this file manager
does not support foreign file objectspublic boolean handleOption(String current, Iterator<String> remaining)
JavaFileManager
current
is an option to this
file manager it will consume any arguments to that option from
remaining
and return true, otherwise return false.
handleOption
in interface JavaFileManager
current
- current optionremaining
- remaining options
IllegalArgumentException
- if this option to this file
manager is used incorrectly
IllegalStateException
- if JavaFileManager.close()
has been called
and this file manager cannot be reopenedpublic boolean hasLocation(JavaFileManager.Location location)
JavaFileManager
hasLocation
in interface JavaFileManager
location
- a location
public int isSupportedOption(String option)
OptionChecker
isSupportedOption
in interface OptionChecker
option
- an option
public JavaFileObject getJavaFileForInput(JavaFileManager.Location location, String className, JavaFileObject.Kind kind) throws IOException
JavaFileManager
getJavaFileForInput
in interface JavaFileManager
location
- a locationclassName
- the name of a classkind
- the kind of file, must be one of SOURCE
or CLASS
null
if the
file does not exist
IllegalArgumentException
- if the location is not known
to this file manager and the file manager does not support
unknown locations, or if the kind is not valid
IllegalStateException
- if JavaFileManager.close()
has been called
and this file manager cannot be reopened
IOException
- if an I/O error occurred, or if JavaFileManager.close()
has been called and this file manager cannot be
reopenedpublic JavaFileObject getJavaFileForOutput(JavaFileManager.Location location, String className, JavaFileObject.Kind kind, FileObject sibling) throws IOException
JavaFileManager
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 Sun Java 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.
getJavaFileForOutput
in interface JavaFileManager
location
- a locationclassName
- the name of a classkind
- 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
IllegalArgumentException
- if sibling is not known to
this file manager, or if the location is not known to this file
manager and the file manager does not support unknown
locations, or if the kind is not valid
IllegalStateException
- JavaFileManager.close()
has been called
and this file manager cannot be reopened
IOException
- if an I/O error occurred, or if JavaFileManager.close()
has been called and this file manager cannot be
reopenedpublic FileObject getFileForInput(JavaFileManager.Location location, String packageName, String relativeName) throws IOException
JavaFileManager
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"
.
getFileForInput
in interface JavaFileManager
location
- a locationpackageName
- a package namerelativeName
- a relative name
null
if the file
does not exist
IllegalArgumentException
- if the location is not known
to this file manager and the file manager does not support
unknown locations, or if relativeName
is not valid
IllegalStateException
- if JavaFileManager.close()
has been called
and this file manager cannot be reopened
IOException
- if an I/O error occurred, or if JavaFileManager.close()
has been called and this file manager cannot be
reopenedpublic FileObject getFileForOutput(JavaFileManager.Location location, String packageName, String relativeName, FileObject sibling) throws IOException
JavaFileManager
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 Sun Java 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.
getFileForOutput
in interface JavaFileManager
location
- a locationpackageName
- a package namerelativeName
- a relative namesibling
- a file object to be used as hint for placement;
might be null
IllegalArgumentException
- if sibling is not known to
this file manager, or if the location is not known to this file
manager and the file manager does not support unknown
locations, or if relativeName
is not valid
IllegalStateException
- if JavaFileManager.close()
has been called
and this file manager cannot be reopened
IOException
- if an I/O error occurred, or if JavaFileManager.close()
has been called and this file manager cannot be
reopenedpublic void flush() throws IOException
JavaFileManager
flush
in interface Flushable
flush
in interface JavaFileManager
IOException
- if an I/O error occurredJavaFileManager.close()
public void close() throws IOException
JavaFileManager
close
in interface Closeable
close
in interface JavaFileManager
IOException
- if an I/O error occurredJavaFileManager.flush()