forked from graalvm/graalvm-website
-
Notifications
You must be signed in to change notification settings - Fork 0
/
TargetClass.html
393 lines (385 loc) · 21.3 KB
/
TargetClass.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
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http:https://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>TargetClass (GraalVM SDK Java API Reference)</title>
<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="TargetClass (GraalVM SDK Java API Reference)";
}
}
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><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 class="aboutLanguage"><b>GraalVM SDK Java API Reference<br>23.0.0-dev</b><br>97ab23af23aa77189e902c36602861815e852f1e</div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../com/oracle/svm/core/annotate/Substitute.html" title="annotation in com.oracle.svm.core.annotate"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../../com/oracle/svm/core/annotate/TargetClass.AlwaysIncluded.html" title="class in com.oracle.svm.core.annotate"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/oracle/svm/core/annotate/TargetClass.html" target="_top">Frames</a></li>
<li><a href="TargetClass.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>Field | </li>
<li>Required | </li>
<li><a href="#annotation.type.optional.element.summary">Optional</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#annotation.type.element.detail">Element</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">com.oracle.svm.core.annotate</div>
<h2 title="Annotation Type TargetClass" class="title">Annotation Type TargetClass</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre><a href="http:https://docs.oracle.com/javase/17/docs/api/java/lang/annotation/Retention.html?is-external=true" title="class or interface in java.lang.annotation">@Retention</a>(<a href="http:https://docs.oracle.com/javase/17/docs/api/java/lang/annotation/Retention.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>=<a href="http:https://docs.oracle.com/javase/17/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME" title="class or interface in java.lang.annotation">RUNTIME</a>)
<a href="http:https://docs.oracle.com/javase/17/docs/api/java/lang/annotation/Target.html?is-external=true" title="class or interface in java.lang.annotation">@Target</a>(<a href="http:https://docs.oracle.com/javase/17/docs/api/java/lang/annotation/Target.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>=<a href="http:https://docs.oracle.com/javase/17/docs/api/java/lang/annotation/ElementType.html?is-external=true#TYPE" title="class or interface in java.lang.annotation">TYPE</a>)
public @interface <span class="memberNameLabel">TargetClass</span></pre>
<div class="block">A class annotated with this annotation denotes a class that modifies methods of fields of another
class, called the "original" class. The original class is specified using annotation parameters:
<a href="../../../../../com/oracle/svm/core/annotate/TargetClass.html#value--"><code>TargetClass.value()</code></a> or <a href="../../../../../com/oracle/svm/core/annotate/TargetClass.html#className--"><code>TargetClass.className()</code></a> specify the original class either as a class literal or by
name, while <a href="../../../../../com/oracle/svm/core/annotate/TargetClass.html#classNameProvider--"><code>TargetClass.classNameProvider()</code></a> is the most flexible approach where the class name is
computed by user code. Optionally, inner classes can be specified using the <a href="../../../../../com/oracle/svm/core/annotate/TargetClass.html#innerClass--"><code>TargetClass.innerClass()</code></a>
property.
Based on additional annotations, the original class is modified in different ways:
<ul>
<li>None of <a href="../../../../../com/oracle/svm/core/annotate/Delete.html" title="annotation in com.oracle.svm.core.annotate"><code>Delete</code></a> or <a href="../../../../../com/oracle/svm/core/annotate/Substitute.html" title="annotation in com.oracle.svm.core.annotate"><code>Substitute</code></a>: the annotated class is an alias for the
original class. This is the most frequently used case. All methods and fields of the annotated
class must be annotated too:
<ul>
<li><a href="../../../../../com/oracle/svm/core/annotate/Alias.html" title="annotation in com.oracle.svm.core.annotate"><code>Alias</code></a>: The annotated method or field is an alias for the original element, i.e., the
annotated element does not exist at run time. All usages of the annotated element reference the
original element. For fields, the original field can be further modified using the
<a href="../../../../../com/oracle/svm/core/annotate/RecomputeFieldValue.html" title="annotation in com.oracle.svm.core.annotate"><code>RecomputeFieldValue</code></a> and <a href="../../../../../com/oracle/svm/core/annotate/InjectAccessors.html" title="annotation in com.oracle.svm.core.annotate"><code>InjectAccessors</code></a> annotations (see the documentation of the
annotations for details).</li>
<li><a href="../../../../../com/oracle/svm/core/annotate/Delete.html" title="annotation in com.oracle.svm.core.annotate"><code>Delete</code></a>: The annotated method or field, as well as the original element, do not exist.
Any usage of them will be reported as an error.</li>
<li><a href="../../../../../com/oracle/svm/core/annotate/Substitute.html" title="annotation in com.oracle.svm.core.annotate"><code>Substitute</code></a>: The annotated method replaces the original method.</li>
<li><a href="../../../../../com/oracle/svm/core/annotate/AnnotateOriginal.html" title="annotation in com.oracle.svm.core.annotate"><code>AnnotateOriginal</code></a>: The original method remains mostly unchanged, but with one
exception: all annotations on the annotated method are also present on the original method.</li>
</ul>
</li>
<li><a href="../../../../../com/oracle/svm/core/annotate/Delete.html" title="annotation in com.oracle.svm.core.annotate"><code>Delete</code></a>: The annotated class, as well as the original class, do not exist. Any usage
of them will be reported as an error.</li>
<li><a href="../../../../../com/oracle/svm/core/annotate/Substitute.html" title="annotation in com.oracle.svm.core.annotate"><code>Substitute</code></a>: The annotated class replaces the original class. All fields and methods
of the original class are per default treated as deleted, i.e., any usage of them will be
reported as an error, with the following exception: A method annotated with <a href="../../../../../com/oracle/svm/core/annotate/Substitute.html" title="annotation in com.oracle.svm.core.annotate"><code>Substitute</code></a>
replaces the original method, i.e., calls to the original method now call the annotated method; a
method annotated with <a href="../../../../../com/oracle/svm/core/annotate/KeepOriginal.html" title="annotation in com.oracle.svm.core.annotate"><code>KeepOriginal</code></a> keeps the original method, i.e., calls to the original
method still call the original method.</li>
</ul></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>22.3</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="annotation.type.optional.element.summary">
<!-- -->
</a>
<h3>Optional Element Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation">
<caption><span>Optional Elements</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Optional Element and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http:https://docs.oracle.com/javase/17/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/oracle/svm/core/annotate/TargetClass.html#className--">className</a></span></code>
<div class="block">Specifies the substitutee class using a class-name string.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http:https://docs.oracle.com/javase/17/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><? extends <a href="http:https://docs.oracle.com/javase/17/docs/api/java/util/function/Function.html?is-external=true" title="class or interface in java.util.function">Function</a><<a href="../../../../../com/oracle/svm/core/annotate/TargetClass.html" title="annotation in com.oracle.svm.core.annotate">TargetClass</a>,<a href="http:https://docs.oracle.com/javase/17/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>>></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/oracle/svm/core/annotate/TargetClass.html#classNameProvider--">classNameProvider</a></span></code>
<div class="block">Specifies the substitutee class.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http:https://docs.oracle.com/javase/17/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/oracle/svm/core/annotate/TargetClass.html#innerClass--">innerClass</a></span></code>
<div class="block">Specifies the suffix of the substitutee class name when it is an inner class.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http:https://docs.oracle.com/javase/17/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/oracle/svm/core/annotate/TargetClass.html#onlyWith--">onlyWith</a></span></code>
<div class="block">Substitute only if all provided predicates are true (default: unconditional substitution that
is always included).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http:https://docs.oracle.com/javase/17/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/oracle/svm/core/annotate/TargetClass.html#value--">value</a></span></code>
<div class="block">Specifies the substitutee class using a class literal.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="annotation.type.element.detail">
<!-- -->
</a>
<h3>Element Detail</h3>
<a name="value--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>value</h4>
<pre>public abstract <a href="http:https://docs.oracle.com/javase/17/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> value</pre>
<div class="block">Specifies the substitutee class using a class literal.
Either <a href="../../../../../com/oracle/svm/core/annotate/TargetClass.html#value--"><code>TargetClass.value()</code></a>, <a href="../../../../../com/oracle/svm/core/annotate/TargetClass.html#className--"><code>TargetClass.className()</code></a> or <a href="../../../../../com/oracle/svm/core/annotate/TargetClass.html#classNameProvider--"><code>TargetClass.classNameProvider()</code></a> element can be
used to specify the substitutee class.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>22.3</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>com.oracle.svm.core.annotate.TargetClass.class</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="className--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>className</h4>
<pre>public abstract <a href="http:https://docs.oracle.com/javase/17/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> className</pre>
<div class="block">Specifies the substitutee class using a class-name string. This method is provided for cases
where the substitutee class is not accessible (according to Java language access control
rules).
Either <a href="../../../../../com/oracle/svm/core/annotate/TargetClass.html#value--"><code>TargetClass.value()</code></a>, <a href="../../../../../com/oracle/svm/core/annotate/TargetClass.html#className--"><code>TargetClass.className()</code></a> or <a href="../../../../../com/oracle/svm/core/annotate/TargetClass.html#classNameProvider--"><code>TargetClass.classNameProvider()</code></a> element can be
used to specify the substitutee class.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>22.3</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="classNameProvider--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>classNameProvider</h4>
<pre>public abstract <a href="http:https://docs.oracle.com/javase/17/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><? extends <a href="http:https://docs.oracle.com/javase/17/docs/api/java/util/function/Function.html?is-external=true" title="class or interface in java.util.function">Function</a><<a href="../../../../../com/oracle/svm/core/annotate/TargetClass.html" title="annotation in com.oracle.svm.core.annotate">TargetClass</a>,<a href="http:https://docs.oracle.com/javase/17/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>>> classNameProvider</pre>
<div class="block">Specifies the substitutee class. This is the most flexible version to provide the class name
to specify which class should be substituted. The <a href="http:https://docs.oracle.com/javase/17/docs/api/java/util/function/Function.html?is-external=true#apply-T-" title="class or interface in java.util.function"><code>Function.apply(T)</code></a> method of the
provided class can compute the class name based on system properties (like the JDK version).
This annotation is the argument of the function, so the function can, e.g., build a class
name that incorporates the <a href="../../../../../com/oracle/svm/core/annotate/TargetClass.html#className--"><code>TargetClass.className()</code></a> property.
Either <a href="../../../../../com/oracle/svm/core/annotate/TargetClass.html#value--"><code>TargetClass.value()</code></a>, <a href="../../../../../com/oracle/svm/core/annotate/TargetClass.html#className--"><code>TargetClass.className()</code></a> or <a href="../../../../../com/oracle/svm/core/annotate/TargetClass.html#classNameProvider--"><code>TargetClass.classNameProvider()</code></a> element can be
used to specify the substitutee class.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>22.3</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>com.oracle.svm.core.annotate.TargetClass.NoClassNameProvider.class</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="innerClass--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>innerClass</h4>
<pre>public abstract <a href="http:https://docs.oracle.com/javase/17/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] innerClass</pre>
<div class="block">Specifies the suffix of the substitutee class name when it is an inner class.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>22.3</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>{}</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="onlyWith--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>onlyWith</h4>
<pre>public abstract <a href="http:https://docs.oracle.com/javase/17/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?>[] onlyWith</pre>
<div class="block">Substitute only if all provided predicates are true (default: unconditional substitution that
is always included).
The classes must either implement <a href="http:https://docs.oracle.com/javase/17/docs/api/java/util/function/BooleanSupplier.html?is-external=true" title="class or interface in java.util.function"><code>BooleanSupplier</code></a> or <a href="http:https://docs.oracle.com/javase/17/docs/api/java/util/function/Predicate.html?is-external=true" title="class or interface in java.util.function"><code>Predicate</code></a><String>
(the parameter for <a href="http:https://docs.oracle.com/javase/17/docs/api/java/util/function/Predicate.html?is-external=true#test-T-" title="class or interface in java.util.function"><code>Predicate.test(T)</code></a> is the "original" class name as a <a href="http:https://docs.oracle.com/javase/17/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang"><code>String</code></a>).</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>22.3</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>com.oracle.svm.core.annotate.TargetClass.AlwaysIncluded.class</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 class="aboutLanguage"><b>GraalVM SDK Java API Reference<br>23.0.0-dev</b><br>97ab23af23aa77189e902c36602861815e852f1e</div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../com/oracle/svm/core/annotate/Substitute.html" title="annotation in com.oracle.svm.core.annotate"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../../com/oracle/svm/core/annotate/TargetClass.AlwaysIncluded.html" title="class in com.oracle.svm.core.annotate"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/oracle/svm/core/annotate/TargetClass.html" target="_top">Frames</a></li>
<li><a href="TargetClass.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>Field | </li>
<li>Required | </li>
<li><a href="#annotation.type.optional.element.summary">Optional</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#annotation.type.element.detail">Element</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small><center>Copyright © 2012, 2023, Oracle and/or its affiliates. All rights reserved.</center></small></p>
</body>
</html>