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
|
/*
* Copyright (c) 2003, 2016, 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 4421066
* @summary Verify the comments in an enum type.
* @library ../../../lib
* @modules jdk.javadoc/jdk.javadoc.internal.tool
* @build javadoc.tester.*
* @run main EnumCommentTest
*/
import javax.lang.model.element.ElementKind;
import javax.lang.model.element.ExecutableElement;
import javax.lang.model.element.TypeElement;
import javax.lang.model.element.VariableElement;
import javax.lang.model.util.ElementFilter;
import javax.lang.model.util.Elements;
import javadoc.tester.JavadocTester;
import javadoc.tester.TestDoclet;
import jdk.javadoc.doclet.DocletEnvironment;
public class EnumCommentTest extends JavadocTester {
public static void main(String[] args) throws Exception {
JavadocTester t = new EnumCommentTest();
t.runTests();
}
@Test
public void testEnumComments() {
javadoc("-sourcepath", testSrc,
"-docletpath", System.getProperty("test.class.path"),
"-doclet", "EnumCommentTest$ThisDoclet",
"pkg1");
checkExit(Exit.OK);
}
public static class ThisDoclet extends TestDoclet {
public boolean run(DocletEnvironment env) {
Elements elements = env.getElementUtils();
System.err.println("incl " + env.getIncludedElements());
TypeElement operation = env.getIncludedElements()
.stream()
.filter(e -> e.getKind() == ElementKind.ENUM)
.map(e -> (TypeElement) e)
.findFirst()
.orElseThrow(() -> new Error("can't find enum Operation"));
boolean ok = checkComment(elements.getDocComment(operation).trim(),
"Arithmetic operations.");
for (VariableElement f : ElementFilter.fieldsIn(operation.getEnclosedElements())) {
if (f.getSimpleName().contentEquals("plus")) {
ok = checkComment(elements.getDocComment(f).trim(),
"Addition")
&& ok;
for (ExecutableElement m : ElementFilter.methodsIn(operation.getEnclosedElements())) {
if (m.getSimpleName().contentEquals("eval")) {
ok = checkComment(elements.getDocComment(m).trim(),
"Perform arithmetic operation represented by this constant.")
&& ok;
break;
}
}
break;
}
}
if (!ok) {
throw new Error("Comments don't match expectations.");
} else {
return true;
}
}
private boolean checkComment(String found, String expected) {
System.out.println("expected: \"" + expected + "\"");
System.out.println("found: \"" + found + "\"");
return expected.equals(found);
}
}
}
|
