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


@Documented
@Target(value={METHOD,CONSTRUCTOR})
@Retention(value=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
 String explanation
          A textual explaination of why the return value should be checked.
 Priority priority
          The priority of the warning.
 

priority

public abstract Priority priority
The priority of the warning.

Returns:
The priority of the warning.
Default:
edu.umd.cs.findbugs.annotations.Priority.MEDIUM

explanation

public abstract String explanation
A textual explaination of why the return value should be checked.

Returns:
A textual explaination of why the return value should be checked.
Default:
""


Copyright © 2011. All Rights Reserved.