定义 API 限制

API 工具提供了 Javadoc 标记来显式说明和限制 API 的使用。下列各表总结了每个成员支持的 Javadoc 标记以及每个标记的语义。

client 是指需要定义了相关 API 的捆绑软件的插件或捆绑软件。在定义了 API 的同一捆绑软件中,限制不适用。例如,将接口定义为 @noimplement 的捆绑软件也可以提供该接口的实现。

受支持的限制标记

  类 接口 方法 构造函数

终态字段

非终态字段
@noimplement
-
受支持
-
-
-
-
@noextend
受支持
受支持
-
-
-
-
@noinstantiate
受支持
-
-
-
-
-
@nooverride
-
-
受支持
-
-
-
@noreference
-
-
受支持
受支持
-
受支持

限制语义

@noimplement

指示客户机不能实现此接口。对相关联的接口或者不存在实现超类的相关联接口的父代使用 implements 关键字的任何类都将被标记为产生了问题。

@noextend
指示客户机不能扩展此类或接口。对相关联的类型使用 extends 关键字的任何类或接口都将被标记为产生了问题。
@noinstantiate
指示客户机不能将此类实例化。使用任何构造函数将相关联的类实例化的任何代码都将被标记为产生了问题。
@nooverride
指示客户机不能重新声明此方法。任何子类如何定义了一个覆盖相关联方法的方法,那么都将被标记为产生了问题。
@noreference
指示客户机不能引用此方法、构造函数或者非终态字段。直接调用相关联的方法或构造函数或者引用相关联的非终态字段的任何代码都将被标记为产生了问题。

相关任务

设置基线

相关参考

Javadoc @since 标记管理
API 基线首选项
API 错误和警告首选项