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
|
/*
* Copyright (c) 2003, 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. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* 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.
*/
package com.google.doclava.javadoc;
import com.google.doclava.annotation.Unused;
import com.google.doclava.annotation.Used;
import com.sun.javadoc.ClassDoc;
import com.sun.javadoc.PackageDoc;
import com.sun.javadoc.RootDoc;
import com.sun.javadoc.SourcePosition;
import java.util.ArrayList;
import java.util.List;
import javax.lang.model.element.Element;
import javax.lang.model.element.ElementKind;
import javax.lang.model.element.NestingKind;
import javax.lang.model.element.PackageElement;
import javax.lang.model.element.TypeElement;
import javax.lang.model.util.ElementFilter;
import jdk.javadoc.doclet.DocletEnvironment;
/**
* The {@code RootDocImpl} is an implementation of the "old" Doclet APIs (previously under
* {@code com.sun.javadoc.*}, deprecated since 9 and removed in 13) in terms of new Doclet APIs
* {@link jdk.javadoc.doclet.Doclet}. ({@link DocletEnvironment}).
*/
public class RootDocImpl extends DocImpl<Element> implements RootDoc {
private ClassDoc[] classes;
public RootDocImpl(DocletEnvironment environment) {
super(null, new Context(environment));
for (var e : environment.getSpecifiedElements()) {
switch (e.getKind()) {
case CLASS, INTERFACE, ENUM, ANNOTATION_TYPE -> addClass((TypeElement) e);
case PACKAGE -> PackageDocImpl.create((PackageElement) e, context);
case RECORD -> throw new UnsupportedOperationException(
"records are not yet supported.");
case MODULE -> throw new UnsupportedOperationException(
"modules are not yet supported.");
default -> throw new UnsupportedOperationException(
"Not yet supported top-level TypeElement kind:" + e.getKind());
}
}
}
private void addClass(TypeElement c) {
switch (c.getKind()) {
case CLASS, ENUM, INTERFACE -> ClassDocImpl.create(c, context);
case ANNOTATION_TYPE -> AnnotationTypeDocImpl.create(c, context);
default -> throw new UnsupportedOperationException(
"Unexpected element kind:" + c.getKind());
}
// Initialize nested
// TODO: Need to ensure this is needed!
ElementFilter.typesIn(c.getEnclosedElements())
.stream()
.filter(te -> te.getNestingKind() == NestingKind.MEMBER)
.forEach(te -> {
if (te.getKind() == ElementKind.ANNOTATION_TYPE) {
AnnotationTypeDocImpl.create(te, context);
} else {
ClassDocImpl.create(te, context);
}
});
}
@Override
@Unused
public String[][] options() {
throw new UnsupportedOperationException("not yet implemented");
}
@Override
@Unused
public PackageDoc[] specifiedPackages() {
throw new UnsupportedOperationException("not yet implemented");
}
@Override
@Unused
public ClassDoc[] specifiedClasses() {
throw new UnsupportedOperationException("not yet implemented");
}
@Override
@Used(implemented = true)
public ClassDoc[] classes() {
if (classes == null) {
List<ClassDoc> classesAndAnnotations = new ArrayList<>(context.caches.classes.values());
classesAndAnnotations.addAll(context.caches.annotations.values());
classes = classesAndAnnotations.toArray(ClassDoc[]::new);
}
return classes;
}
@Override
@Used(implemented = true)
public ClassDoc classNamed(String qualifiedName) {
TypeElement cls = context.environment.getElementUtils().getTypeElement(qualifiedName);
return cls == null ? null : ClassDocImpl.create(cls, context);
}
@Override
@Used(implemented = true)
public PackageDoc packageNamed(String name) {
for (PackageDoc pkg : context.caches.packages.values()) {
if (pkg.name().equals(name)) {
return pkg;
}
}
return null;
}
@Override
@Used(implemented = true)
public String name() {
return "*! Doclava !*";
}
@Override
public String qualifiedName() {
throw new UnsupportedOperationException("not yet implemented");
}
@Override
@Used(implemented = true)
public boolean isIncluded() {
return false;
}
@Override
@Unused
public void printError(String msg) {
throw new UnsupportedOperationException("not yet implemented");
}
@Override
@Unused
public void printError(SourcePosition pos, String msg) {
throw new UnsupportedOperationException("not yet implemented");
}
@Override
@Unused
public void printWarning(String msg) {
throw new UnsupportedOperationException("not yet implemented");
}
@Override
@Unused
public void printWarning(SourcePosition pos, String msg) {
throw new UnsupportedOperationException("not yet implemented");
}
@Override
@Unused
public void printNotice(String msg) {
throw new UnsupportedOperationException("not yet implemented");
}
@Override
@Unused
public void printNotice(SourcePosition pos, String msg) {
throw new UnsupportedOperationException("not yet implemented");
}
}
|
