モジュール jdk.javadoc
パッケージ jdk.javadoc.doclet

インタフェースDoclet

既知のすべての実装クラス:
StandardDoclet
public interface Doclet
ユーザー・ドックレットは、「パッケージの説明」の説明に従って、このインタフェースを実装する必要があります。 ドックレットの各実装では、ドックレットをインスタンス化するためのツールで使用される、引数なしのパブリック・コンストラクタを提供する必要があります。 ツール・インフラストラクチャとこのインタフェースを実装したクラスとの相互作用は、次のようになります。
  1. ツールは、ドックレット・クラスの引数なしコンストラクタを使用してドックレットのインスタンスを作成します。
  2. 次に、ツールは、適切なロケールおよびレポータを使用してinitメソッドをコールします。
  3. その後、ツールはgetSupportedOptionsとgetSupportedSourceVersionを呼び出します。 これらのメソッドは1回のみ呼び出されます。
  4. 必要に応じて、ツールはドックレット・オブジェクトでrunメソッドをコールし、DocletEnvironmentオブジェクトを提供します。このオブジェクトから、ドックレットはドキュメントに含める要素を決定できます。

前述のプロトコルに従わずにドックレット・オブジェクトを作成して使用した場合、このインタフェース仕様ではドックレットの動作は定義されません。

ドックレットを開始するには、-docletに続けて、javadocツールのコマンドラインでエントリ・ポイント・クラス(すなわち、このインタフェースの実装)の完全修飾名を渡します。

導入されたバージョン:
9

  • ネストされたクラスのサマリー

    ネストされたクラス
    修飾子と型
    インタフェース
    説明
    static interface 
    Doclet.Option
    ドックレットで使用されるオプション名、別名、パラメータおよび説明のカプセル化。

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    String
    getName()
    ドックレットを識別する名前を返します。
    Set<? extends Doclet.Option>
    getSupportedOptions()
    サポートされているすべてのオプションを返します。
    SourceVersion
    getSupportedSourceVersion()
    このドックレットでサポートされているJavaプログラミング言語のバージョンを返します。
    void
    init(Locale locale, Reporter reporter)
    このドックレットを、指定されたロケールおよびエラー・レポータで初期化します。
    boolean
    run(DocletEnvironment environment)
    ドックレットのエントリ・ポイント。

  • メソッドの詳細

    • init

      void init(Locale locale, Reporter reporter)
      このドックレットを、指定されたロケールおよびエラー・レポータで初期化します。 このロケールは、レポータおよびドックレット・コンポーネントによって使用されます。
      パラメータ:
      locale - 使用されるロケール
      reporter - 使用するレポータ

    • getName

      String getName()
      ドックレットを識別する名前を返します。 名前は、「Java言語仕様」の6.2 "名前と識別子"の項で定義されているように、空白を含まない単純な識別子です。
      戻り値:
      ドックレットの名前

    • getSupportedOptions

      Set<? extends Doclet.Option> getSupportedOptions()
      サポートされているすべてのオプションを返します。
      戻り値:
      サポートされているすべてのオプションを含むセット。何もない場合は空のセット

    • getSupportedSourceVersion

      SourceVersion getSupportedSourceVersion()
      このドックレットでサポートされているJavaプログラミング言語のバージョンを返します。
      戻り値:
      このドックレットでサポートされている言語バージョン(通常は最新バージョン)

    • run

      boolean run(DocletEnvironment environment)
      ドックレットのエントリ・ポイント。 このメソッドの指示に従って、さらに処理が開始されます。
      パラメータ:
      environment - そこから本質的な情報を抽出することができる
      戻り値:
      成功した場合は、true