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
|
/*
* Copyright (c) 2003, 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 4682448 4947464 5029946 8025633 8026567 8035473 8139101 8175200
8186332 8186703 8182765 8187288 8261976 8303349 8319988
* @summary Verify that the public modifier does not show up in the
* documentation for public methods, as recommended by the JLS.
* If A implements I and B extends A, B should be in the list of
* implementing classes in the documentation for I.
* @library ../../lib
* @modules jdk.javadoc/jdk.javadoc.internal.tool
* @build javadoc.tester.*
* @run main TestInterface
*/
/*
* TODO: make it Interface<PE> ie. fix all ParameterTypes, likely should get
* fixed when Doc is replace by j.l.m, but meanwhile this test has been adjusted
* take the current format this is better than @ignore because we can follow the
* differences as the work progress.
*
* The consensus is that we should have something as follows:
* In Child.html
* Specified by: method in interface<IE>
* Overrides: method in class Parent<PE>
* In other words the TypeParameter in scope should be used ex: Interface<IE>, Parent<PE>
* and Child<CE>
*/
import javadoc.tester.JavadocTester;
public class TestInterface extends JavadocTester {
public static void main(String... args) throws Exception {
var tester = new TestInterface();
tester.runTests();
}
@Test
public void test() {
javadoc("-d", "out",
"--no-platform-links",
"-sourcepath", testSrc,
"pkg");
checkExit(Exit.OK);
checkOutput("pkg/Interface.html", true,
"""
<div class="member-signature"><span class="return-type">int</span> <span class="element-name">method</span>()</div>""",
"""
<div class="member-signature"><span class="modifiers">static final</span> <\
span class="return-type">int</span> <span class="element-name">field</span></div>""",
// Make sure known implementing class list is correct and omits type parameters.
"""
<dl class="notes">
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="Child.html" title="class in pkg">Child</a>, <a href="Parent.h\
tml" title="class in pkg">Parent</a></code></dd>
</dl>""");
checkOutput("pkg/Child.html", true,
// Make sure "All Implemented Interfaces": has substituted type parameters
"""
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="Interface.html" title="interface in pkg">Interface</a><CE></code></dd>
</dl>""",
//Make sure Class Tree has substituted type parameters.
"""
<div class="inheritance" title="Inheritance Tree">java.lang.Object
<div class="inheritance"><a href="Parent.html" title="class in pkg">pkg.Parent</a><CE>
<div class="inheritance">pkg.Child<CE></div>
</div>
</div>""",
//Make sure "Specified By" has substituted type parameters.
"""
<dt>Specified by:</dt>
<dd><code><a href="Interface.html#method()">method</a></code> in interface&\
nbsp;<code><a href="Interface.html" title="interface in pkg">Interface</a><<a\
href="#type-param-CE" title="type parameter in Child">CE</a>></code></dd>""",
//Make sure "Overrides" has substituted type parameters.
"""
<dt>Overrides:</dt>
<dd><code><a href="Parent.html#method()">method</a></code> in class <c\
ode><a href="Parent.html" title="class in pkg">Parent</a><<a href="#type-param-CE\
" title="type parameter in Child">CE</a>></code></dd>""");
checkOutput("pkg/Parent.html", true,
//Make sure "Direct Known Subclasses" omits type parameters
"""
<dl class="notes">
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="Child.html" title="class in pkg">Child</a></code></dd>
</dl>""");
checkOutput("pkg/Interface.html", false,
"public int method--",
"public static final int field");
checkOutput("pkg/ClassWithStaticMembers.html", false,
//Make sure "Specified By" does not appear on class documentation when
//the method is a static method in the interface.
"<dt>Specified by:</dt>\n");
checkOutput("pkg/ClassWithStaticMembers.html", true,
"""
<section class="detail" id="f">
<h3>f</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public static</span> \
<span class="return-type">int</span> <span class="element-name">f</span></div>
<div class="block">A hider field</div>""",
"""
<div class="col-first even-row-color method-summary-table method-summary-table-t\
ab1 method-summary-table-tab4"><code>static void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-\
tab1 method-summary-table-tab4"><code><a href="#m()" class="member-name-link">m<\
/a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-ta\
b1 method-summary-table-tab4">
<div class="block">A hider method</div>
</div>
""",
"""
<section class="detail" id="staticMethod()">
<h3>staticMethod</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public static</span> \
<span class="return-type">void</span> <span class="element-name">staticMethod</span\
>()</div>
"""
);
checkOutput("pkg/ClassWithStaticMembers.html", false,
"""
<section class="detail" id="staticMethod()">
<h3>staticMethod</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public static</span> \
<span class="return-type">void</span> <span class="element-name">staticMethod</span\
>()</div>
<div class="block"><span class="description-from-type-label">Description copied from inte\
rface: <code><a href="InterfaceWithStaticMembers.html#staticMethod()">Inter\
faceWithStaticMembers</a></code></span></div>
<div class="block">A static method</div>
""");
checkOutput("pkg/ClassWithStaticMembers.InnerClass.html", true,
"""
<div class="type-signature"><span class="modifiers">public static class </span><\
span class="element-name type-name-label">ClassWithStaticMembers.InnerClass</span>
<span class="extends-implements">extends java.lang.Object</span></div>
<div class="block">A hider inner class</div>""");
}
@Test
public void test1() {
javadoc("-d", "out-1",
"-sourcepath", testSrc,
"pkg1");
checkExit(Exit.OK);
checkOutput("pkg1/Child.html", true,
// Ensure the correct Overrides in the inheritance hierarchy is reported
"""
<dt>Overrides:</dt>
<dd><code><a href="GrandParent.html#method1()">method1</a></code> in class&\
nbsp;<code><a href="GrandParent.html" title="class in pkg1">GrandParent</a><<\
a href="#type-param-CE" title="type parameter in Child">CE</a>></code>""");
}
@Test
public void test2() {
javadoc("-d", "out-2",
"-sourcepath", testSrc,
"pkg2");
checkExit(Exit.OK);
checkOutput("pkg2/Spliterator.OfDouble.html", true,
// Ensure the correct type parameters are displayed correctly
"""
<h3 id="nested-classes-inherited-from-class-pkg2.Spliterator">Nested classes/int\
erfaces inherited from interface <a href="Spliterator.html#nested-class-sum\
mary" title="interface in pkg2">Spliterator</a></h3>
<code><a href="Spliterator.OfDouble.html" title="interface in pkg2">Spliterator.\
OfDouble</a>, <a href="Spliterator.OfInt.html" title="interface in pkg2">Spliter\
ator.OfInt</a><Integer>, <a href="Spliterator.OfPrimitive.html" title="int\
erface in pkg2">Spliterator.OfPrimitive</a><T,<wbr>T_CONS,<wbr>T_SPLITR></\
code></div>""");
checkOutput("pkg2/Spliterator.html", true,
"""
<div class="caption"><span>Nested Classes</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Interface</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>static interface </code></div>
<div class="col-second even-row-color"><code><a href="Spliterator.OfDouble.html"\
class="type-name-link" title="interface in pkg2">Spliterator.OfDouble</a></code\
></div>
<div class="col-last even-row-color"> </div>
<div class="col-first odd-row-color"><code>static interface </code></div>
<div class="col-second odd-row-color"><code><a href="Spliterator.OfInt.html" cla\
ss="type-name-link" title="interface in pkg2">Spliterator.OfInt</a><<a href="\
Spliterator.OfInt.html#type-param-Integer" title="type parameter in Spliterator.OfInt">Integer</a>&\
gt;</code></div>
<div class="col-last odd-row-color"> </div>
<div class="col-first even-row-color"><code>static interface </code></div>
<div class="col-second even-row-color"><code><a href="Spliterator.OfPrimitive.ht\
ml" class="type-name-link" title="interface in pkg2">Spliterator.OfPrimitive</a>\
<<a href="Spliterator.OfPrimitive.html#type-param-T" title="type parameter in Spliterator.\
OfPrimitive">T</a>, <a href="Spliterator.OfPrimitive.html#type-param-T_CONS" title="type param\
eter in Spliterator.OfPrimitive">T_CONS</a>, <a href="Spliterator.OfPrimitiv\
e.html#type-param-T_SPLITR" title="type parameter in Spliterator.OfPrimitive">T_SPLITR</a> extends <\
a href="Spliterator.OfPrimitive.html" title="interface in pkg2">Spliterator.OfPr\
imitive</a><<a href="Spliterator.OfPrimitive.html#type-param-T" title="type parameter in S\
pliterator.OfPrimitive">T</a>,<wbr><a href="Spliterator.OfPrimitive.html#type-param-T_CONS" title=\
"type parameter in Spliterator.OfPrimitive">T_CONS</a>,<wbr><a href="Spliterator\
.OfPrimitive.html#type-param-T_SPLITR" title="type parameter in Spliterator.OfPrimitive">T_SPLITR</a\
>>></code></div>
<div class="col-last even-row-color"> </div>
</div>""");
checkOutput("allclasses-index.html", true,
"""
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><\
a href="pkg2/Abstract.html" title="class in pkg2">Abstract</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">&n\
bsp;</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a\
href="pkg2/Spliterator.html" title="interface in pkg2">Spliterator<T></a>\
</div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">&nb\
sp;</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><\
a href="pkg2/Spliterator.OfDouble.html" title="interface in pkg2">Spliterator.Of\
Double</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab1">&n\
bsp;</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a\
href="pkg2/Spliterator.OfInt.html" title="interface in pkg2">Spliterator.OfInt&\
lt;Integer></a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">&nb\
sp;</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><\
a href="pkg2/Spliterator.OfPrimitive.html" title="interface in pkg2">Spliterator\
.OfPrimitive<T,<wbr>T_CONS,<wbr>T_SPLITR></a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab1">&n\
bsp;</div>""");
checkOutput("index-all.html", true,
"""
<dt><a href="pkg2/Spliterator.html" class="type-name-link" title="interface in p\
kg2">Spliterator<T></a> - Interface in <a href="pkg2/package-summary.html"\
>pkg2</a></dt>
<dd> </dd>
<dt><a href="pkg2/Spliterator.OfDouble.html" class="type-name-link" title="inter\
face in pkg2">Spliterator.OfDouble</a> - Interface in <a href="pkg2/package-summ\
ary.html">pkg2</a></dt>
<dd> </dd>
<dt><a href="pkg2/Spliterator.OfInt.html" class="type-name-link" title="interfac\
e in pkg2">Spliterator.OfInt<Integer></a> - Interface in <a href="pkg2/pac\
kage-summary.html">pkg2</a></dt>
<dd> </dd>
<dt><a href="pkg2/Spliterator.OfPrimitive.html" class="type-name-link" title="in\
terface in pkg2">Spliterator.OfPrimitive<T,<wbr>T_CONS,<wbr>T_SPLITR></a> \
- Interface in <a href="pkg2/package-summary.html">pkg2</a></dt>
<dd> </dd>""");
}
@Test
public void test3() {
javadoc("-d", "out-3",
"--no-platform-links", // disable links to simplify output matching
"-sourcepath", testSrc,
"pkg3");
checkExit(Exit.OK);
checkOutput("pkg3/I.html", true,
"""
<li>
<section class="detail" id="hashCode()">
<h3>hashCode</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="return-type">\
int</span> <span class="element-name">hashCode</span>()</div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code>hashCode</code> in class <code>java.lang.Object</code></dd>
</dl>
</div>
</section>
</li>
<li>
<section class="detail" id="equals(java.lang.Object)">
<h3>equals</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="return-type">\
boolean</span> <span class="element-name">equals</span>\
<wbr><span class="parameters">(java.lang.Object obj)</span></div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code>equals</code> in class <code>java.lang.Object</code></dd>
</dl>
</div>
</section>
</li>
<li>
<section class="detail" id="toString()">
<h3>toString</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="return-type">\
java.lang.String</span> <span class="element-name">toString</span>()</div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code>toString</code> in class <code>java.lang.Object</code></dd>
</dl>
</div>
</section>
</li>
<li>
<section class="detail" id="clone()">
<h3>clone</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="return-type">\
java.lang.Object</span> <span class="element-name">clone</span>()</div>
</div>
</section>
</li>
""");
}
}
|
