API 错误和警告首选项

可以使用打开“控制台”首选项页 插件开发 > API 错误/警告首选项页来设置下列首选项。

API 问题是在构建项目(自动构建和完全构建)期间产生的,工具将所报告的各种问题分成下面三个类别:

  1. 使用问题 - 未授权的插件所调用的有限代码
  2. API 不兼容性 - 版本之间所作的更改不兼容
  3. 版本问题 - 插件版本或代码版本(@since 标记)不正确
  4. 分析选项 - 常规选项

还可以使用项目的 API 错误/警告属性页来配置每个项目的问题严重性。

API 使用

API 使用选项首选项页

常规

选项

描述

缺省值

使用 API Javadoc 标记不受支持

当启用了此选项时,API 分析构建器将检查是否不正确地使用了 API Javadoc 标记。

忽略

在所指定的执行环境中未定义引用

当启用了此选项时,API 分析构建器将检查对系统库的引用是否非法;按照为捆绑软件指定的执行环境,这些引用可能非法。

忽略

限制

选项

描述

缺省值

实现一个标记为“@noimplement”的接口

当启用了此选项时,API 分析构建器将检查是否非法实现了所标记的接口。

警告

扩展一个标记为“@noextend”的类型

当启用了此选项时,API 分析构建器将检查那些扩展了所标记类型的类。

警告

引用一个标记为“@noreference”的字段或方法

当启用了此选项时,API 分析构建器将检查字段和方法对所标记成员的引用。

警告

实例化一个标有“@noinstantiate”的类

当启用了此选项时,API 分析构建器将检查是否未将所标记的类实例化。

警告

覆盖一个标记为“@nooverride”的方法

当启用了此选项时,API 分析构建器将检查是否在任何子类中都未通过下列方法来覆盖父类中所标记的方法:扩展(通过调用被覆盖的父类来重新实现)或重新实现(未调用被覆盖的父类)。

警告

泄漏

选项

描述

缺省值

扩展非 API 类

当启用了此选项时,API 分析构建器将检查是否有 API 类扩展非 API 类型。

警告

实现非 API 接口

当启用了此选项时,API 分析构建器将检查是否有 API 类实现非 API 接口。

警告

具有非 API 类型的字段

当启用了此选项时,API 分析构建器将检查 API 类型是否存在具有非 API 类型的公用字段或受保护字段。

警告

具有非 API 返回类型的方法

当启用了此选项时,API 分析构建器将检查 API 类型是否存在具有非 API 返回类型的公用方法或受保护方法。

警告

具有非 API 参数类型的方法

当启用了此选项时,API 分析构建器将检查 API 类型是否存在具有非 API 参数类型的公用方法或受保护方法。

警告

API 兼容性

API 兼容性选项首选项页

选项

描述

缺省值

即使经过主要版本增量授权,也要报告 API 被破坏的情况

当启用了此选项时,即使经过捆绑软件的主要版本增量授权,API 分析构建器也将报告 API 被破坏的问题。

已禁用

捆绑软件

选项

描述

缺省值

API 类型已变成非 API 类型

当启用了此选项时,API 分析构建器将检查是否已将当前捆绑软件中的任何 API 类型更改为非 API 类型。

错误

已经除去了一个类型

当启用了此选项时,API 分析构建器将检查是否已经从给定捆绑软件中的 API 作用域中除去了任何 API 类型。

错误

API 重新导出的类型已变成非 API 类型

当启用了此选项时,API 分析构建器将检查是否已将当前捆绑软件中的任何重新导出的 API 类型更改为非 API 类型。

错误

已经除去了一个重新导出的类型

当启用了此选项时,API 分析构建器将检查是否已经从给定捆绑软件中的 API 作用域中除去了任何重新导出的 API 类型。

错误

类

选项

描述

缺省值

已经添加了一种方法(需要实现此方法)

当启用了此选项时,API 分析构建器将检查是否已将任何需要实现的 public 方法或 protected 方法添加至任何 API 类型。

错误

已经添加了限制

当启用了此选项时,API 分析构建器将检查是否已经为任何 API 类添加了 API 限制。

错误

已经添加了一个类型参数

当启用了此选项时,API 分析构建器将检查是否已经为任何 API 类添加了任何类型参数。

错误

已经缩减了超级接口层次结构

当启用了此选项时,API 分析构建器将检查是否已经从任何 API 类中除去了任何父接口。

错误

已经添加了“抽象”关键字

当启用了此选项时,API 分析构建器将检查是否已将“抽象”关键字添加至任何 API 类。

错误

已经添加了“终态”关键字

当启用了此选项时,API 分析构建器将检查是否已将“终态”关键字添加至任何 API 类。

错误

已转换为注释、枚举或接口

当启用了此选项时,API 分析构建器将检查是否已将任何 API 类更改为注释、枚举或接口。

错误

已经降低了可视性

当启用了此选项时,API 分析构建器将检查是否已使任何公用 API 类成为专用作用域或缺省作用域。

错误

已经除去了一个字段

当启用了此选项时,API 分析构建器将检查是否已经从任何 API 类中除去了任何公用字段或受保护字段。

错误

已经除去了一个方法

当启用了此选项时,API 分析构建器将检查是否已经从任何 API 类中除去了任何公用方法或受保护方法。

错误

已经除去了一个构造函数

当启用了此选项时,API 分析构建器将检查是否已经从任何 API 类中除去了任何公用构造函数或受保护构造函数。

错误

已经缩减了超类层次结构

当启用了此选项时,API 分析构建器将检查是否已经从层次结构中除去了任何超类。

错误

已经除去了一个成员类型

当启用了此选项时,API 分析构建器将检查是否已经从任何 API 类中除去了任何成员类型。

错误

已经除去了一个类型参数

当启用了此选项时,API 分析构建器将检查是否已经从任何 API 类中除去了任何类型参数。

错误

接口

选项

描述

缺省值

已添加一个字段(接口未标记为“@noimplement”)

当启用了此选项时,API 分析构建器将检查是否已将任何公用字段添加至任何 API 接口。

错误

已添加一个方法(接口未标记为“@noimplement”)

当启用了此选项时,API 分析构建器将检查是否已将任何公用方法添加至任何 API 接口。

错误

已经添加了限制

当启用了此选项时,API 分析构建器将检查是否已经为任何 API 接口添加了 API 限制。

错误

已经添加了一个类型参数

当启用了此选项时,API 分析构建器将检查是否已将任何类型参数添加至任何 API 接口。

错误

已转换为类、枚举或注释

当启用了此选项时,API 分析构建器将检查是否已将任何 API 接口更改为类、枚举或接口。

错误

已经缩减了超级接口层次结构

当启用了此选项时,API 分析构建器将检查是否除去了任何 API 接口的任何父接口。

错误

已经除去了一个类型参数

当启用了此选项时,API 分析构建器将检查是否已经从任何 API 接口中除去了任何类型参数。

错误

已经除去了一个字段

当启用了此选项时,API 分析构建器将检查是否已经从任何 API 接口中除去了任何公用字段。

错误

已经除去了一个方法

当启用了此选项时,API 分析构建器将检查是否已经从任何 API 接口中除去了任何公用方法。

错误

已经除去了一个成员类型

当启用了此选项时,API 分析构建器将检查是否已经从任何 API 接口中除去了任何成员类型。

错误

枚举

选项

描述

缺省值

已经缩减了超级接口层次结构

当启用了此选项时,API 分析构建器将检查是否已经从任何 API 枚举中除去了任何父接口。

错误

已转换为注释、类或接口

当启用了此选项时,API 分析构建器将检查是否已将任何 API 枚举更改为注释、类或接口。

错误

已经除去了一个字段

当启用了此选项时,API 分析构建器将检查是否已经从任何 API 枚举中除去了任何公用字段。

错误

已经除去了一个枚举常量

当启用了此选项时,API 分析构建器将检查是否已经从任何 API 枚举中除去了任何枚举常量。

错误

已经除去了一个方法

当启用了此选项时,API 分析构建器将检查是否已经从任何 API 枚举中除去了任何公用方法。

错误

已经除去了一个成员类型

当启用了此选项时,API 分析构建器将检查是否已经从任何 API 枚举中除去了任何成员类型。

错误

注释

选项

描述

缺省值

已经添加了一个没有缺省值的方法

当启用了此选项时,API 分析构建器将检查是否已经将一个没有缺省值的方法添加至 API 注释。

错误

已转换为类、枚举或接口

当启用了此选项时,API 分析构建器将检查是否已将任何 API 注释转换为类、枚举或接口。

错误

已经除去了一个字段

当启用了此选项时,API 分析构建器将检查是否已经从任何 API 注释中除去了任何公用字段。

错误

已经除去了一个方法

当启用了此选项时,API 分析构建器将检查是否已经从任何 API 注释中除去了任何 public 方法。

错误

已经除去了一个成员类型

当启用了此选项时,API 分析构建器将检查是否已经从任何 API 注释中除去了任何公用成员类型。

错误

字段

选项

描述

缺省值

已经添加了一个常量值

当启用了此选项时,API 分析构建器将检查是否已将一个常量值添加至任何 API 类型的先前未初始化的任何公用字段常量或受保护字段常量。

错误

已经修改了类型

当启用了此选项时,API 分析构建器将检查是否已经更改了任何 API 类型的任何公用字段或受保护字段的类型。

错误

已经修改了常量值

当启用了此选项时,API 分析构建器将检查是否已经更改了任何 API 类型中的任何公用字段常量或受保护字段常量。

错误

已经降低了可视性

当启用了此选项时,API 分析构建器将检查是否已经使任何公用字段或受保护字段成为任何 API 类型中的专用字段。

错误

已经为静态常量除去了“终态”关键字

当启用了此选项时,API 分析构建器将检查是否已经在任何 API 类型中除去了任何具有“终态”关键字的公用字段或受保护字段。

错误

已经添加了“终态”关键字

当启用了此选项时,API 分析构建器将检查是否已将“终态”关键字添加至任何 API 类型中的任何公用字段或受保护字段。

错误

已经除去了“静态”关键字

当启用了此选项时,API 分析构建器将检查是否已从任何 API 类型中的任何公用字段或受保护字段中除去了“静态”关键字。

错误

已经添加了“静态”关键字

当启用了此选项时,API 分析构建器将检查是否已将“静态”关键字添加至任何 API 类型中的任何公用字段或受保护字段。

错误

已经除去了常量值

当启用了此选项时,API 分析构建器将检查是否已从任何 API 类型中的任何公用字段常量或受保护字段常量中除去了一个常量字段的值。

错误

已经除去了一个类型参数

当启用了此选项时,API 分析构建器将检查是否已经从任何 API 类型的任何公用字段或受保护字段中除去了类型参数。

错误

方法

选项

描述

缺省值

已经添加了 @nooverride 限制

当启用了此选项时,API 分析构建器将检查在任何 API 类型中是否已经通过添加 @nooverride 标记而更改了任何 public 方法或 protected 方法的限制。

错误

已经添加了一个类型参数

当启用了此选项时,API 分析构建器将检查是否已将一个类型参数添加至任何 API 类型的任何公用方法或受保护方法。

错误

已将可变参数转换为数组类型

当启用了此选项时,API 分析构建器将检查是否已将 varargs 参数扩展为任何 API 类型的任何公用方法或受保护方法的对象数组。

错误

已经降低了可视性

当启用了此选项时,API 分析构建器将检查是否已经使任何公用方法或受保护方法成为任何 API 类型的专用方法。

错误

已经添加了“抽象”关键字

当启用了此选项时,API 分析构建器将检查是否已经使任何公用方法或受保护方法成为任何 API 类型中的抽象方法。

错误

已经添加了“静态”关键字

当启用了此选项时,API 分析构建器将检查是否已经使任何公用方法或受保护方法成为任何 API 类型中的静态方法。

错误

已经除去了“静态”关键字

当启用了此选项时,API 分析构建器将检查是否已经使任何公用方法或受保护方法成为任何 API 类型中的非静态方法。

错误

已经添加了“终态”关键字(类型被标记为“@noextend”)

当启用了此选项时,API 分析构建器将检查是否已使任何公用方法或受保护方法成为已标记为 @noextend 的任何 API 类型中的终态方法。

错误

已经除去了注释缺省值

当启用了此选项时,API 分析构建器将检查是否已经除去了与任何 API 注释方法相关联的缺省值。

错误

已经除去了一个类型参数

当启用了此选项时,API 分析构建器将检查是否已从任何 API 类型的任何公用方法或受保护方法中除去了一个类型参数。

错误

构造函数

选项

描述

缺省值

已经添加了一个类型参数

当启用了此选项时,API 分析构建器将检查是否已将一个类型参数添加至任何 API 类型的任何公用构造函数。

错误

已将可变参数转换为数组类型

当启用了此选项时,API 分析构建器将检查是否已将任何 varargs 参数扩展为任何 API 类型的任何公用构造函数的对象数组。

错误

已经降低了可视性

当启用了此选项时,API 分析构建器将检查是否已经使任何公用构造函数成为任何 API 类型中的非公用构造函数。

错误

已经除去了一个类型参数

当启用了此选项时,API 分析构建器将检查是否已从任何 API 类型的任何公用构造函数中除去了一个类型参数。

错误

类型参数

选项

描述

缺省值

已经添加了一个类限定

当启用了此选项时,API 分析构建器将检查是否已将类限定添加至任何 API 类型的任何类型参数。

错误

已经添加了一个接口限定

当启用了此选项时,API 分析构建器将检查是否已将任何接口限定添加至任何 API 类型的任何类型参数。

错误

已经修改了类限定

当启用了此选项时,API 分析构建器将检查是否已更改了任何 API 类型的任何类型参数的任何类限定。

错误

已经修改了接口限定

当启用了此选项时,API 分析构建器将检查是否已更改了任何 API 类型的任何类型参数的任何接口限定。

错误

已经除去了一个类限定

当启用了此选项时,API 分析构建器将检查是否已经从任何 API 类型的任何类型参数中除去了任何类限定。

错误

已经除去了一个接口限定

当启用了此选项时,API 分析构建器将检查是否已经从任何 API 类型的任何类型参数中除去了任何接口限定。

错误

版本管理

API 版本管理选项首选项页

选项

描述

缺省值

报告中缺少“@since”标记

当启用了此选项时,API 分析构建器将检查自从使用 API 基线的版本以来所添加的类型或成员是否缺少 @since 标记。

错误

报告具有格式不正确的“@since”标记

当启用了此选项时,API 分析构建器将检查当前正在使用的任何 @since 标记是否格式不正确(语法不正确)。

错误

报告具有无效的“@since”标记版本

当启用了此选项时,API 分析构建器将检查当前正在使用的任何 @since 标记是否具有错误的版本。

错误

报告具有不兼容的捆绑软件版本

当启用了此选项时,API 分析构建器将根据任何 API 更改和当前正在使用的 API 基线来检查插件的捆绑软件版本是否不正确。

错误

忽略次要版本增量而不更改 API

如果启用了“报告不兼容的版本号”,并且如果尚无与当前 API 基线相匹配的 API 更改,那么可以使用此选项让 API 分析构建器忽略次要版本更改。

开

忽略主要版本增量而不更改 API

如果启用了“报告不兼容的版本号”,并且如果尚无与当前 API 基线相匹配的 API 更改,那么可以使用此选项让 API 分析构建器忽略主要版本更改。

开

分析选项

分析选项首选项页

选项

描述

缺省值

捆绑软件缺少必需的约束/先决条件

当启用了此选项时,API 分析构建器将报告任何缺少的必需约束或先决条件,缺少它们就会使构建器无法执行完整分析。无论此选项的值是什么,都不会对相应的捆绑软件执行分析。

错误

未使用的 API 问题过滤器

当启用了此选项时,API 分析构建器将报告不再使用的任何 API 问题过滤器。

警告

API 使用扫描选项

“API 使用扫描选项”首选项页

选项

描述

缺省值

未解决的类型问题

当启用了此选项时,API 分析构建器将报告 API 使用扫描首选项页上列示的任何使用扫描中包括的任何已除去的 API 类型。

错误

未解决的方法问题

当启用了此选项时,API 分析构建器将报告 API 使用扫描首选项页上列示的任何使用扫描中包括的任何已除去的方法。

错误

未解决的字段问题

当启用了此选项时,API 分析构建器将报告 API 使用扫描首选项页上列示的任何使用扫描中包括的任何已除去的字段。

错误


相关参考

PDE 首选项
API 错误和警告属性页
API 基线首选项
API 使用扫描首选项