1 /*
2 * Copyright (c) 2003, 2019, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26 package jdk.javadoc.internal.doclets.formats.html;
27
28 import javax.lang.model.element.Element;
29 import javax.lang.model.element.ExecutableElement;
30 import javax.lang.model.element.TypeElement;
31 import javax.lang.model.type.TypeMirror;
32
33 import jdk.javadoc.internal.doclets.formats.html.markup.ContentBuilder;
34 import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;
35 import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
36 import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
37 import jdk.javadoc.internal.doclets.formats.html.markup.Table;
38 import jdk.javadoc.internal.doclets.formats.html.markup.TableHeader;
39 import jdk.javadoc.internal.doclets.toolkit.AnnotationTypeRequiredMemberWriter;
40 import jdk.javadoc.internal.doclets.toolkit.Content;
41 import jdk.javadoc.internal.doclets.toolkit.MemberSummaryWriter;
42
43
44 /**
45 * Writes annotation type required member documentation in HTML format.
46 *
47 * <p><b>This is NOT part of any supported API.
48 * If you write code that depends on this, you do so at your own risk.
49 * This code and its internal interfaces are subject to change or
50 * deletion without notice.</b>
51 */
52 public class AnnotationTypeRequiredMemberWriterImpl extends AbstractMemberWriter
53 implements AnnotationTypeRequiredMemberWriter, MemberSummaryWriter {
54
55 /**
56 * Construct a new AnnotationTypeRequiredMemberWriterImpl.
57 *
58 * @param writer the writer that will write the output.
59 * @param annotationType the AnnotationType that holds this member.
60 */
61 public AnnotationTypeRequiredMemberWriterImpl(SubWriterHolderWriter writer,
62 TypeElement annotationType) {
63 super(writer, annotationType);
64 }
65
66 /**
67 * {@inheritDoc}
68 */
69 public Content getMemberSummaryHeader(TypeElement typeElement,
70 Content memberSummaryTree) {
71 memberSummaryTree.add(
72 MarkerComments.START_OF_ANNOTATION_TYPE_REQUIRED_MEMBER_SUMMARY);
73 Content memberTree = new ContentBuilder();
74 writer.addSummaryHeader(this, typeElement, memberTree);
75 return memberTree;
76 }
77
78 /**
79 * {@inheritDoc}
80 */
81 public Content getMemberTreeHeader() {
82 return writer.getMemberTreeHeader();
83 }
84
85 /**
86 * {@inheritDoc}
87 */
88 public void addMemberTree(Content memberSummaryTree, Content memberTree) {
89 writer.addMemberTree(HtmlStyle.memberSummary, memberSummaryTree, memberTree);
90 }
91
92 /**
93 * {@inheritDoc}
94 */
95 public void addAnnotationDetailsMarker(Content memberDetails) {
96 memberDetails.add(MarkerComments.START_OF_ANNOTATION_TYPE_DETAILS);
97 }
98
99 /**
100 * {@inheritDoc}
101 */
102 public Content getAnnotationDetailsTreeHeader(TypeElement te) {
103 Content memberDetailsTree = new ContentBuilder();
104 if (!writer.printedAnnotationHeading) {
105 Content heading = HtmlTree.HEADING(Headings.TypeDeclaration.DETAILS_HEADING,
106 contents.annotationTypeDetailsLabel);
107 memberDetailsTree.add(links.createAnchor(
108 SectionName.ANNOTATION_TYPE_ELEMENT_DETAIL));
109 memberDetailsTree.add(heading);
110 writer.printedAnnotationHeading = true;
111 }
112 return memberDetailsTree;
113 }
114
115 /**
116 * {@inheritDoc}
117 */
118 @Override
119 public Content getAnnotationDocTreeHeader(Element member, Content annotationDetailsTree) {
120 String simpleName = name(member);
121 Content annotationDocTree = new ContentBuilder();
122 Content heading = new HtmlTree(Headings.TypeDeclaration.MEMBER_HEADING);
123 heading.add(links.createAnchor(
124 simpleName + utils.signature((ExecutableElement) member), new StringContent(simpleName)));
125 annotationDocTree.add(heading);
126 return HtmlTree.SECTION(HtmlStyle.detail, annotationDocTree);
127 }
128
129 /**
130 * {@inheritDoc}
131 */
132 public Content getSignature(Element member) {
133 return new MemberSignature(member)
134 .addType(getType(member))
135 .toContent();
136 }
137
138 /**
139 * {@inheritDoc}
140 */
141 public void addDeprecated(Element member, Content annotationDocTree) {
142 addDeprecatedInfo(member, annotationDocTree);
143 }
144
145 /**
146 * {@inheritDoc}
147 */
148 public void addComments(Element member, Content annotationDocTree) {
149 addComment(member, annotationDocTree);
150 }
151
152 /**
153 * {@inheritDoc}
154 */
155 public void addTags(Element member, Content annotationDocTree) {
156 writer.addTagsInfo(member, annotationDocTree);
157 }
158
159 /**
160 * {@inheritDoc}
161 */
162 public Content getAnnotationDetails(Content annotationDetailsTreeHeader, Content annotationDetailsTree) {
163 Content annotationDetails = new ContentBuilder(annotationDetailsTreeHeader, annotationDetailsTree);
164 return getMemberTree(HtmlTree.SECTION(HtmlStyle.memberDetails, annotationDetails));
165 }
166
167 /**
168 * {@inheritDoc}
169 */
170 public Content getAnnotationDoc(Content annotationDocTree) {
171 return getMemberTree(annotationDocTree);
172 }
173
174 /**
175 * {@inheritDoc}
176 */
177 public void addSummaryLabel(Content memberTree) {
178 Content label = HtmlTree.HEADING(Headings.TypeDeclaration.SUMMARY_HEADING,
179 contents.annotateTypeRequiredMemberSummaryLabel);
180 memberTree.add(label);
181 }
182
183 /**
184 * Get the caption for the summary table.
185 * @return the caption
186 */
187 // Overridden by AnnotationTypeOptionalMemberWriterImpl
188 protected Content getCaption() {
189 return contents.getContent("doclet.Annotation_Type_Required_Members");
190 }
191
192 /**
193 * {@inheritDoc}
194 */
195 @Override
196 public TableHeader getSummaryTableHeader(Element member) {
197 return new TableHeader(contents.modifierAndTypeLabel,
198 contents.annotationTypeRequiredMemberLabel, contents.descriptionLabel);
199 }
200
201 /**
202 * {@inheritDoc}
203 */
204 @Override
205 protected Table createSummaryTable() {
206 return new Table(HtmlStyle.memberSummary)
207 .setCaption(getCaption())
208 .setHeader(getSummaryTableHeader(typeElement))
209 .setRowScopeColumn(1)
210 .setColumnStyles(HtmlStyle.colFirst, HtmlStyle.colSecond, HtmlStyle.colLast);
211 }
212
213 /**
214 * {@inheritDoc}
215 */
216 public void addSummaryAnchor(TypeElement typeElement, Content memberTree) {
217 memberTree.add(links.createAnchor(
218 SectionName.ANNOTATION_TYPE_REQUIRED_ELEMENT_SUMMARY));
219 }
220
221 /**
222 * {@inheritDoc}
223 */
224 public void addInheritedSummaryAnchor(TypeElement typeElement, Content inheritedTree) {
225 }
226
227 /**
228 * {@inheritDoc}
229 */
230 public void addInheritedSummaryLabel(TypeElement typeElement, Content inheritedTree) {
231 }
232
233 /**
234 * {@inheritDoc}
235 */
236 protected void addSummaryLink(LinkInfoImpl.Kind context, TypeElement typeElement, Element member,
237 Content tdSummary) {
238 Content memberLink = HtmlTree.SPAN(HtmlStyle.memberNameLink,
239 writer.getDocLink(context, member, name(member), false));
240 Content code = HtmlTree.CODE(memberLink);
241 tdSummary.add(code);
242 }
243
244 /**
245 * {@inheritDoc}
246 */
247 protected void addInheritedSummaryLink(TypeElement typeElement,
248 Element member, Content linksTree) {
249 //Not applicable.
250 }
251
252 /**
253 * {@inheritDoc}
254 */
255 protected void addSummaryType(Element member, Content tdSummaryType) {
256 addModifierAndType(member, getType(member), tdSummaryType);
257 }
258
259 /**
260 * {@inheritDoc}
261 */
262 protected Content getDeprecatedLink(Element member) {
263 String name = utils.getFullyQualifiedName(member) + "." + member.getSimpleName();
264 return writer.getDocLink(LinkInfoImpl.Kind.MEMBER, member, name);
265 }
266
267 private TypeMirror getType(Element member) {
268 return utils.isExecutableElement(member)
269 ? utils.getReturnType((ExecutableElement) member)
270 : member.asType();
271 }
272 }