模块 jdk.javadoc
包 jdk.javadoc.doclet

接口 Doclet.Option

封闭接口：
Doclet
public static interface Doclet.Option
Doclet 使用的选项名称、别名、参数和描述的封装。

  • 方法详情

    • getArgumentCount

      int getArgumentCount()
      返回参数的数量，此选项将消耗。
      返回：
      消耗参数的数量

    • getDescription

      String  getDescription()
      返回选项的描述。例如，选项“group”将返回选项的概要，例如“groups the documents”。
      返回：
      description 如果已设置，否则为空字符串

    • getKind

      Doclet.Option.Kind  getKind()
      返回选项类型。
      返回：
      这个选项的种类

    • getNames

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

    • getParameters

      String  getParameters()
      返回选项的参数。例如“名称 <p1>:<p2>..”
      返回：
      参数（如果已设置），否则为空字符串

    • process

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