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
|
/*
* Copyright (c) 2021, 2022, 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 8265042
* @summary javadoc HTML files not generated for types nested in records
* @library /tools/lib ../../lib
* @modules jdk.javadoc/jdk.javadoc.internal.tool
* @build toolbox.ToolBox javadoc.tester.*
* @run main TestNestedClasses
*/
import java.io.IOException;
import java.nio.file.Path;
import java.util.Arrays;
import java.util.List;
import java.util.Set;
import java.util.TreeSet;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import javax.lang.model.element.ElementKind;
import javadoc.tester.JavadocTester;
import toolbox.ToolBox;
public class TestNestedClasses extends JavadocTester {
public static void main(String... args) throws Exception {
var tester = new TestNestedClasses();
tester.runTests();
tester.runLater();
}
public final ToolBox tb;
public final Set<ElementKind> testedKinds = new TreeSet<>();
public TestNestedClasses() {
tb = new ToolBox();
}
// This is testing the possibility that new kinds of class or interface may be added in future,
// in which case, this test will fail until it is updated.
public void runLater() throws Exception {
Set<ElementKind> expectKinds = Arrays.stream(ElementKind.values())
.filter(k -> k.isClass() || k.isInterface())
.collect(Collectors.toCollection(TreeSet::new));
if (!testedKinds.equals(expectKinds)) {
out.println("Expected: " + expectKinds);
out.println(" Tested: " + testedKinds);
throw new Exception("tested element kinds do not match expected element kinds");
}
}
@Test
public void testClass(Path base) throws IOException {
testedKinds.add(ElementKind.CLASS);
test(base, "C", """
package p;
public class C {
##INSERT##
public void m() { }
}
""");
}
@Test
public void testEnumClass(Path base) throws IOException {
testedKinds.add(ElementKind.ENUM);
test(base, "E", """
package p;
public enum E {
E1, E2, E3;
##INSERT##
public void m() { }
}
""");
}
@Test
public void testRecordClass(Path base) throws IOException {
testedKinds.add(ElementKind.RECORD);
test(base, "R", """
package p;
public record R(int x, int y) {
##INSERT##
public void m() { }
}
""");
}
@Test
public void testInterface(Path base) throws IOException {
testedKinds.add(ElementKind.INTERFACE);
test(base, "I", """
package p;
public interface I {
##INSERT##
public void m();
}
""");
}
@Test
public void testAnnotationInterface(Path base) throws IOException {
testedKinds.add(ElementKind.ANNOTATION_TYPE);
test(base, "A", """
package p;
public @interface A {
##INSERT##
public static final int a = 0;
}
""");
}
void test(Path base, String name, String template) throws IOException {
Path src = base.resolve("src");
String nested = """
public class NC { }
public enum NE { NE1, NE2 }
public record NR(float r, float theta) { }
public interface NI { }
public @interface NA { }
public class ND { public class NE { } }
""";
tb.writeJavaFiles(src, template.replace("##INSERT##", nested));
javadoc("-d", base.resolve("out").toString(),
"-sourcepath", src.toString(),
"-Xdoclint:-missing",
"p");
checkExit(Exit.OK);
List<String> nestedClasses = List.of("NC", "NE", "NR", "NI", "NA", "ND", "ND.NE");
List<String> files = Stream.concat(
List.of(name, "package-summary", "package-tree").stream()
.map(n -> String.format("p/%s.html", n)),
nestedClasses.stream()
.map(n -> String.format("p/%s.%s.html", name, n))
).toList();
checkFiles(true, files);
}
}
|
