模块  jdk.javadoc
软件包  jdk.javadoc.doclet

Interface Doclet.Option

  • Enclosing interface:
    Doclet

    public static interface Doclet.Option
    Doclet使用的选项名称,别名,参数和描述的封装。
    • 方法详细信息

      • getArgumentCount

        int getArgumentCount()
        返回参数的数量,此选项将消耗。
        结果
        消耗的参数数量
      • getDescription

        String getDescription()
        返回选项的描述。 例如,选项“group”将返回选项的概要,例如“分组文档”。
        结果
        设置描述,否则为空字符串
      • getKind

        Doclet.Option.Kind getKind()
        返回选项类型。
        结果
        这个选项的种类
      • getNames

        List<String> getNames()
        返回可用于标识选项的名称列表。 例如,对于选项“-classpath”,列表可以是["-classpath", "--class-path"] ,别名为“--class-path”。
        结果
        选项的名称
      • getParameters

        String getParameters()
        返回选项的参数。 例如“name <p1>:<p2> ..”
        结果
        如果设置了参数,否则为空String
      • process

        boolean process​(String option,
                        List<String> arguments)
        根据需要处理选项和参数。 如果给定的选项名称与选项匹配,则将调用此方法。
        参数
        option - 选项
        arguments - 封装参数的列表
        结果
        如果操作成功,则返回true,否则返回false