Package edu.umd.cs.findbugs.annotations

package edu.umd.cs.findbugs.annotations

Annotations for FindBugs (mostly deprecated except for SuppressFBWarnings). This annotations are mostly deprecated and replaced by JSR 305 annotations defined in javax.annotation. The annotations still actively supported are:

• SuppressFBWarnings for suppressing FindBugs warnings
• Annotations about expected/unexpected warnings in FindBugs regression tests
  • ExpectWarning Warnings expected to be generated
  • NoWarning Warnings that should not be generated
  • DesireWarning Warnings we wish to generated
  • DesireNoWarning Warnings we wish to not generate generated

There are another set of annotations used by an experimental detector for unclosed resources:

• CleanupObligation
• CreatesObligation
• DischargesObligation

Related Packages

Package	Description
edu.umd.cs.findbugs	Main package for the FindBugs application - contains the engine class (FindBugs), the object model classes for bug instances (BugInstance, BugAnnotation), and other miscellany.

Class	Description
CheckForNull	Deprecated. - use CheckForNull instead.
CheckReturnValue	Deprecated. - use CheckReturnValue instead.
CleanupObligation	Mark a class or interface as a resource type requiring cleanup.
Confidence	Describes the confidence with which FindBugs reports a bug instance.
CreatesObligation	Mark a constructor or method as creating a resource which requires cleanup.
DefaultAnnotation	Deprecated. - Use the JSR305 annotations instead.
DefaultAnnotationForFields	Deprecated.
DefaultAnnotationForMethods	Deprecated.
DefaultAnnotationForParameters	Deprecated. - use the JSR305 annotations instead, For example, you can use ParametersAreNonnullByDefault instead of @DefaultAnnotation(NonNull.class), and TypeQualifierDefault in general to define a type qualifier default.
DesireNoWarning	Annotation indicating that no FindBugs warnings of the specified type is desired.
DesireWarning	Annotation indicating that a FindBugs warning is desired.
DischargesObligation	Mark a method as cleaning up a resource.
ExpectWarning	Annotation indicating that a FindBugs warning is expected.
NonNull	Deprecated. - use Nonnull instead.
NoWarning	Annotation indicating that no FindBugs warning is expected.
Nullable	Deprecated. - use Nullable instead.
OverrideMustInvoke	Deprecated. - Use OverridingMethodsMustInvokeSuper instead
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.
Priority	Deprecated. use Confidence instead
ReturnValuesAreNonnullByDefault	Deprecated.
SuppressFBWarnings	Used to suppress FindBugs warnings.
SuppressWarnings	Deprecated. - Use SuppressFBWarnings instead
UnknownNullness	Deprecated.
When	Deprecated.