01: /*
02: * Bytecode Analysis Framework
03: * Copyright (C) 2005 University of Maryland
04: *
05: * This library is free software; you can redistribute it and/or
06: * modify it under the terms of the GNU Lesser General Public
07: * License as published by the Free Software Foundation; either
08: * version 2.1 of the License, or (at your option) any later version.
09: *
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;
22: import java.lang.annotation.ElementType;
23: import java.lang.annotation.Retention;
24: import java.lang.annotation.RetentionPolicy;
25: import java.lang.annotation.Target;
26:
27: import javax.annotation.meta.TypeQualifierNickname;
28: import javax.annotation.meta.When;
29:
30: /**
31: * The annotated element could be null under some circumstances.
32: *
33: * In general, this means developers will have to read the documentation
34: * to determine when a null value is acceptable and whether it is neccessary
35: * to check for a null value.
36: *
37: * When this annotation is applied to a method it applies to the method return value.
38: **/
39: @Documented
40: @Target({ElementType.FIELD,ElementType.METHOD,ElementType.PARAMETER,ElementType.LOCAL_VARIABLE})
41: @Retention(RetentionPolicy.CLASS)
42: @javax.annotation.Nonnull(when=When.UNKNOWN)
43: @TypeQualifierNickname
44: public @interface Nullable {
45:
46: }
|