This repository has been archived by the owner on Apr 19, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 5
/
Copy pathpackage-summary.html
352 lines (343 loc) · 14.8 KB
/
package-summary.html
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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0) on Sun Feb 09 15:21:29 PST 2014 -->
<title>javax.lang.model.element</title>
<meta name="date" content="2014-02-09">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="javax.lang.model.element";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../javax/lang/model/package-summary.html">Prev Package</a></li>
<li><a href="../../../../javax/lang/model/type/package-summary.html">Next Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?javax/lang/model/element/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package javax.lang.model.element</h1>
<div class="docSummary">
<div class="block">Interfaces used to model elements of the Java programming language.</div>
</div>
<p>See: <a href="#package.description">Description</a></p>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../javax/lang/model/element/AnnotationMirror.html" title="interface in javax.lang.model.element">AnnotationMirror</a></td>
<td class="colLast">
<div class="block">Represents an annotation.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../javax/lang/model/element/AnnotationValue.html" title="interface in javax.lang.model.element">AnnotationValue</a></td>
<td class="colLast">
<div class="block">Represents a value of an annotation type element.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../javax/lang/model/element/AnnotationValueVisitor.html" title="interface in javax.lang.model.element">AnnotationValueVisitor</a><R,P></td>
<td class="colLast">
<div class="block">A visitor of the values of annotation type elements, using a
variant of the visitor design pattern.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../javax/lang/model/element/Element.html" title="interface in javax.lang.model.element">Element</a></td>
<td class="colLast">
<div class="block">Represents a program element such as a package, class, or method.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../javax/lang/model/element/ElementVisitor.html" title="interface in javax.lang.model.element">ElementVisitor</a><R,P></td>
<td class="colLast">
<div class="block">A visitor of program elements, in the style of the visitor design
pattern.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../javax/lang/model/element/ExecutableElement.html" title="interface in javax.lang.model.element">ExecutableElement</a></td>
<td class="colLast">
<div class="block">Represents a method, constructor, or initializer (static or
instance) of a class or interface, including annotation type
elements.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../javax/lang/model/element/Name.html" title="interface in javax.lang.model.element">Name</a></td>
<td class="colLast">
<div class="block">An immutable sequence of characters.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../javax/lang/model/element/PackageElement.html" title="interface in javax.lang.model.element">PackageElement</a></td>
<td class="colLast">
<div class="block">Represents a package program element.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../javax/lang/model/element/Parameterizable.html" title="interface in javax.lang.model.element">Parameterizable</a></td>
<td class="colLast">
<div class="block">A mixin interface for an element that has type parameters.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../javax/lang/model/element/QualifiedNameable.html" title="interface in javax.lang.model.element">QualifiedNameable</a></td>
<td class="colLast">
<div class="block">A mixin interface for an element that has a qualified name.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../javax/lang/model/element/TypeElement.html" title="interface in javax.lang.model.element">TypeElement</a></td>
<td class="colLast">
<div class="block">Represents a class or interface program element.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../javax/lang/model/element/TypeParameterElement.html" title="interface in javax.lang.model.element">TypeParameterElement</a></td>
<td class="colLast">
<div class="block">Represents a formal type parameter of a generic class, interface, method,
or constructor element.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../javax/lang/model/element/VariableElement.html" title="interface in javax.lang.model.element">VariableElement</a></td>
<td class="colLast">
<div class="block">Represents a field, <code>enum</code> constant, method or constructor
parameter, local variable, resource variable, or exception
parameter.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation">
<caption><span>Enum Summary</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Enum</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../javax/lang/model/element/ElementKind.html" title="enum in javax.lang.model.element">ElementKind</a></td>
<td class="colLast">
<div class="block">The <code>kind</code> of an element.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../javax/lang/model/element/Modifier.html" title="enum in javax.lang.model.element">Modifier</a></td>
<td class="colLast">
<div class="block">Represents a modifier on a program element such
as a class, method, or field.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../javax/lang/model/element/NestingKind.html" title="enum in javax.lang.model.element">NestingKind</a></td>
<td class="colLast">
<div class="block">The <i>nesting kind</i> of a type element.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation">
<caption><span>Exception Summary</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Exception</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../javax/lang/model/element/UnknownAnnotationValueException.html" title="class in javax.lang.model.element">UnknownAnnotationValueException</a></td>
<td class="colLast">
<div class="block">Indicates that an unknown kind of annotation value was encountered.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../javax/lang/model/element/UnknownElementException.html" title="class in javax.lang.model.element">UnknownElementException</a></td>
<td class="colLast">
<div class="block">Indicates that an unknown kind of element was encountered.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package javax.lang.model.element Description">Package javax.lang.model.element Description</h2>
<div class="block">Interfaces used to model elements of the Java programming language.
The term "element" in this package is used to refer to program
elements, the declared entities that make up a program. Elements
include classes, interfaces, methods, constructors, and fields.
The interfaces in this package do not model the structure of a
program inside a method body; for example there is no
representation of a <code>for</code> loop or <code>try</code>-<code>finally</code>
block. However, the interfaces can model some structures only
appearing inside method bodies, such as local variables and
anonymous classes.
<p>When used in the context of annotation processing, an accurate
model of the element being represented must be returned. As this
is a language model, the source code provides the fiducial
(reference) representation of the construct in question rather than
a representation in an executable output like a class file.
Executable output may serve as the basis for creating a modeling
element. However, the process of translating source code to
executable output may not permit recovering some aspects of the
source code representation. For example, annotations with
<a href="http://download.java.net/jdk8/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#SOURCE" title="class or interface in java.lang.annotation">source</a>
<a href="http://download.java.net/jdk8/docs/api/java/lang/annotation/Retention.html?is-external=true" title="class or interface in java.lang.annotation">retention</a> cannot be
recovered from class files and class files might not be able to
provide source position information.
Names of parameters may not be recoverable from class files.
The <a href="../../../../javax/lang/model/element/Modifier.html" title="enum in javax.lang.model.element">modifiers</a> on an
element may differ in some cases including:
<ul>
<li> <code>strictfp</code> on a class or interface
<li> <code>final</code> on a parameter
<li> <code>protected</code>, <code>private</code>, and <code>static</code> on classes and interfaces
</ul>
Additionally, synthetic constructs in a class file, such as
accessor methods used in implementing nested classes and bridge
methods used in implementing covariant returns, are translation
artifacts outside of this model.
<p>During annotation processing, operating on incomplete or
erroneous programs is necessary; however, there are fewer
guarantees about the nature of the resulting model. If the source
code is not syntactically well-formed or has some other
irrecoverable error that could not be removed by the generation of
new types, a model may or may not be provided as a quality of
implementation issue.
If a program is syntactically valid but erroneous in some other
fashion, any returned model must have no less information than if
all the method bodies in the program were replaced by <code>"throw
new RuntimeException();"</code>. If a program refers to a missing type XYZ,
the returned model must contain no less information than if the
declaration of type XYZ were assumed to be <code>"class XYZ {}"</code>,
<code>"interface XYZ {}"</code>, <code>"enum XYZ {}"</code>, or <code>"@interface XYZ {}"</code>. If a program refers to a missing type <code>XYZ<K1, ... ,Kn></code>, the returned model must contain no less
information than if the declaration of XYZ were assumed to be
<code>"class XYZ<T1, ... ,Tn> {}"</code> or <code>"interface XYZ<T1,
... ,Tn> {}"</code>
<p> Unless otherwise specified in a particular implementation, the
collections returned by methods in this package should be expected
to be unmodifiable by the caller and unsafe for concurrent access.
<p> Unless otherwise specified, methods in this package will throw
a <code>NullPointerException</code> if given a <code>null</code> argument.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.6</dd>
</dl>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../javax/lang/model/package-summary.html">Prev Package</a></li>
<li><a href="../../../../javax/lang/model/type/package-summary.html">Next Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?javax/lang/model/element/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>