Module  jdk.javadoc
软件包  jdk.javadoc.doclet

Interface DocletEnvironment


  • public interface DocletEnvironment
    表示单次调用doclet的操作环境。 该对象可用于访问命令行上的程序结构，各种实用程序和用户指定的元素。
    从以下版本开始：
    9

    • 方法详细信息

      • getSpecifiedElements

        Set<? extends Element> getSpecifiedElements​()
        调用工具时返回元素 specified 。
        结果
        指定元素的集合

      • getIncludedElements

        Set<? extends Element> getIncludedElements​()
        返回文档中应为 included的模块，包和类型元素。
        结果
        包含的元素集

      • getDocTrees

        DocTrees getDocTrees​()
        返回一个DocTrees实用程序类的实例。 这个类提供了访问TreePath s， DocCommentTree等的方法。
        结果
        一个在doc树上操作的实用程序类

      • getElementUtils

        Elements getElementUtils​()
        返回一个Elements实用程序类的实例。 该类提供了在elements上操作的方法。
        结果
        一个用于操作元素的实用程序类

      • getTypeUtils

        Types getTypeUtils​()
        返回一个Types实用程序类的实例。 这个类提供了操作type mirrors的方法。
        结果
        一个在类型镜子上操作的实用程序类

      • isIncluded

        boolean isIncluded​(Element e)
        如果文档中的元素应为 included ，则返回true。
        参数
        e - 元素
        结果
        如果包含，则为true，否则为false

      • isSelected

        boolean isSelected​(Element e)
        如果元素为 selected，则返回true。
        参数
        e - 元素
        结果
        如果选择为真，否则为false

      • getJavaFileManager

        JavaFileManager getJavaFileManager​()
        返回用于读取和写入文件的文件管理器。
        结果
        文件管理器用于读取和写入文件

      • getSourceVersion

        SourceVersion getSourceVersion​()
        返回读取的源文件的源版本。
        结果
        源版本

      • getFileKind

        JavaFileObject.Kind getFileKind​(TypeElement type)
        返回类型元素的文件种类。
        参数
        type - 类型元素
        结果
        文件种类