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
|
/*
* Copyright (c) 2002, 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 4496290 4985072 7006178 7068595 8016328 8050031 8048351 8081854 8071982 8162363 8175200 8186332
* 8182765 8196202 8202626 8261976 8323698
* @summary A simple test to ensure class-use files are correct.
* @library /tools/lib ../../lib
* @modules jdk.javadoc/jdk.javadoc.internal.tool
* @build javadoc.tester.*
* @run main TestUseOption
*/
import javadoc.tester.JavadocTester;
import toolbox.ToolBox;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
public class TestUseOption extends JavadocTester {
public static void main(String... args) throws Exception {
var tester = new TestUseOption();
tester.runTests();
}
private final ToolBox tb = new ToolBox();
@Test
public void test1() {
javadoc("-d", "out-1",
"-sourcepath", testSrc,
"-use",
"pkg1", "pkg2");
checkExit(Exit.OK);
// Eight tests for class use.
for (int i = 1; i <= 8; i++) {
checkOutput("pkg1/class-use/C1.html", true,
"Test " + i + " passes");
}
// Three more tests for package use.
for (int i = 1; i <= 3; i++) {
checkOutput("pkg1/package-use.html", true,
"Test " + i + " passes");
}
checkOrder("pkg1/class-use/UsedClass.html",
"Field in C1.",
"Field in C2.",
"Field in C4.",
"Field in C5.",
"Field in C6.",
"Field in C7.",
"Field in C8.",
"Method in C1.",
"Method in C2.",
"Method in C4.",
"Method in C5.",
"Method in C6.",
"Method in C7.",
"Method in C8."
);
checkOutput("pkg1/class-use/UsedClass.html", true,
"that return types with arguments of type"
);
checkOutput("pkg1/class-use/UsedClass.html", true,
"""
<a href="../C1.html#methodInC1ReturningType()" class="member-name-link">methodInC1ReturningType</a>"""
);
checkOutput("pkg1/class-use/UsedInterface.html", true,
"""
Classes in <a href="../package-summary.html">pkg1</a> that implement <a href="..\
/UsedInterface.html" title="interface in pkg1">UsedInterface</a>"""
);
checkOutput("pkg1/class-use/UsedInterfaceA.html", true,
"""
Classes in <a href="../package-summary.html">pkg1</a> that implement <a href="..\
/UsedInterfaceA.html" title="interface in pkg1">UsedInterfaceA</a>"""
);
checkOutput("pkg1/class-use/UsedClass.html", false,
"methodInC1Protected"
);
checkOutput("pkg1/class-use/UsedInterface.html", true,
"""
<a href="../AnAbstract.html" class="type-name-link" title="class in pkg1">AnAbstract</a>"""
);
checkOutput("pkg1/class-use/UsedInterface.html", true,
"../C10.html#withReturningTypeParameters()"
);
checkOutput("pkg1/class-use/UsedInterface.html", true,
"../C10.html#withTypeParametersOfType(java.lang.Class)"
);
checkOutput("pkg1/class-use/UsedInterface.html", true,
"""
"../package-summary.html">pkg1</a> that return <a href="../UsedInterface.html" title="interface in pkg1\""""
);
checkOutput("pkg1/class-use/UsedInterface.html", true,
"""
<a href="../C10.html#addAll(pkg1.UsedInterface...)" class="member-name-link">addAll</a>"""
);
checkOutput("pkg1/class-use/UsedInterface.html", true,
"""
<a href="../C10.html#create(pkg1.UsedInterfaceA,pkg1.UsedInterface,java.lang.String)" class="member-name-link">"""
);
checkOutput("pkg1/class-use/UsedInterface.html", true,
"""
<a href="../C10.html#withTypeParametersOfType(java.lang.Class)" class="member-name-link">withTypeParametersOfType</a>"""
);
checkOutput("pkg1/class-use/UsedInterface.html", true,
"""
Subinterfaces of <a href="../UsedInterface.html" title="interface in pkg1">UsedI\
nterface</a> in <a href="../package-summary.html">pkg1""",
"""
<div class="col-first even-row-color"><code>interface </code></div>
<div class="col-second even-row-color"><code><a href="\
../SubInterface.html" class="type-name-link" title="interface in pkg1">SubInterface</a><T>\
</code></div>"""
);
checkOutput("pkg1/class-use/UsedThrowable.html", true,
"""
Methods in <a href="../package-summary.html">pkg1</a> that throw <a href="../Use\
dThrowable.html" title="class in pkg1">UsedThrowable</a>""",
"""
<div class="col-first even-row-color"><code>void</code></div>
<div class="col-second even-row-color"><span class="type-name-label">C1.</span><code>\
<a href="../C1.html#methodInC1ThrowsThrowable()" class="member-name-link">\
methodInC1ThrowsThrowable</a>()</code></div>"""
);
}
@Test
public void test2() {
javadoc("-d", "out-2",
"-sourcepath", testSrc,
"-use",
testSrc("C.java"), testSrc("UsedInC.java"), "pkg3");
checkExit(Exit.OK);
checkOutput("class-use/UsedInC.html", true,
"""
Uses of <a href="../UsedInC.html" title="class in Unnamed Package">UsedInC</a> i\
n <a href="../package-summary.html">Unnamed Package</a>"""
);
checkOutput("class-use/UsedInC.html", true,
"""
<li>
<section class="detail" id="unnamed-package">
"""
);
checkOutput("package-use.html", true,
"""
<div class="col-first even-row-color"><a href="class-use/UsedInC.html#unnamed-package">UsedInC</a></div>""",
"""
<div class="col-first even-row-color"><a href="#unnamed-package">Unnamed Package</a></div>
<div class="col-last even-row-color"> </div>"""
);
}
@Test
public void test3() {
javadoc("-d", "out-3",
"-sourcepath", testSrc,
"-use",
"-package", "unique");
checkExit(Exit.OK);
checkUnique("unique/class-use/UseMe.html",
"""
<a href="../C1.html#umethod1(unique.UseMe,unique.UseMe%5B%5D)" class="member-name-link">""",
"""
<a href="../C1.html#umethod2(unique.UseMe,unique.UseMe)" class="member-name-link">""",
"""
<a href="../C1.html#umethod3(unique.UseMe,unique.UseMe)" class="member-name-link">""",
"""
<a href="../C1.html#%3Cinit%3E(unique.UseMe,unique.UseMe)" class="member-name-link">""");
}
@Test
public void testSuperclassAndInterfaceTypeArgument(Path base) throws IOException {
Path src = base.resolve("src");
Files.createDirectories(src);
tb.writeJavaFiles(src,
"""
public class One {}
""",
"""
import java.util.*;
public class Two extends ArrayList<One> implements Comparator<One> {
}
""",
"""
import java.util.*;
public interface Three extends Comparator<One> {
}
""");
javadoc(
"-use",
"-d", base.resolve("out").toString(),
src.resolve("One.java").toString(),
src.resolve("Two.java").toString(),
src.resolve("Three.java").toString()
);
checkExit(Exit.OK);
checkOrder("class-use/One.html",
"""
<div class="caption"><span>Subclasses with type arguments of \
type <a href="../One.html" title="class in Unnamed Package">One</a> \
in <a href="../package-summary.html">Unnamed Package</a></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">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>class </code></div>
<div class="col-second even-row-color"><code><a href="../Two.html" class="type-name-link" \
title="class in Unnamed Package">Two</a></code></div>
<div class="col-last even-row-color"> </div>
</div>
""",
"""
<div class="caption"><span>Subinterfaces with type arguments of \
type <a href="../One.html" title="class in Unnamed Package">One</a> \
in <a href="../package-summary.html">Unnamed Package</a></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>interface </code></div>
<div class="col-second even-row-color"><code><a href="../Three.html" class="type-name-link" title="interface in Unnamed Package">Three</a></code></div>
<div class="col-last even-row-color"> </div>
</div>
""",
"""
<div class="caption"><span>Classes in <a href="../package-summary.html">\
Unnamed Package</a> that implement interfaces with type arguments of type \
<a href="../One.html" title="class in Unnamed Package">One</a></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">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>class </code></div>
<div class="col-second even-row-color"><code><a href="../Two.html" class="type-name-link" \
title="class in Unnamed Package">Two</a></code></div>
<div class="col-last even-row-color"> </div>
</div>
""");
}
}
|
