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
|
/*
* Copyright (C) 2022 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.doclava.javadoc;
import com.sun.javadoc.Doc;
import com.sun.source.doctree.DocTree;
import com.sun.source.doctree.ParamTree;
import com.sun.source.doctree.SeeTree;
import com.sun.source.doctree.SerialFieldTree;
import com.sun.source.doctree.ThrowsTree;
import java.util.HashMap;
import java.util.Map;
import javax.lang.model.element.AnnotationValue;
import javax.lang.model.element.Element;
import javax.lang.model.element.ExecutableElement;
import javax.lang.model.element.PackageElement;
import javax.lang.model.element.TypeElement;
import javax.lang.model.element.VariableElement;
import javax.lang.model.type.ArrayType;
import javax.lang.model.type.DeclaredType;
import javax.lang.model.type.TypeMirror;
import javax.lang.model.type.TypeVariable;
import javax.lang.model.type.WildcardType;
import javax.lang.model.util.SimpleElementVisitor14;
import jdk.javadoc.doclet.DocletEnvironment;
/**
* Holds temporary objects required to construct {@link RootDocImpl} from a {@link
* jdk.javadoc.doclet.DocletEnvironment}.
*/
class Context {
public final DocletEnvironment environment;
public final Caches caches = new Caches();
public final DocletElementUtils docletElementUtils;
public Doc obtain(Element element) {
return OBTAIN_VISITOR.visit(element, this);
}
public static class Caches {
public final Map<TypeElement, ClassDocImpl> classes = new HashMap<>();
public final Map<TypeElement, AnnotationTypeDocImpl> annotations = new HashMap<>();
public final Map<PackageElement, PackageDocImpl> packages = new HashMap<>();
public final Map<ExecutableElement, AnnotationMethodDocImpl> annotationMethods =
new HashMap<>();
public final Map<AnnotationValue, AnnotationValueImpl> annotationValues = new HashMap<>();
public final Map<ExecutableElement, ConstructorDocImpl> constructors = new HashMap<>();
public final Map<ExecutableElement, MethodDocImpl> methods = new HashMap<>();
public final Map<VariableElement, FieldDocImpl> fields = new HashMap<>();
public final Map<VariableElement, ParameterImpl> parameters = new HashMap<>();
public final Tags tags = new Tags();
public final Types types = new Types();
public static class Tags {
public final Map<Element, Map<DocTree, TagImpl>> generic = new HashMap<>();
public final Map<Element, Map<SeeTree, SeeTagImpl>> see = new HashMap<>();
public final Map<Element, Map<SerialFieldTree, SerialFieldTagImpl>> serialField =
new HashMap<>();
public final Map<Element, Map<ParamTree, ParamTagImpl>> param = new HashMap<>();
public final Map<Element, Map<ThrowsTree, ThrowsTagImpl>> throwz = new HashMap<>();
}
public static class Types {
public final Map<TypeMirror, TypeImpl> common = new HashMap<>();
public final Map<DeclaredType, AnnotatedTypeImpl> annotated = new HashMap<DeclaredType, AnnotatedTypeImpl>();
public final Map<WildcardType, WildcardTypeImpl> wildcard = new HashMap<>();
public final Map<DeclaredType, ParameterizedTypeImpl> parameterized = new HashMap<>();
public final Map<TypeVariable, TypeVariableImpl> typevar = new HashMap<>();
public final Map<ArrayType, ArrayTypeImpl> array = new HashMap<>();
}
}
public Context(DocletEnvironment environment) {
this.environment = environment;
this.docletElementUtils = new DocletElementUtils(environment);
}
private static final SimpleElementVisitor14<Doc, Context> OBTAIN_VISITOR =
new SimpleElementVisitor14<>() {
@Override
public Doc visitPackage(PackageElement e, Context context) {
return PackageDocImpl.create(e, context);
}
@Override
public Doc visitType(TypeElement e, Context context) {
return switch (e.getKind()) {
case CLASS, ENUM, INTERFACE -> ClassDocImpl.create(e, context);
case ANNOTATION_TYPE -> AnnotationTypeDocImpl.create(e, context);
case RECORD -> throw new UnsupportedOperationException(
"Records not yet supported");
default -> throw new IllegalArgumentException(
"Expected ANNOTATION_TYPE, CLASS, "
+ "ENUM, INTERFACE, or RECORD; but got " + e.getKind());
};
}
};
}
|