1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
|
/*******************************************************************************
* Copyright (c) 2014 Stephan Herrmann and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* Stephan Herrmann - initial API and implementation
*******************************************************************************/
package org.eclipse.jdt.annotation;
/**
* Locations that can be affected by a {@link NonNullByDefault} annotation.
* Each constant of this enum describes a specific kind of type use.
* Wildcards and the use of type variables are always excluded from {@link NonNullByDefault}.
* @since 2.0
*/
public enum DefaultLocation {
/**
* Defines that a given {@link NonNullByDefault} annotation should affect all unannotated
* parameters of any method or constructor within the scope of the annotated declaration.
*
* <h2>Example</h2>
* <pre> @NonNullByDefault(PARAMETER)
* interface X {
* void print(Number n);
* }</pre>
* <p>
* Here <code>Number</code> will be interpreted as <code>@NonNull Number</code>.
* </p>
*/
PARAMETER,
/**
* Defines that a given {@link NonNullByDefault} annotation should affect all unannotated
* method return types within the scope of the annotated declaration.
*
* <h2>Example</h2>
* <pre> @NonNullByDefault(RETURN_TYPE)
* interface X {
* Number getNumber();
* }</pre>
* <p>
* Here <code>Number</code> will be interpreted as <code>@NonNull Number</code>.
* </p>
*/
RETURN_TYPE,
/**
* Defines that a given {@link NonNullByDefault} annotation should affect all unannotated
* field types within the scope of the annotated declaration.
*
* <h2>Example</h2>
* <pre> @NonNullByDefault(FIELD)
* class X {
* Number number = Integer.MAX_VALUE;
* }</pre>
* <p>
* Here <code>Number</code> will be interpreted as <code>@NonNull Number</code>.
* </p>
*/
FIELD,
/**
* Defines that a given {@link NonNullByDefault} annotation should affect all unannotated
* type parameter declarations within the scope of the annotated declaration.
*
* <h2>Example</h2>
* <pre> @NonNullByDefault(TYPE_PARAMETER)
* class X {
* <T> T identity(T t) { return t; }
* }</pre>
* <p>
* Here <code><T></code> will be interpreted as <code><@NonNull T></code>.
* </p>
*/
TYPE_PARAMETER,
/**
* Defines that a given {@link NonNullByDefault} annotation should affect all unannotated
* explicit type bounds within the scope of the annotated declaration. A type bound of
* type {@link java.lang.Object} is <strong>never</strong> considered as an explicit bound,
* i.e., <code>T extends Object</code> is never affected by {@link NonNullByDefault}.
*
* <h2>Example</h2>
* <pre> @NonNullByDefault(TYPE_BOUND)
* interface X {
* <T extends Number> void process(T t, List<? super Number> l);
* }</pre>
* <p>
* Here both occurrences of <code>Number</code> will be interpreted as <code>@NonNull Number</code>.
* </p>
*/
TYPE_BOUND,
/**
* Defines that a given {@link NonNullByDefault} annotation should affect all unannotated
* type arguments within the scope of the annotated declaration (except wildcards and
* type variables).
*
* <h2>Example</h2>
* <pre> @NonNullByDefault(TYPE_ARGUMENT)
* interface X<T> {
* void process(List<T> tl, List<Number> nl);
* }</pre>
* <p>
* Here <code>Number</code> will be interpreted as <code>@NonNull Number</code>,
* but the use of type variable <code>T</code> is not affected.
* </p>
*/
TYPE_ARGUMENT,
/**
* Defines that a given {@link NonNullByDefault} annotation should affect all unannotated
* array components within the scope of the annotated declaration.
*
* <h2>Example</h2>
* <pre> @NonNullByDefault(ARRAY_CONTENTS)
* interface X {
* Number[] n1;
* Number[][] n2;
* }</pre>
* <p>
* These declarations are interpreted as:
* </p>
* <pre> @NonNull Number [] n1;
* @NonNull Number [] @NonNull[] n2;</pre>
* <p>
* I.e., both fields can still be <code>null</code> (see the unannotated left-most pair
* of brackets) but none of the <em>contents</em> of these arrays is allowed to be
* <code>null</code> (at any dimension).
* </p>
*/
ARRAY_CONTENTS
}
|
