Package edu.umd.cs.findbugs.annotations
Annotations for FindBugs (mostly deprecated except for
SuppressFBWarnings).
There are another set of annotations used by an experimental detector for unclosed resources:
-
Enum Summary Enum Description Confidence Describes the confidence with which FindBugs reports a bug instance.Priority Deprecated. useConfidenceinsteadWhen Deprecated. -
Annotation Types Summary Annotation Type Description CheckForNull The annotated element might be null, and uses of the element should check for null.CheckReturnValue This annotation is used to denote a method whose return value should always be checked when invoking the method.CleanupObligation Mark a class or interface as a resource type requiring cleanup.CreatesObligation Mark a constructor or method as creating a resource which requires cleanup.DefaultAnnotation Indicates that all members of the class or package should be annotated with the default value of the supplied annotation class.DefaultAnnotationForFields Indicates that all members of the class or package should be annotated with the default value of the supplied annotation class.DefaultAnnotationForMethods Indicates that all members of the class or package should be annotated with the default value of the supplied annotation class.DefaultAnnotationForParameters Indicates that all members of the class or package should be annotated with the default value of the supplied annotation class.DesireNoWarning Deprecated. The annotation based approach is useless for lambdas.DesireWarning Deprecated. The annotation based approach is useless for lambdas.DischargesObligation Mark a method as cleaning up a resource.ExpectWarning Deprecated. The annotation based approach is useless for lambdas.NonNull The annotated element must not be null.NoWarning Deprecated. The annotation based approach is useless for lambdas.Nullable The annotated element could be null under some circumstances.OverrideMustInvoke Used to annotate a method that, if overridden, must (or should) be invoked by an invocation on super in the overriding method.PossiblyNull Deprecated. - use CheckForNull instead; the name of which more clearly indicates that not only could the value be null, but that good coding practice requires that the value be checked for null.ReturnValuesAreNonnullByDefault This annotation can be applied to a package, class or method to indicate that the methods in that element have nonnull return values by default unless there is: An explicit nullness annotation The method overrides a method in a superclass (in which case the annotation of the corresponding parameter in the superclass applies) there is a default annotation applied to a more tightly nested element.SuppressFBWarnings Used to suppress FindBugs warnings.SuppressWarnings Deprecated. - UseSuppressFBWarningsinsteadUnknownNullness Used to indicate that the nullness of element is unknown, or may vary in unknown ways in subclasses.