模块 java.compiler

软件包 javax.tools

Interface DocumentationTool

All Superinterfaces:

OptionChecker ， Tool

public interface DocumentationTool
extends Tool, OptionChecker

用于从程序中调用Javaâ“¢编程语言文档工具的接口。

从以下版本开始：

1.8

嵌套类汇总

嵌套类

变量和类型	接口	描述
static interface	DocumentationTool.DocumentationTask	代表文档任务未来的接口。
static class	DocumentationTool.Location	特定于DocumentationTool的位置。

方法摘要

变量和类型	方法	描述
StandardJavaFileManager	getStandardFileManager(DiagnosticListener<? super JavaFileObject> diagnosticListener, Locale locale, Charset charset)	返回此工具的标准文件管理器实现的新实例。
DocumentationTool.DocumentationTask	getTask(Writer out, JavaFileManager fileManager, DiagnosticListener<? super JavaFileObject> diagnosticListener, 类<?> docletClass, Iterable<String> options, Iterable<? extends JavaFileObject> compilationUnits)	使用给定的组件和参数为文档任务创建未来。

声明方法的接口 javax.tools.OptionChecker

isSupportedOption

声明方法的接口 javax.tools.Tool

getSourceVersions, name, run

方法详细信息

getTask

DocumentationTool.DocumentationTask getTask(Writer out,
                                            JavaFileManager fileManager,
                                            DiagnosticListener<? super JavaFileObject> diagnosticListener,
                                            类<?> docletClass,
                                            Iterable<String> options,
                                            Iterable<? extends JavaFileObject> compilationUnits)

使用给定的组件和参数为文档任务创建未来。 任务可能尚未完成，如DocumentationTask界面中所述。

如果提供了文件管理器，它必须能够处理中定义的所有位置DocumentationTool.Location ，以及StandardLocation.SOURCE_PATH ， StandardLocation.CLASS_PATH和StandardLocation.PLATFORM_CLASS_PATH 。

参数

out - 该工具的附加输出的Writer; 使用System.err如果null

fileManager - 文件管理器; 如果null使用该工具的标准文件管理器

diagnosticListener - 诊断监听器; 如果null使用该工具的默认方法报告诊断

docletClass - 提供doclet所需的必要方法的类; 值null表示使用标准doclet。

options - 文档工具选项和doclet选项， null表示没有选项

compilationUnits - 要编译的编译单元， null表示没有编译单元

结果

表示编译的对象

异常

RuntimeException - 如果用户提供的组件中发生不可恢复的错误。 cause将是用户代码中的错误。

IllegalArgumentException - 如果任何给定的编译单元是 source以外的其他类型

getStandardFileManager

StandardJavaFileManager getStandardFileManager(DiagnosticListener<? super JavaFileObject> diagnosticListener,
                                               Locale locale,
                                               Charset charset)

返回此工具的标准文件管理器实现的新实例。 文件管理器将使用给定的诊断侦听器来生成任何非致命的诊断程序。 将通过适当的例外发出致命错误信号。

如果在调用flush或close后访问标准文件管理器，则会自动重新打开它。 标准文件管理器必须可与其他工具一起使用。

参数

diagnosticListener - 非致命诊断的诊断监听器; 如果null使用编译器的默认方法报告诊断

locale - 格式化诊断时要应用的语言环境; null表示default locale 。

charset - 用于解码字节的字符集; 如果null使用平台默认值

结果

标准文件管理器