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
|
/*
* 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 4681599 8288058
* @summary Tests for the Constant Values page.
* @library /tools/lib ../../lib
* @modules jdk.javadoc/jdk.javadoc.internal.tool
* @build toolbox.ToolBox javadoc.tester.*
* @run main TestConstantValuesPage
*/
import java.nio.file.Path;
import javadoc.tester.JavadocTester;
import toolbox.ToolBox;
public class TestConstantValuesPage extends JavadocTester {
public static void main(String... args) throws Exception {
var tester = new TestConstantValuesPage();
tester.runTests();
}
ToolBox tb = new ToolBox();
/**
* Test to make sure that constant values page does not get
* generated when doclet has nothing to document.
*/
@Test
public void testNoPage() {
javadoc("-d", "out",
"-sourcepath", testSrc,
"foo");
checkExit(Exit.CMDERR);
checkOutput(Output.OUT, false,
"constant-values.html...");
checkFiles(false, "constant-values.html");
}
/**
* Tests the "contents" list for a group of named packages in the unnamed module.
*/
@Test
public void testIndexNamed(Path base) throws Exception {
Path src = base.resolve("src");
tb.writeJavaFiles(src,
"""
package p1.p2a.p3a;
public class CA {
public static final int ia = 1;
public static final String sa = "string";
}
""",
"""
package p1.p2a.p3b;
public class CB {
public static final int ib = 1;
public static final String sb = "string";
}
""",
"""
package p1.p2b.p3c;
public class CC {
public static final int ic = 1;
public static final String sc = "string";
}
""",
"""
package p2;
public class CD {
public static final int id = 1;
public static final String sd = "string";
}
""");
setAutomaticCheckLinks(true); // ensure link-checking enabled for this test
javadoc("-d", base.resolve("api").toString(),
"-Xdoclint:none",
"-sourcepath", src.toString(),
"p1.p2a.p3a", "p1.p2a.p3b", "p1.p2b.p3c");
checkExit(Exit.OK);
checkOutput("constant-values.html", true,
"""
<nav role="navigation" class="toc" aria-label="Table of contents">
<div class="toc-header">Contents """,
"""
<li><a href="#" tabindex="0">Constant Field Values</a>
<ol class="toc-list">
<li><a href="#p1.p2a" tabindex="0">p1.p2a.*</a></li>
<li><a href="#p1.p2b" tabindex="0">p1.p2b.*</a></li>
</ol>
</li>
</ol>
</nav>""");
}
/**
* Tests the "contents" list for the unnamed package in the unnamed module.
*/
@Test
public void testIndexUnnamed(Path base) throws Exception {
Path src = base.resolve("src");
tb.writeJavaFiles(src,
"""
public class C {
public static final int ia = 1;
public static final String sa = "string";
}
""");
setAutomaticCheckLinks(true); // ensure link-checking enabled for this test
javadoc("-d", base.resolve("api").toString(),
"-Xdoclint:none",
"-sourcepath", src.toString(),
src.resolve("C.java").toString());
checkExit(Exit.OK);
checkOutput("constant-values.html", true,
"""
<nav role="navigation" class="toc" aria-label="Table of contents">
<div class="toc-header">Contents """,
"""
<li><a href="#" tabindex="0">Constant Field Values</a>
<ol class="toc-list">
<li><a href="#unnamed-package" tabindex="0">Unnamed Package</a></li>
</ol>
</li>
</ol>
</nav>""");
}
/**
* Tests the "contents" list for a group of named and unnamed packages in the unnamed module.
*/
@Test
public void testMixed(Path base) throws Exception {
Path src = base.resolve("src");
tb.writeJavaFiles(src,
"""
package p1.p2a.p3a;
public class CA {
public static final int ia = 1;
public static final String sa = "string";
}
""",
"""
public class C {
public static final int ia = 1;
public static final String sa = "string";
}
""");
setAutomaticCheckLinks(true); // ensure link-checking enabled for this test
javadoc("-d", base.resolve("api").toString(),
"-Xdoclint:none",
"-sourcepath", src.toString(),
"p1.p2a.p3a", src.resolve("C.java").toString());
checkExit(Exit.OK);
checkOutput("constant-values.html", true,
"""
<nav role="navigation" class="toc" aria-label="Table of contents">
<div class="toc-header">Contents """,
"""
<li><a href="#" tabindex="0">Constant Field Values</a>
<ol class="toc-list">
<li><a href="#unnamed-package" tabindex="0">Unnamed Package</a></li>
<li><a href="#p1.p2a" tabindex="0">p1.p2a.*</a></li>
</ol>
</li>
</ol>
</nav>""");
}
/**
* Tests the "contents" list for a group of named packages in named modules.
*/
@Test
public void testModules(Path base) throws Exception {
Path src = base.resolve("src");
Path src_mA = src.resolve("mA");
tb.writeJavaFiles(src_mA,
"""
module mA {
exports p.a;
exports p.q.r1;
}
""",
"""
package p.a;
public class CA {
public static final int iA = 1;
}
""",
"""
package p.q.r1;
public class C1 {
public static final int i1 = 1;
}
""");
Path src_mB = src.resolve("mB");
tb.writeJavaFiles(src_mB,
"""
module mB {
exports p.b;
exports p.q.r2;
}
""",
"""
package p.b;
public class CB {
public static final int iB = 1;
}
""",
"""
package p.q.r2;
public class C2 {
public static final int i2 = 1;
}
""");
setAutomaticCheckLinks(true); // ensure link-checking enabled for this test
javadoc("-d", base.resolve("api").toString(),
"-Xdoclint:none",
"--module-source-path", src.toString(),
"--module", "mA,mB");
checkExit(Exit.OK);
checkOutput("constant-values.html", true,
"""
<nav role="navigation" class="toc" aria-label="Table of contents">
<div class="toc-header">Contents """,
"""
<li><a href="#" tabindex="0">Constant Field Values</a>
<ol class="toc-list">
<li><a href="#p.a" tabindex="0">p.a.*</a></li>
<li><a href="#p.b" tabindex="0">p.b.*</a></li>
<li><a href="#p.q" tabindex="0">p.q.*</a></li>
</ol>
</li>
</ol>
</nav>""");
}
}
|
