47.4. 空选项
概述
在某些情况下,将方法参数默认为 null 可能会有意义。但是默认情况下不允许这样做。如果要允许 Java API 中的一些方法参数采用 null 值,则必须使用 nullableOptions 元素显式声明它。
语法
nullableOptions 元素可使用一个或多个 nullableOption 子元素定义,如下所示:
<nullableOptions>
<nullableOption>ArgumentName</nullableOption>
...
</nullableOptions>
其中 ArgumentName 是来自 Java API 的 method 参数的名称。
影响范围
如以下提取所示,nullableOptions 元素可以选择性地显示为 apis 元素和/或作为 api 元素子元素的子级:
<configuration>
<apis>
<api>
<apiName>...</apiName>
...
<nullableOptions>...</nullableOptions>
</api>
...
<nullableOptions>...</nullableOptions>
</apis>
</configuration>
您可以在以下范围中定义 nullableOptions 元素:
-
作为
api元素的子级 ,nullableOptions映射只适用于api元素指定的 API 类。 -
作为
apis元素的子级 进行 iwl- iwl- iwl,nullableOptions映射会默认应用于所有 API 类,但可以在api级别被覆盖。