compact3

javax.tools

Interface DocumentationTool

All Superinterfaces:

OptionChecker， Tool

public interface DocumentationTool
extends Tool, OptionChecker

接口来调用java编程语言文档工具程序™。

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	DocumentationTool.DocumentationTask 表示文档任务的未来的接口。
static class	DocumentationTool.Location 具体到 DocumentationTool位置。

方法摘要

Modifier and Type	Method and Description
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) 用给定的组件和参数为文档任务创建一个未来。

Methods inherited from interface javax.tools.Tool

getSourceVersions, run

Methods inherited from interface javax.tools.OptionChecker

isSupportedOption

方法详细信息

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 -从工具附加输出的作家；如果使用 System.err null

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

diagnosticListener -诊断的倾听者；如果 null使用工具的默认方法报告诊断

docletClass -提供一个文件所需的必要方法的类

options文件工具选项和文件选项， 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使用平台的默认

结果

标准文件管理器