47.4. 可为空选项
概述
在某些情况下,让方法参数默认为 null
可能会有意义。但默认情况下不允许这样做。如果要允许 Java API 中的一些方法参数采用 null
值,则必须使用 nullableOptions
元素明确声明它。
语法
nullableOptions
元素可以使用一个或多个 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
元素的子级 wagon-wagonthenullableOptions
映射仅适用于api
元素指定的 API 类。 -
作为
apis
元素的子级 ,它默认应用于所有 API 类,但可以在api
级别上覆盖。