Package edu.umd.cs.findbugs.annotations
Annotation Type CheckReturnValue
@Documented
@Target({METHOD,CONSTRUCTOR})
@Retention(CLASS)
@Deprecated
public @interface CheckReturnValue
Deprecated.
This annotation is used to denote a method whose return value should always
be checked when invoking the method.
The checker treats this annotation as inherited by overriding methods.
-
Optional Element Summary
Optional ElementsModifier and TypeOptional ElementDescriptionDeprecated.Deprecated.A textual explanation of why the return value should be checkedDeprecated.
-
Element Details
-
priority
Deprecated.- Default:
MEDIUM
-
confidence
Confidence confidenceDeprecated.- Default:
MEDIUM
-
explanation
String explanationDeprecated.A textual explanation of why the return value should be checked- Default:
""
-
CheckReturnValue
instead.