Module java.compiler

软件包 javax.tools

Interface DocumentationTool

All Superinterfaces:

OptionChecker ， Tool

public interface DocumentationTool
extends Tool, OptionChecker

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

从以下版本开始：

1.8

Nested Class Summary

Nested Classes

Modifier and Type	接口	描述
static interface	DocumentationTool.DocumentationTask	表示文档任务的未来的接口。
static class	DocumentationTool.Location	特定于DocumentationTool的地点。

方法摘要

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

Methods inherited from interface javax.tools.OptionChecker

isSupportedOption

Methods inherited from interface javax.tools.Tool

getSourceVersions, name, run

方法详细信息

getTask

DocumentationTool.DocumentationTask getTask(Writer out,
                                            JavaFileManager fileManager,
                                            DiagnosticListener<? super JavaFileObject> diagnosticListener,
                                            Class<?> 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使用平台默认

结果

标准文件管理器