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

インタフェース・ドックレット

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

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

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

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

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

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

    • メソッドの詳細

      • init

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

      • getName

        String getName()
        ドックレットを識別する名前を返します。 名前は、The Java™Language Specificationの6.2項「Names and Identifiers」で定義されているように、空白を含まない単純な識別子です。
        戻り値:
        ドックレットの名前

      • getSupportedOptions

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

      • getSupportedSourceVersion

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

      • run

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