Package edu.umd.cs.findbugs.annotations

Annotation Type CheckReturnValue

@Documented
@Target({METHOD,CONSTRUCTOR})
@Retention(CLASS)
public @interface CheckReturnValue

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 Elements

Modifier and Type	Optional Element	Description
Confidence	confidence
java.lang.String	explanation	A textual explanation of why the return value should be checked
Priority	priority	Deprecated.

Element Detail

priority

@Deprecated
Priority priority

Deprecated.

Default:

edu.umd.cs.findbugs.annotations.Priority.MEDIUM

confidence

Confidence confidence

Default:

edu.umd.cs.findbugs.annotations.Confidence.MEDIUM

explanation

java.lang.String explanation

A textual explanation of why the return value should be checked

Default:

""