「API 使用パターン (API Use Patterns)」ウィザード

このウィザードでは、API 使用分析を制御するための正規表現パターン作成作業をガイドします。

ウィザードをアクティブにするには、次のステップを実行します。

  1. 新規「API 使用レポート」起動構成の作成中に、「パターン」タブに切り替えます。
  2. そのタブで、「追加...」ボタンを押します。

オプション

説明

デフォルト

パターン型 このリストは、ウィザードで作成できるパターンをすべて表示します。 リストの最初の要素
説明 「パターン型」リストで選択されているパターンの種類に関する説明を表示します。  

ウィザードの先頭ページで、作成したいパターンの種類を選択できます。それぞれのパターンの説明は選択の助けとして用意されています - パターンを選択するだけで「説明」フィールドに説明が表示されます。

「API 使用パターン (API Use pattern)」ウィザード - パターン選択ページ

アーカイブ・パターン

API 使用分析が完了すると、バンドルのすべてのフォルダーとアーカイブがスキャンされます。すべてのクラス・ファイルが必ず分析されます。バンドルには、(例えば) 分析しないクラス・ファイルの古いバージョンのアーカイブが含まれていることもあります。 この場合、アーカイブ・パターンを使用して、特定のアーカイブまたは正規表現にマッチングするすべてのアーカイブを完全に無視できます。

オプション

説明

デフォルト

バンドル名 このパターンを適用するバンドルの完全シンボル名。 例: org.eclipse.pde.api.tools。 空
アーカイブ名 (Archive Name) パターンを適用するアーカイブの完全な名前か正規表現。 例: *.jar - これはすべてのネストした jar ファイルを無視します。 空

「API 使用パターン (API Use pattern)」ウィザード - アーカイブ・パターンの作成

パッケージ・パターン

分析のために参照を抽出する際、「API 使用」検索エンジンはバンドルからのメタデータを使用し、参照が内部かそうでないか判断します。バンドルが、どのクラスが内部でどれがそうでないかを適切に記述するようにセットアップされていないこともあります。「パッケージ・パターン」 により、どれが内部かそうでないかを - 検索エンジンの観点からだけで、実際のバンドルは絶対変更されないのですが - 誤った形式のバンドルにさらに多く記述させられます。

オプション

説明

デフォルト

パターン パッケージにマッチングさせる正規表現パターン。 例: .*¥.internal¥..*。 空
API パターン パターンにマッチングするパッケージを API と見なすかどうか。 checked

「API 使用パターン (API Use pattern)」ウィザード - パッケージ・パターンの作成

レポート変換パターン

API 使用分析が完了すると、検討する情報が膨大な量になることがあります。しかし、レポート変換パターンにより、参照情報を HTML レポートで表示して減らし、関心のあるものだけを見ることができます。そのために、レポートされる参照を除去するために使用する排他パターンを作成できます。

オプション

説明

デフォルト

参照をこのパターンにフィルター処理 このパターンにマッチングするレポート参照を無視できます。例えば、パターンが org¥.eclipse¥.jdt¥..* である場合、このオプションを選択すると、JDT へのすべての参照をレポートしなくなります。 selected
このパターンの参照をフィルター処理 このパターンにマッチングするレポート参照を無視できます。例えば、パターンが org¥.eclipse¥.jdt¥..* である場合、このオプションを選択すると、JDT からのすべての参照をレポートしなくなります。  
パターン 正規表現パターン。 空

「API 使用パターン (API Use pattern)」ウィザード - レポート変換パターンの作成

関連タスク

API ツールのセットアップ

関連リファレンス

API ツールのセットアップ・アクション
「PDE ツール」メニュー
API 使用レポート