Module jdk.javadoc
Package jdk.javadoc.doclet

Interface Doclet.Option

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

  • Method Details

    • 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()
      返回选项的参数。例如"名称 <p1>:<p2>.."。
      返回:
      如果设置了参数，则返回参数，否则返回空字符串

    • process

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