compact3

javax.tools

Class ForwardingJavaFileManager<M extends JavaFileManager>

java.lang.Object

javax.tools.ForwardingJavaFileManager<M>

参数类型

M -文件管理器转发到这个对象的类型

All Implemented Interfaces:

Closeable， Flushable， AutoCloseable， JavaFileManager， OptionChecker

public class ForwardingJavaFileManager<M extends JavaFileManager>
extends Object
implements JavaFileManager

向一个给定的文件管理器转发调用。这个类的子类可能会重写这些方法的一些方法，也可能提供额外的字段和方法。

从以下版本开始：

一点六

Nested Class Summary

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

JavaFileManager.Location

Field Summary

Fields

Modifier and Type	Field and Description
protected M	fileManager 所有方法都委派给的文件管理器。

构造方法摘要

构造方法

Modifier	Constructor and Description
protected	ForwardingJavaFileManager(M fileManager) 创建一个新的实例forwardingjavafilemanager。

方法摘要

Modifier and Type	Method and Description
void	close() 释放由该文件管理器直接或间接打开的任何资源。
void	flush() 刷新任何资源打开这个文件管理器直接或间接输出。
ClassLoader	getClassLoader(JavaFileManager.Location location) 从给定的位置获取加载插件的类加载程序。
FileObject	getFileForInput(JavaFileManager.Location location, String packageName, String relativeName) 获取输入表示指定的 relative name在指定的包在给定位置的 file object。
FileObject	getFileForOutput(JavaFileManager.Location location, String packageName, String relativeName, FileObject sibling) 获取输出表示指定的 relative name在指定的包在给定位置的 file object。
JavaFileObject	getJavaFileForInput(JavaFileManager.Location location, String className, JavaFileObject.Kind kind) 获取输入表示指定类在给定的位置指定的一种 file object。
JavaFileObject	getJavaFileForOutput(JavaFileManager.Location location, String className, JavaFileObject.Kind kind, FileObject sibling) 获取输出表示指定类在给定的位置指定的一种 file object。
boolean	handleOption(String current, Iterator<String> remaining) 处理一个选项。
boolean	hasLocation(JavaFileManager.Location location) 确定是否已知此文件管理器的位置。
String	inferBinaryName(JavaFileManager.Location location, JavaFileObject file) 推导了基于位置的文件对象的二进制名称。
boolean	isSameFile(FileObject a, FileObject b) 比较两个文件对象并返回真，如果它们表示相同的底层对象。
int	isSupportedOption(String option) 确定是否支持给定的选项，如果是这样的话，选择所需的参数数目。
Iterable<JavaFileObject>	list(JavaFileManager.Location location, String packageName, Set<JavaFileObject.Kind> kinds, boolean recurse) 列出在给定位置中匹配给定的标准的所有文件对象。

Methods inherited from class java.lang.Object

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

Field Detail

fileManager

protected final M extends JavaFileManager fileManager

所有方法都委派给的文件管理器。

Constructor Detail

ForwardingJavaFileManager

protected ForwardingJavaFileManager(M fileManager)

创建一个新的实例forwardingjavafilemanager。

参数

fileManager委托这个文件管理器

方法详细信息

getClassLoader

public ClassLoader getClassLoader(JavaFileManager.Location location)

从接口复制的描述： JavaFileManager

从给定的位置获取加载插件的类加载程序。例如，加载注释处理器，编译器将请求 ANNOTATION_PROCESSOR_PATH位置的类加载器。

Specified by:

getClassLoader 接口 JavaFileManager

参数

location -位置

结果

对于给定的位置的类装载器；或 null如果位置不知道加载插件从给定的位置被禁用或

异常

SecurityException -如果一个类装载器不能在当前安全上下文创建

IllegalStateException -如果 JavaFileManager.close()被称为这个文件管理器无法打开

list

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

从接口复制的描述： JavaFileManager

列出在给定位置中匹配给定的标准的所有文件对象。列表文件对象在“分包”如果递归是真实的。

注意：即使给定的位置是这个文件管理器未知，它可能不会返回null。同时，一个未知的位置可能不引发异常。

Specified by:

list 接口 JavaFileManager

参数

location -位置

packageName -包的名称

kinds返回对象的只有这些

recurse -如果真有“分包”

结果

文件对象匹配给定一个标准

异常

IOException如果发生I/O错误，或者如果 JavaFileManager.close()被称为这个文件管理器无法打开

IllegalStateException -如果 JavaFileManager.close()被称为这个文件管理器无法打开

inferBinaryName

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

从接口复制的描述： JavaFileManager

推导了基于位置的文件对象的二进制名称。二进制名称返回的可能不是一个有效的二进制名称根据 The Java™ Language Specification。

Specified by:

inferBinaryName 接口 JavaFileManager

参数

location -位置

file -一个文件对象

结果

一个二进制文件的名称或 null对象不在给定的位置找到

异常

IllegalStateException -如果 JavaFileManager.close()被称为这个文件管理器无法打开

isSameFile

public boolean isSameFile(FileObject a,
                          FileObject b)

从接口复制的描述： JavaFileManager

比较两个文件对象并返回真，如果它们表示相同的底层对象。

Specified by:

isSameFile 接口 JavaFileManager

参数

a -一个文件对象

b -一个文件对象

结果

如果给定的文件对象表示相同的基础对象，则为

异常

IllegalArgumentException -如果任何观点都是与另一个文件管理器和文件管理器创建的不支持外国的文件对象

handleOption

public boolean handleOption(String current,
                            Iterator<String> remaining)

从接口复制的描述： JavaFileManager

处理一个选项。如果 current是选择这个文件管理器会消耗任何论点从 remaining选项，返回true，否则返回false。

Specified by:

handleOption 接口 JavaFileManager

参数

current电流选择

remaining -其余选项

结果

如果此选项由此文件管理器处理，则为假，否则为

异常

IllegalArgumentException -如果这个选项这个文件管理器使用不当

IllegalStateException -如果 JavaFileManager.close()被称为这个文件管理器无法打开

hasLocation

public boolean hasLocation(JavaFileManager.Location location)

从接口复制的描述： JavaFileManager

确定是否已知此文件管理器的位置。

Specified by:

hasLocation 接口 JavaFileManager

参数

location -位置

结果

如果位置是已知的

isSupportedOption

public int isSupportedOption(String option)

从接口复制的描述： OptionChecker

确定是否支持给定的选项，如果是这样的话，选择所需的参数数目。

Specified by:

isSupportedOption 接口 OptionChecker

参数

option -一个选项

结果

给定的选项需要或- 1的参数的数量，如果不支持选项

getJavaFileForInput

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

从接口复制的描述： JavaFileManager

获取输入表示指定类在给定的位置指定的一种 file object。

Specified by:

getJavaFileForInput 接口 JavaFileManager

参数

location -位置

className -类的名称

kind -文件类型，必须是一个 SOURCE或 CLASS

结果

一个文件对象，可能会返回 null如果文件不存在

异常

IllegalArgumentException如果位置不知道这个文件管理器和文件管理器不支持未知地点，或者是无效的

IllegalStateException -如果 JavaFileManager.close()被称为这个文件管理器无法打开

IOException如果发生I/O错误，或者如果 JavaFileManager.close()被称为这个文件管理器无法打开

getJavaFileForOutput

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

从接口复制的描述： JavaFileManager

获取输出表示指定类在给定的位置指定的一种 file object。

可选地，这个文件管理器可能会考虑该兄弟姐妹作为一个提示，用于在哪里放置输出。这个提示的确切语义是未指定的。JDK的编译器javac，例如，将类文件在同一目录，源文件，除非提供一个类文件输出目录。为了促进这一行为，javac可能提供源文件作为兄弟时调用此方法。

Specified by:

getJavaFileForOutput 接口 JavaFileManager

参数

location -位置

className -类的名称

kind -文件类型，必须是一个 SOURCE或 CLASS

sibling -一个文件作为提示可能 null安置；

结果

输出的文件对象

异常

IllegalArgumentException如果兄弟不知道这个文件管理器，或者如果位置是不知道这个文件管理器和文件管理器不支持未知地点，或者是无效的

IllegalStateException - JavaFileManager.close()被称为这个文件管理器无法打开

IOException如果发生I/O错误，或者如果 JavaFileManager.close()被称为这个文件管理器无法打开

getFileForInput

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

从接口复制的描述： JavaFileManager

获取输入表示指定的 relative name在指定的包在给定位置的 file object。

如果返回的对象是一个source或class文件，它必须是JavaFileObject实例。

非正式的文件，此方法返回的对象是位于的位置，包名称的连接，和相对的名字。例如，查找文件的属性“资源/编译器。属性”包中的“COM。太阳。工具。javac”在SOURCE_PATH位置，这种方法可以称为像这样：

getfileforinput（source_path，“COM。太阳。工具。javac”、“资源/编译器。属性”）；

如果调用执行的Windows，与source_path设置"C:\Documents and Settings\UncleBob\src\share\classes"，有效的将是代表文件"C:\Documents and Settings\UncleBob\src\share\classes\com\sun\tools\javac\resources\compiler.properties"文件对象。

Specified by:

getFileForInput 接口 JavaFileManager

参数

location -位置

packageName -包的名称

relativeName -相关名称

结果

一个文件对象，可能会返回 null如果文件不存在

异常

IllegalArgumentException如果位置不知道这个文件管理器和文件管理器不支持未知地点，或者如果 relativeName无效

IllegalStateException -如果 JavaFileManager.close()被称为这个文件管理器无法打开

IOException如果发生I/O错误，或者如果 JavaFileManager.close()被称为这个文件管理器无法打开

getFileForOutput

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

从接口复制的描述： JavaFileManager

获取输出表示指定的 relative name在指定的包在给定位置的 file object。

可选地，这个文件管理器可能会考虑该兄弟姐妹作为一个提示，用于在哪里放置输出。这个提示的确切语义是未指定的。JDK的编译器javac，例如，将类文件在同一目录，源文件，除非提供一个类文件输出目录。为了促进这一行为，javac可能提供源文件作为兄弟时调用此方法。

如果返回的对象是一个source或class文件，它必须是JavaFileObject实例。

非正式的文件，此方法返回的对象是位于的位置，包名称的连接，和相关的名称或旁边的兄弟的说法。看到一个例子getFileForInput。

Specified by:

getFileForOutput 接口 JavaFileManager

参数

location -位置

packageName -包的名称

relativeName -相关名称

sibling -一个文件作为提示可能 null安置；

结果

一个文件对象

异常

IllegalArgumentException如果兄弟不知道这个文件管理器，或者如果位置是不知道这个文件管理器和文件管理器不支持未知地点，或者如果 relativeName无效

IllegalStateException -如果 JavaFileManager.close()被称为这个文件管理器无法打开

IOException如果发生I/O错误，或者如果 JavaFileManager.close()被称为这个文件管理器无法打开

flush

public void flush()
           throws IOException

从接口复制的描述： JavaFileManager

刷新任何资源打开这个文件管理器直接或间接输出。Flushing一个封闭的文件管理器没有效果。

Specified by:

flush 接口 Flushable

Specified by:

flush 接口 JavaFileManager

异常

IOException如果发生I/O错误

另请参见：

JavaFileManager.close()

close

public void close()
           throws IOException

从接口复制的描述： JavaFileManager

释放由该文件管理器直接或间接打开的任何资源。这可能会使这个文件管理器无效，并且随后调用此对象的方法或通过此对象获得的任何对象的影响是不确定的，除非明确允许。然而，关闭已关闭的文件管理器没有任何效果。

Specified by:

close 接口 Closeable

Specified by:

close 接口 AutoCloseable

Specified by:

close 接口 JavaFileManager

异常

IOException如果发生I/O错误

另请参见：

JavaFileManager.flush()