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
|
/*
* Copyright (c) 2024, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
/*
* @test
* @bug 8297879
* @library /tools/lib ../../lib
* @modules jdk.javadoc/jdk.javadoc.internal.tool
* @build toolbox.ToolBox javadoc.tester.*
* @run main TestErasure
*/
import java.io.IOException;
import java.nio.file.Path;
import javadoc.tester.JavadocTester;
import toolbox.ToolBox;
public class TestErasure extends JavadocTester {
private final ToolBox tb = new ToolBox();
public static void main(String... args) throws Exception {
new TestErasure().runTests();
}
/*
* Create confusion between:
* - a constructor/method type parameter and a like-named class
* - similarly named but differently bounded constructor type parameters
* - similarly named but differently bounded type parameter in methods
*/
@Test
public void test1(Path base) throws IOException {
Path src = base.resolve("src");
// - put public class first so that writeJavaFiles is not confused
// on the name of the file it should create
//
// - an _abstract_ class is used only for convenience: like an interface,
// it allows to keep the test minimal, but unlike an interface, it
// allows to test constructors
tb.writeJavaFiles(src, """
public abstract class Foo {
public Foo(T arg) { }
public <T extends X> Foo(T arg) { }
public <T extends Y> Foo(T arg) { }
public abstract T m(T arg);
public abstract <T extends X> T m(T arg);
public abstract <T extends Y> T m(T arg);
}
class T { }
class X { }
class Y { }
""");
javadoc("-d", base.resolve("out").toString(),
src.resolve("Foo.java").toString());
checkExit(Exit.OK);
// constructors
checkOutput("Foo.html", true, """
<section class="constructor-summary" id="constructor-summary">
<h2>Constructor Summary</h2>
<div class="caption"><span>Constructors</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier</div>
<div class="table-header col-second">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code> </code></div>
<div class="col-constructor-name even-row-color"><code>\
<a href="#%3Cinit%3E(T)" class="member-name-link">Foo</a><wbr>(T arg)</code></div>
<div class="col-last even-row-color"> </div>
<div class="col-first odd-row-color"><code> <T extends X><br></code></div>
<div class="col-constructor-name odd-row-color"><code>\
<a href="#%3Cinit%3E(X)" class="member-name-link">Foo</a><wbr>(T arg)</code></div>
<div class="col-last odd-row-color"> </div>
<div class="col-first even-row-color"><code> <T extends Y><br></code></div>
<div class="col-constructor-name even-row-color"><code>\
<a href="#%3Cinit%3E(Y)" class="member-name-link">Foo</a><wbr>(T arg)</code></div>
<div class="col-last even-row-color"> </div>
</div>
</section>""");
checkOutput("Foo.html", true, """
<li><a href="#constructor-detail" tabindex="0">Constructor Details</a>
<ol class="toc-list">
<li><a href="#%3Cinit%3E(T)" tabindex="0">Foo(T)</a></li>
<li><a href="#%3Cinit%3E(X)" tabindex="0">Foo(T)</a></li>
<li><a href="#%3Cinit%3E(Y)" tabindex="0">Foo(T)</a></li>
</ol>
</li>""");
checkOutput("index-all.html", true, """
<dt><a href="Foo.html#%3Cinit%3E(T)" class="member-name-link">Foo(T)</a>\
- Constructor for class <a href="Foo.html" title="class in Unnamed Package">Foo</a></dt>
<dd> </dd>
<dt><a href="Foo.html#%3Cinit%3E(X)" class="member-name-link">Foo(T)</a>\
- Constructor for class <a href="Foo.html" title="class in Unnamed Package">Foo</a></dt>
<dd> </dd>
<dt><a href="Foo.html#%3Cinit%3E(Y)" class="member-name-link">Foo(T)</a>\
- Constructor for class <a href="Foo.html" title="class in Unnamed Package">Foo</a></dt>
<dd> </dd>""");
checkOutput("member-search-index.js", true, """
{"p":"<Unnamed>","c":"Foo","l":"Foo(T)","u":"%3Cinit%3E(T)"},\
{"p":"<Unnamed>","c":"Foo","l":"Foo(T)","u":"%3Cinit%3E(X)"},\
{"p":"<Unnamed>","c":"Foo","l":"Foo(T)","u":"%3Cinit%3E(Y)"}""");
// methods
checkOutput("Foo.html", true, """
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 \
method-summary-table-tab3"><code>abstract T</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 \
method-summary-table-tab3"><code><a href="#m(T)" class="member-name-link">m</a><wbr>(T arg)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 \
method-summary-table-tab3"> </div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 \
method-summary-table-tab3"><code>abstract <T extends X><br>T</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 \
method-summary-table-tab3"><code><a href="#m(X)" class="member-name-link">m</a><wbr>(T arg)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 \
method-summary-table-tab3"> </div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 \
method-summary-table-tab3"><code>abstract <T extends Y><br>T</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 \
method-summary-table-tab3"><code><a href="#m(Y)" class="member-name-link">m</a><wbr>(T arg)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 \
method-summary-table-tab3"> </div>""");
checkOutput("Foo.html", true, """
<li><a href="#method-detail" tabindex="0">Method Details</a>
<ol class="toc-list">
<li><a href="#m(T)" tabindex="0">m(T)</a></li>
<li><a href="#m(X)" tabindex="0">m(T)</a></li>
<li><a href="#m(Y)" tabindex="0">m(T)</a></li>
</ol>
</li>""");
checkOutput("index-all.html", true, """
<dt><a href="Foo.html#m(T)" class="member-name-link">m(T)</a>\
- Method in class <a href="Foo.html" title="class in Unnamed Package">Foo</a></dt>
<dd> </dd>
<dt><a href="Foo.html#m(X)" class="member-name-link">m(T)</a>\
- Method in class <a href="Foo.html" title="class in Unnamed Package">Foo</a></dt>
<dd> </dd>
<dt><a href="Foo.html#m(Y)" class="member-name-link">m(T)</a>\
- Method in class <a href="Foo.html" title="class in Unnamed Package">Foo</a></dt>
<dd> </dd>""");
checkOutput("member-search-index.js", true, """
{"p":"<Unnamed>","c":"Foo","l":"m(T)"},\
{"p":"<Unnamed>","c":"Foo","l":"m(T)","u":"m(X)"},\
{"p":"<Unnamed>","c":"Foo","l":"m(T)","u":"m(Y)"}""");
}
/*
* Create confusion between the class type parameter
* and a like-named constructor/method type parameter.
*/
@Test
public void test2(Path base) throws IOException {
Path src = base.resolve("src");
tb.writeJavaFiles(src, """
public abstract class Foo<T> {
public Foo(T arg) { }
public <T extends X> Foo(T arg) { }
public abstract T m(T arg);
public abstract <T extends X> T m(T arg);
}
class X { }
""");
javadoc("-d", base.resolve("out").toString(),
src.resolve("Foo.java").toString());
checkExit(Exit.OK);
// constructors
checkOutput("Foo.html", true, """
<section class="constructor-summary" id="constructor-summary">
<h2>Constructor Summary</h2>
<div class="caption"><span>Constructors</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier</div>
<div class="table-header col-second">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code> </code></div>
<div class="col-constructor-name even-row-color"><code>\
<a href="#%3Cinit%3E(T)" class="member-name-link">Foo</a>\
<wbr>(<a href="#type-param-T" title="type parameter in Foo">T</a> arg)</code></div>
<div class="col-last even-row-color"> </div>
<div class="col-first odd-row-color"><code> <T extends X><br></code></div>
<div class="col-constructor-name odd-row-color"><code>\
<a href="#%3Cinit%3E(X)" class="member-name-link">Foo</a><wbr>(T arg)</code></div>
<div class="col-last odd-row-color"> </div>
</div>
</section>""");
checkOutput("Foo.html", true, """
<li><a href="#constructor-detail" tabindex="0">Constructor Details</a>
<ol class="toc-list">
<li><a href="#%3Cinit%3E(T)" tabindex="0">Foo(T)</a></li>
<li><a href="#%3Cinit%3E(X)" tabindex="0">Foo(T)</a></li>
</ol>
</li>""");
checkOutput("index-all.html", true, """
<dt><a href="Foo.html#%3Cinit%3E(T)" class="member-name-link">Foo(T)</a>\
- Constructor for class <a href="Foo.html" title="class in Unnamed Package">Foo</a></dt>
<dd> </dd>
<dt><a href="Foo.html#%3Cinit%3E(X)" class="member-name-link">Foo(T)</a>\
- Constructor for class <a href="Foo.html" title="class in Unnamed Package">Foo</a></dt>
<dd> </dd>""");
checkOutput("member-search-index.js", true, """
{"p":"<Unnamed>","c":"Foo","l":"Foo(T)","u":"%3Cinit%3E(T)"},\
{"p":"<Unnamed>","c":"Foo","l":"Foo(T)","u":"%3Cinit%3E(X)"}""");
// methods
checkOutput("Foo.html", true, """
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 \
method-summary-table-tab3"><code>abstract <a href="#type-param-T" title="type parameter in Foo">T</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 \
method-summary-table-tab3"><code><a href="#m(T)" class="member-name-link">m</a>\
<wbr>(<a href="#type-param-T" title="type parameter in Foo">T</a> arg)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 \
method-summary-table-tab3"> </div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 \
method-summary-table-tab3"><code>abstract <T extends X><br>T</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 \
method-summary-table-tab3"><code><a href="#m(X)" class="member-name-link">m</a><wbr>(T arg)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 \
method-summary-table-tab3"> </div>""");
checkOutput("Foo.html", true, """
<li><a href="#method-detail" tabindex="0">Method Details</a>
<ol class="toc-list">
<li><a href="#m(T)" tabindex="0">m(T)</a></li>
<li><a href="#m(X)" tabindex="0">m(T)</a></li>
</ol>
</li>""");
checkOutput("index-all.html", true, """
<dt><a href="Foo.html#m(T)" class="member-name-link">m(T)</a>\
- Method in class <a href="Foo.html" title="class in Unnamed Package">Foo</a></dt>
<dd> </dd>
<dt><a href="Foo.html#m(X)" class="member-name-link">m(T)</a>\
- Method in class <a href="Foo.html" title="class in Unnamed Package">Foo</a></dt>
<dd> </dd>""");
checkOutput("member-search-index.js", true, """
{"p":"<Unnamed>","c":"Foo","l":"m(T)"},\
{"p":"<Unnamed>","c":"Foo","l":"m(T)","u":"m(X)"}""");
}
@Test
public void testNewAndDeprecated(Path base) throws IOException {
Path src = base.resolve("src");
tb.writeJavaFiles(src, """
public abstract class Foo {
/** @since today */
@Deprecated(since="tomorrow")
public Foo(T arg) { }
/** @since today */
@Deprecated(since="tomorrow")
public <T extends X> Foo(T arg) { }
/** @since today */
@Deprecated(since="tomorrow")
public <T extends Y> Foo(T arg) { }
/** @since today */
@Deprecated(since="tomorrow")
public abstract T m(T arg);
/** @since today */
@Deprecated(since="tomorrow")
public abstract <T extends X> T m(T arg);
/** @since today */
@Deprecated(since="tomorrow")
public abstract <T extends Y> T m(T arg);
}
class T { }
class X { }
class Y { }
""");
javadoc("-d", base.resolve("out").toString(),
"--since", "today",
src.resolve("Foo.java").toString());
checkExit(Exit.OK);
checkOutput("new-list.html", true, """
<div class="col-summary-item-name even-row-color"><a href="Foo.html#m(T)">Foo.m<wbr>(T)</a></div>
<div class="col-second even-row-color">today</div>
<div class="col-last even-row-color"> </div>
<div class="col-summary-item-name odd-row-color"><a href="Foo.html#m(X)">Foo.m<wbr>(T)</a></div>
<div class="col-second odd-row-color">today</div>
<div class="col-last odd-row-color"> </div>
<div class="col-summary-item-name even-row-color"><a href="Foo.html#m(Y)">Foo.m<wbr>(T)</a></div>
<div class="col-second even-row-color">today</div>
<div class="col-last even-row-color"> </div>""");
checkOutput("new-list.html", true, """
<div class="col-summary-item-name even-row-color"><a href="Foo.html#%3Cinit%3E(T)">Foo<wbr>(T)</a></div>
<div class="col-second even-row-color">today</div>
<div class="col-last even-row-color"> </div>
<div class="col-summary-item-name odd-row-color"><a href="Foo.html#%3Cinit%3E(X)">Foo<wbr>(T)</a></div>
<div class="col-second odd-row-color">today</div>
<div class="col-last odd-row-color"> </div>
<div class="col-summary-item-name even-row-color"><a href="Foo.html#%3Cinit%3E(Y)">Foo<wbr>(T)</a></div>
<div class="col-second even-row-color">today</div>
<div class="col-last even-row-color"> </div>""");
checkOutput("deprecated-list.html", true, """
<div class="col-summary-item-name even-row-color"><a href="Foo.html#m(T)">Foo.m<wbr>(T)</a></div>
<div class="col-second even-row-color">tomorrow</div>
<div class="col-last even-row-color"></div>
<div class="col-summary-item-name odd-row-color"><a href="Foo.html#m(X)">Foo.m<wbr>(T)</a></div>
<div class="col-second odd-row-color">tomorrow</div>
<div class="col-last odd-row-color"></div>
<div class="col-summary-item-name even-row-color"><a href="Foo.html#m(Y)">Foo.m<wbr>(T)</a></div>
<div class="col-second even-row-color">tomorrow</div>
<div class="col-last even-row-color"></div>""");
checkOutput("deprecated-list.html", true, """
<div class="col-summary-item-name even-row-color"><a href="Foo.html#%3Cinit%3E(T)">Foo<wbr>(T)</a></div>
<div class="col-second even-row-color">tomorrow</div>
<div class="col-last even-row-color"></div>
<div class="col-summary-item-name odd-row-color"><a href="Foo.html#%3Cinit%3E(X)">Foo<wbr>(T)</a></div>
<div class="col-second odd-row-color">tomorrow</div>
<div class="col-last odd-row-color"></div>
<div class="col-summary-item-name even-row-color"><a href="Foo.html#%3Cinit%3E(Y)">Foo<wbr>(T)</a></div>
<div class="col-second even-row-color">tomorrow</div>
<div class="col-last even-row-color"></div>""");
}
@Test
public void testPreview(Path base) throws IOException {
// unlike that for other tests, here we cannot simulate ambiguity between
// a type parameter and a like-named class, because for that the class
// needs to be in the unnamed package, otherwise its FQN won't be T
Path src = base.resolve("src");
tb.writeJavaFiles(src, """
package p;
import jdk.internal.javac.PreviewFeature;
public abstract class Foo {
@PreviewFeature(feature=PreviewFeature.Feature.TEST)
public <T extends X> Foo(T arg) { }
@PreviewFeature(feature=PreviewFeature.Feature.TEST)
public <T extends Y> Foo(T arg) { }
@PreviewFeature(feature=PreviewFeature.Feature.TEST)
public abstract <T extends X> T m(T arg);
@PreviewFeature(feature=PreviewFeature.Feature.TEST)
public abstract <T extends Y> T m(T arg);
}
class X { }
class Y { }
""");
javadoc("-d", base.resolve("out").toString(),
"--patch-module", "java.base=" + src.toAbsolutePath().toString(),
src.resolve("p").resolve("Foo.java").toString());
checkExit(Exit.OK);
checkOutput("preview-list.html", true, """
<div class="col-summary-item-name even-row-color method method-tab1">\
<a href="java.base/p/Foo.html#m(T)">p.Foo.m<wbr>(T)</a><sup class="preview-mark">\
<a href="java.base/p/Foo.html#preview-m(T)">PREVIEW</a></sup></div>
<div class="col-second even-row-color method method-tab1">Test Feature</div>
<div class="col-last even-row-color method method-tab1"></div>
<div class="col-summary-item-name odd-row-color method method-tab1">\
<a href="java.base/p/Foo.html#m(p.Y)">p.Foo.m<wbr>(T)</a><sup class="preview-mark">\
<a href="java.base/p/Foo.html#preview-m(p.Y)">PREVIEW</a></sup></div>
<div class="col-second odd-row-color method method-tab1">Test Feature</div>
<div class="col-last odd-row-color method method-tab1"></div>""");
checkOutput("preview-list.html", true, """
<div class="col-summary-item-name even-row-color constructor constructor-tab1">\
<a href="java.base/p/Foo.html#%3Cinit%3E(T)">p.Foo<wbr>(T)</a><sup class="preview-mark">\
<a href="java.base/p/Foo.html#preview-%3Cinit%3E(T)">PREVIEW</a></sup></div>
<div class="col-second even-row-color constructor constructor-tab1">Test Feature</div>
<div class="col-last even-row-color constructor constructor-tab1"></div>
<div class="col-summary-item-name odd-row-color constructor constructor-tab1">\
<a href="java.base/p/Foo.html#%3Cinit%3E(p.Y)">p.Foo<wbr>(T)</a><sup class="preview-mark">\
<a href="java.base/p/Foo.html#preview-%3Cinit%3E(p.Y)">PREVIEW</a></sup></div>
<div class="col-second odd-row-color constructor constructor-tab1">Test Feature</div>
<div class="col-last odd-row-color constructor constructor-tab1"></div>""");
}
}
|
