KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > edu > umd > cs > findbugs > annotations > CheckReturnValue


1 /*
2  * Bytecode Analysis Framework
3  * Copyright (C) 2005 University of Maryland
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2.1 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with this library; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18  */

19 package edu.umd.cs.findbugs.annotations;
20
21 import java.lang.annotation.Documented JavaDoc;
22 import java.lang.annotation.ElementType JavaDoc;
23 import java.lang.annotation.Retention JavaDoc;
24 import java.lang.annotation.RetentionPolicy JavaDoc;
25 import java.lang.annotation.Target JavaDoc;
26
27 /**
28  * This annotation is used to denote a method whose return value
29  * should always be checked when invoking the method.
30  *
31  * The checker treats this annotation as inherited by overriding methods.
32  */

33 @Documented JavaDoc
34 @Target JavaDoc({ElementType.METHOD, ElementType.CONSTRUCTOR})
35 @Retention JavaDoc(RetentionPolicy.CLASS)
36 public @interface CheckReturnValue {
37
38     Priority priority() default Priority.MEDIUM;
39     /**
40      * A textual explaination of why the return value should be checked
41      */

42     String JavaDoc explanation() default "";
43 }
44
Popular Tags