47.3. メソッドのエイリアス
概要
Java API に表示される標準のメソッド名に加えて、与えられたメソッドに追加の名前 (エイリアス) を定義すると便利なことがよくあります。特に一般的なケースは、プロパティー名( ウィジェットなど)をアクセサーメソッド( getWidget や setWidgetなど)のエイリアスとして使用できるようにすることです。
構文
aliases 要素は、以下のように 1 つ以上の alias 子要素で定義できます。
<aliases>
<alias>
<methodPattern>MethodPattern</methodPattern>
<methodAlias>Alias</methodAlias>
</alias>
...
</aliases>
MethodPattern は、Java API からメソッド名を照合するための正規表現(java.util.regex 構文)で、パターンには通常キャプチャーグループが含まれます。Alias は代替式(URI で使用するため)で、前述のキャプチャーグループのテキストを使用できます(例: 1 番目、2 番目、または 3 番目のキャプチャーグループのテキストには $1、$ 2、または $3 として指定)。
スコープ
以下の抜粋で示されているように、aliases 要素は、任意で apis 要素の子や api 要素の子として表示できます。
<configuration>
<apis>
<api>
<apiName>...</apiName>
...
<aliases>...</aliases>
</api>
<aliases>...</aliases>
...
</apis>
</configuration>
以下のスコープで aliases 要素を定義できます。
-
api要素の子として:aliasesマッピングは、api要素で指定された API クラスにのみ適用されます。 -
apis要素の子として:aliasesマッピングはデフォルトですべての API クラスに適用されますが、apiレベルで上書きできます。
例
以下の例は、一般的な get/set bean メソッドパターンのエイリアスを生成する方法を示しています。
<aliases>
<alias>
<methodPattern>[gs]et(.+)</methodPattern>
<methodAlias>$1</methodAlias>
</alias>
</aliases>
前述のエイリアス定義では、getWidget メソッドまたは setWidget メソッドのいずれかのエイリアスとして ウィジェット を使用できます。メソッド名の後半部分をキャプチャーするために、キャプチャー グループ(.+)を使用していることに注意してください(Widget など )。