注解

SpotBugs 支持多种注解，用于表达开发者的意图，从而让 SpotBugs 能够更恰当地发出警告。
用于 SpotBugs 的注解。

edu.umd.cs.findbugs.annotations.CheckForNull

被注解的元素可能为 null，使用该元素时应当进行 null 检查。

edu.umd.cs.findbugs.annotations.CheckReturnValue

此注解用于标记这样的方法：调用该方法时，其返回值应始终被检查。

edu.umd.cs.findbugs.annotations.CleanupObligation

将一个类或接口标记为需要清理的资源类型。

edu.umd.cs.findbugs.annotations.CreatesObligation

将一个构造方法或方法标记为创建了需要清理的资源。

edu.umd.cs.findbugs.annotations.DefaultAnnotation

表示类或包的所有成员都应使用所提供的注解类的默认值进行注解。

edu.umd.cs.findbugs.annotations.DefaultAnnotationForFields

表示类或包的所有成员都应使用所提供的注解类的默认值进行注解。

edu.umd.cs.findbugs.annotations.DefaultAnnotationForMethods

表示类或包的所有成员都应使用所提供的注解类的默认值进行注解。

edu.umd.cs.findbugs.annotations.DefaultAnnotationForParameters

表示类或包的所有成员都应使用所提供的注解类的默认值进行注解。

edu.umd.cs.findbugs.annotations.DesireNoWarning (已弃用)

基于注解的方式对 lambda 无效。

edu.umd.cs.findbugs.annotations.DesireWarning (已弃用)

基于注解的方式对 lambda 无效。

edu.umd.cs.findbugs.annotations.DischargesObligation

将一个方法标记为清理资源的方法。

edu.umd.cs.findbugs.annotations.ExpectWarning (已弃用)

基于注解的方式对 lambda 无效。

edu.umd.cs.findbugs.annotations.NonNull

被注解的元素不能为 null。

edu.umd.cs.findbugs.annotations.NoWarning (已弃用)

基于注解的方式对 lambda 无效。

edu.umd.cs.findbugs.annotations.Nullable

被标注的元素在某些情况下可能为 null。
这与未被标注的情况同等对待。

edu.umd.cs.findbugs.annotations.OverrideMustInvoke

用于标注一个方法：该方法若被重写，则必须（或应当）在重写方法中通过 super 调用来调用。

edu.umd.cs.findbugs.annotations.PossiblyNull（已废弃）

请改用 CheckForNull。
新名称更清楚地表明，值不仅可能为 null，而且良好的编码实践要求对值进行 null 检查。

edu.umd.cs.findbugs.annotations.ReturnValuesAreNonnullByDefault

该注解可应用于包、类或方法，表示其中的方法默认返回非 null 值，除非存在以下情况：存在显式的可空性注解；该方法重写了超类中的方法（此时以超类中相应参数上的注解为准）；或存在应用于更内层嵌套元素的默认注解。

edu.umd.cs.findbugs.annotations.SuppressWarnings（已废弃）

请改用 SuppressFBWarnings。

edu.umd.cs.findbugs.annotations.UnknownNullness

用于表示该元素的可空性未知，或者在子类中可能以未知的方式发生变化。

edu.umd.cs.findbugs.annotations.CleanupObligation（已废弃）

将一个类或接口标记为需要清理的资源类型。

edu.umd.cs.findbugs.annotations.CreatesObligation（已废弃）

将构造方法或方法标记为创建了需要清理的资源。
被标记的方法必须是带有 CleanupObligation 注解的类的成员。

edu.umd.cs.findbugs.annotations.DischargesObligation（已废弃）

将一个方法标记为清理资源。被标记的方法必须是带有 CleanupObligation 注解的类的成员。