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

インタフェースDoclet

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

上記のプロトコルを守らずにドックレット・オブジェクトを作成して使用すると、ドックレットの動作はこのインタフェース仕様では定義されません。

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

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

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

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

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    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