47.4. Null 可能なオプション
概要
場合によっては、メソッドの引数をデフォルトで null にすることは理にかなっています。ただし、これはデフォルトでは許可されません。Java API メソッド引数の一部に null の値を取ることを許可する場合は、nullableOptions 要素を使用して明示的に宣言する必要があります。
構文
nullableOptions 要素は、以下のように 1 つ以上の nullableOption 子要素で定義できます。
<nullableOptions>
<nullableOption>ArgumentName</nullableOption>
...
</nullableOptions>
ArgumentName は、Java API のメソッド引数の名前です。
スコープ
以下の抜粋で示されているように、nullableOptions 要素は、任意で apis 要素の子や api 要素の子として表示できます。
<configuration>
<apis>
<api>
<apiName>...</apiName>
...
<nullableOptions>...</nullableOptions>
</api>
...
<nullableOptions>...</nullableOptions>
</apis>
</configuration>
以下のスコープで nullableOptions 要素を定義できます。
-
api要素の子として:nullableOptionsマッピングは、api要素で指定された API クラスにのみ適用されます。 -
apis要素の子として:nullableOptionsマッピングは、デフォルトですべての API クラスに適用されますが、apiレベルで上書きできます。