edu.umd.cs.findbugs.annotations
Annotation Type CheckReturnValue

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

Optional Element Summary

boolean	check A value indicating whether or not the return value should be checked.
java.lang.String	explanation A textual explaination of why the return value should be checked
java.lang.String	priority

priority

public abstract java.lang.String priority

Default:

"medium"

explanation

public abstract java.lang.String explanation

A textual explaination of why the return value should be checked

Default:

""

check

public abstract boolean check

A value indicating whether or not the return value should be checked. The only reason to use anything other than the default is if you are overriding a method that notes that its return value should be checked, but your return value doesn't need to be checked.

Default:

true