Red Hat Summit Red Hat Summitサポートコンソール開発者トライアルの開始お問い合わせ

47.2. Javadoc オプション

概要
リンクのコピー

Java API のメタデータが Javadoc によって提供されている場合、通常はオプションなしで fromJavadoc 要素を指定すれば十分です。ただし、API マッピングに Java API 全体を含めたくない場合は、Javadoc メタデータをフィルタリングして内容をカスタマイズできます。言い換えると、API コンポーネント Maven プラグインは Javadoc メタデータを反復処理することで API マッピングを生成するため、Javadoc メタデータの不要な部分をフィルタリングすることで、生成される API マッピングのスコープをカスタマイズすることができます。

構文
リンクのコピー

fromJavadoc 要素には、以下のようにオプションの子要素を設定できます。 

<fromJavadoc>
  <excludePackages>PackageNamePattern</excludePackages>
  <excludeClasses>ClassNamePattern</excludeClasses>
  <excludeMethods>MethodNamePattern</excludeMethods>
  <includeMethods>MethodNamePattern</includeMethods>
  <includeStaticMethods>[true|false]<includeStaticMethods>
</fromJavadoc>
Copy to Clipboard Toggle word wrap

Scope
リンクのコピー

以下の抜粋で示されているように、fromJavadoc 要素は、任意で apis 要素の子や api 要素の子として表示できます。 

<configuration>
  <apis>
    <api>
      <apiName>...</apiName>
      ...
      <fromJavadoc>...</fromJavadoc>
    </api>
    <fromJavadoc>...</fromJavadoc>
    ...
  </apis>
</configuration>
Copy to Clipboard Toggle word wrap

以下のスコープで fromJavadoc 要素を定義できます。

  • api 要素の子として: fromJavadoc オプションは、api 要素で指定された API クラスにのみ適用されます。
  • apis 要素の子として: fromJavadoc オプションは、デフォルトですべての API クラスに適用されますが、api レベルで上書きできます。

オプション
リンクのコピー

以下のオプションは、fromJavadoc の子要素として定義できます。

excludePackages
API マッピングモデルから Java パッケージを除外するための正規表現 (java.util.regex 構文) を指定します。正規表現に一致するパッケージ名はすべて除外され、除外されたクラスから派生したすべてのクラスも無視されます。デフォルト値は javax?\.lang.\* です。
excludeClasses
API マッピングから API ベースクラスを除外するための正規表現 (java.util.regex 構文) を指定します。正規表現に一致するクラス名はすべて除外され、除外されたクラスから派生するすべてのクラスも無視されます。
excludeMethods
API マッピングモデルからメソッドを除外するための正規表現 (java.util.regex 構文) を指定します。
includeMethods
API マッピングモデルのメソッドを含むための正規表現 (java.util.regex 構文) を指定します。
includeStaticMethods
true の場合、static メソッドも API マッピングモデルに含まれます。デフォルトは false です。
トップに戻る
Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

Red Hat をお使いのお客様が、信頼できるコンテンツが含まれている製品やサービスを活用することで、イノベーションを行い、目標を達成できるようにします。 最新の更新を見る.

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。このような変更は、段階的に実施される予定です。詳細情報: Red Hat ブログ.

会社概要

Red Hat は、企業がコアとなるデータセンターからネットワークエッジに至るまで、各種プラットフォームや環境全体で作業を簡素化できるように、強化されたソリューションを提供しています。

Theme

© 2025 Red Hat