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

转发给给定的文件管理器。 此类的子类可能会覆盖其中某些方法，并可能还提供其他字段和方法。

从以下版本开始：

1.6

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) 获取一个file object用于表示指定的输入relative name中指定的包在给定的位置。
FileObject	getFileForOutput(JavaFileManager.Location location, String packageName, String relativeName, FileObject sibling) 获取一个file object用于表示指定的输出relative name中指定的包在给定的位置。
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) 比较两个文件对象，如果它们代表相同的底层对象，则返回true。
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

字段详细信息

fileManager

protected final M extends JavaFileManager fileManager

所有方法的委托文件管理器。

构造方法详细信息

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复制

列出与给定位置中给定条件匹配的所有文件对象。 如果recurse为真，则在“子包”中列出文件对象。

注意：即使给定的位置对于该文件管理器是未知的，它也可能不会返回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

比较两个文件对象，如果它们代表相同的底层对象，则返回true。

Specified by:

isSameFile在接口 JavaFileManager

参数

a - 文件对象

b - 一个文件对象

结果

如果给定的文件对象代表相同的底层对象，则为true

异常

IllegalArgumentException - 如果任一参数是使用另一个文件管理器创建的，并且该文件管理器不支持外部文件对象

handleOption

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

说明从界面复制： JavaFileManager

处理一个选项 如果current是该文件管理器的选项， remaining从remaining使用该选项的任何参数，并返回true，否则返回false。

Specified by:

handleOption在接口 JavaFileManager

参数

current - 当前选项

remaining - 剩余的选项

结果

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

异常

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复制

获取一个file object用于表示指定的输入relative name中指定的包在给定的位置。

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

非法地，此方法返回的文件对象位于位置，包名称和相对名称的并置中。 例如，要在SOURCE_PATH位置的“com.sun.tools.javac”包中找到属性文件“resources / compiler.properties”，可能会调用此方法：

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

如果调用在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"的文件"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

获取一个file object用于表示指定的输出relative name中指定的包在给定的位置。

可选地，该文件管理器可以将兄弟姐妹视为提示放置输出的位置。 这个提示的确切语义是未指定的。 例如，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

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

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()