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 pathRoundEnvironment.html
353 lines (353 loc) · 16 KB
/
RoundEnvironment.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
353
<!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:28 PST 2014 -->
<title>RoundEnvironment</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="RoundEnvironment";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</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><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">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/annotation/processing/Processor.html" title="interface in javax.annotation.processing"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../javax/annotation/processing/SupportedAnnotationTypes.html" title="annotation in javax.annotation.processing"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?javax/annotation/processing/RoundEnvironment.html" target="_top">Frames</a></li>
<li><a href="RoundEnvironment.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>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">javax.annotation.processing</div>
<h2 title="Interface RoundEnvironment" class="title">Interface RoundEnvironment</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">RoundEnvironment</span></pre>
<div class="block">An annotation processing tool framework will <a href="../../../javax/annotation/processing/Processor.html#process-java.util.Set-javax.annotation.processing.RoundEnvironment-">provide an annotation processor with an object
implementing this interface</a> so that the processor can query for
information about a round of annotation processing.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.6</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/annotation/processing/RoundEnvironment.html#errorRaised--">errorRaised</a></span>()</code>
<div class="block">Returns <code>true</code> if an error was raised in the prior round
of processing; returns <code>false</code> otherwise.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="http://download.java.net/jdk8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><? extends <a href="../../../javax/lang/model/element/Element.html" title="interface in javax.lang.model.element">Element</a>></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/annotation/processing/RoundEnvironment.html#getElementsAnnotatedWith-java.lang.Class-">getElementsAnnotatedWith</a></span>(<a href="http://download.java.net/jdk8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><? extends <a href="http://download.java.net/jdk8/docs/api/java/lang/annotation/Annotation.html?is-external=true" title="class or interface in java.lang.annotation">Annotation</a>> a)</code>
<div class="block">Returns the elements annotated with the given annotation type.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="http://download.java.net/jdk8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><? extends <a href="../../../javax/lang/model/element/Element.html" title="interface in javax.lang.model.element">Element</a>></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/annotation/processing/RoundEnvironment.html#getElementsAnnotatedWith-javax.lang.model.element.TypeElement-">getElementsAnnotatedWith</a></span>(<a href="../../../javax/lang/model/element/TypeElement.html" title="interface in javax.lang.model.element">TypeElement</a> a)</code>
<div class="block">Returns the elements annotated with the given annotation type.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="http://download.java.net/jdk8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><? extends <a href="../../../javax/lang/model/element/Element.html" title="interface in javax.lang.model.element">Element</a>></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/annotation/processing/RoundEnvironment.html#getRootElements--">getRootElements</a></span>()</code>
<div class="block">Returns the root elements for annotation processing generated
by the prior round.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/annotation/processing/RoundEnvironment.html#processingOver--">processingOver</a></span>()</code>
<div class="block">Returns <code>true</code> if types generated by this round will not
be subject to a subsequent round of annotation processing;
returns <code>false</code> otherwise.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="processingOver--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>processingOver</h4>
<pre>boolean processingOver()</pre>
<div class="block">Returns <code>true</code> if types generated by this round will not
be subject to a subsequent round of annotation processing;
returns <code>false</code> otherwise.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if types generated by this round will not
be subject to a subsequent round of annotation processing;
returns <code>false</code> otherwise</dd>
</dl>
</li>
</ul>
<a name="errorRaised--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>errorRaised</h4>
<pre>boolean errorRaised()</pre>
<div class="block">Returns <code>true</code> if an error was raised in the prior round
of processing; returns <code>false</code> otherwise.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if an error was raised in the prior round
of processing; returns <code>false</code> otherwise</dd>
</dl>
</li>
</ul>
<a name="getRootElements--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRootElements</h4>
<pre><a href="http://download.java.net/jdk8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><? extends <a href="../../../javax/lang/model/element/Element.html" title="interface in javax.lang.model.element">Element</a>> getRootElements()</pre>
<div class="block">Returns the root elements for annotation processing generated
by the prior round.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the root elements for annotation processing generated
by the prior round, or an empty set if there were none</dd>
</dl>
</li>
</ul>
<a name="getElementsAnnotatedWith-javax.lang.model.element.TypeElement-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getElementsAnnotatedWith</h4>
<pre><a href="http://download.java.net/jdk8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><? extends <a href="../../../javax/lang/model/element/Element.html" title="interface in javax.lang.model.element">Element</a>> getElementsAnnotatedWith(<a href="../../../javax/lang/model/element/TypeElement.html" title="interface in javax.lang.model.element">TypeElement</a> a)</pre>
<div class="block">Returns the elements annotated with the given annotation type.
The annotation may appear directly or be inherited. Only
package elements and type elements <i>included</i> in this
round of annotation processing, or declarations of members,
constructors, parameters, or type parameters declared within
those, are returned. Included type elements are <a href="../../../javax/annotation/processing/RoundEnvironment.html#getRootElements--">root types</a> and any member types nested within
them. Elements in a package are not considered included simply
because a <code>package-info</code> file for that package was
created.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>a</code> - annotation type being requested</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the elements annotated with the given annotation type,
or an empty set if there are none</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://download.java.net/jdk8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if the argument does not
represent an annotation type</dd>
</dl>
</li>
</ul>
<a name="getElementsAnnotatedWith-java.lang.Class-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getElementsAnnotatedWith</h4>
<pre><a href="http://download.java.net/jdk8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><? extends <a href="../../../javax/lang/model/element/Element.html" title="interface in javax.lang.model.element">Element</a>> getElementsAnnotatedWith(<a href="http://download.java.net/jdk8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><? extends <a href="http://download.java.net/jdk8/docs/api/java/lang/annotation/Annotation.html?is-external=true" title="class or interface in java.lang.annotation">Annotation</a>> a)</pre>
<div class="block">Returns the elements annotated with the given annotation type.
The annotation may appear directly or be inherited. Only
package elements and type elements <i>included</i> in this
round of annotation processing, or declarations of members,
constructors, parameters, or type parameters declared within
those, are returned. Included type elements are <a href="../../../javax/annotation/processing/RoundEnvironment.html#getRootElements--">root types</a> and any member types nested within
them. Elements in a package are not considered included simply
because a <code>package-info</code> file for that package was
created.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>a</code> - annotation type being requested</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the elements annotated with the given annotation type,
or an empty set if there are none</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://download.java.net/jdk8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if the argument does not
represent an annotation type</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= 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><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">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/annotation/processing/Processor.html" title="interface in javax.annotation.processing"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../javax/annotation/processing/SupportedAnnotationTypes.html" title="annotation in javax.annotation.processing"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?javax/annotation/processing/RoundEnvironment.html" target="_top">Frames</a></li>
<li><a href="RoundEnvironment.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>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>