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 29 import javax.lang.model.element.Element; 30 import javax.lang.model.element.TypeElement; 31 import javax.lang.model.element.VariableElement; 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.Table; 37 import jdk.javadoc.internal.doclets.formats.html.markup.TableHeader; 38 import jdk.javadoc.internal.doclets.toolkit.Content; 39 import jdk.javadoc.internal.doclets.toolkit.EnumConstantWriter; 40 import jdk.javadoc.internal.doclets.toolkit.MemberSummaryWriter; 41 42 /** 43 * Writes enum constant documentation in HTML format. 44 * 45 * <p><b>This is NOT part of any supported API. 46 * If you write code that depends on this, you do so at your own risk. 47 * This code and its internal interfaces are subject to change or 48 * deletion without notice.</b> 49 * 50 * @author Jamie Ho 51 * @author Bhavesh Patel (Modified) 52 */ 53 public class EnumConstantWriterImpl extends AbstractMemberWriter 54 implements EnumConstantWriter, MemberSummaryWriter { 55 56 public EnumConstantWriterImpl(SubWriterHolderWriter writer, TypeElement typeElement) { 57 super(writer, typeElement); 58 } 59 60 public EnumConstantWriterImpl(SubWriterHolderWriter writer) { 61 super(writer); 62 } 63 64 /** 65 * {@inheritDoc} 66 */ 67 @Override 68 public Content getMemberSummaryHeader(TypeElement typeElement, 69 Content memberSummaryTree) { 70 memberSummaryTree.add(MarkerComments.START_OF_ENUM_CONSTANT_SUMMARY); 71 Content memberTree = new ContentBuilder(); 72 writer.addSummaryHeader(this, typeElement, memberTree); 73 return memberTree; 74 } 75 76 /** 77 * {@inheritDoc} 78 */ 79 @Override 80 public void addMemberTree(Content memberSummaryTree, Content memberTree) { 81 writer.addMemberTree(HtmlStyle.constantsSummary, memberSummaryTree, memberTree); 82 } 83 84 /** 85 * {@inheritDoc} 86 */ 87 @Override 88 public Content getEnumConstantsDetailsTreeHeader(TypeElement typeElement, 89 Content memberDetailsTree) { 90 memberDetailsTree.add(MarkerComments.START_OF_ENUM_CONSTANT_DETAILS); 91 Content enumConstantsDetailsTree = new ContentBuilder(); 92 Content heading = HtmlTree.HEADING(Headings.TypeDeclaration.DETAILS_HEADING, 93 contents.enumConstantDetailLabel); 94 enumConstantsDetailsTree.add(heading); 95 enumConstantsDetailsTree.add(links.createAnchor( 96 SectionName.ENUM_CONSTANT_DETAIL)); 97 return enumConstantsDetailsTree; 98 } 99 100 /** 101 * {@inheritDoc} 102 */ 103 @Override 104 public Content getEnumConstantsTreeHeader(VariableElement enumConstant, 105 Content enumConstantsDetailsTree) { 106 Content enumConstantsTree = new ContentBuilder(); 107 Content heading = new HtmlTree(Headings.TypeDeclaration.MEMBER_HEADING); 108 heading.add(name(enumConstant)); 109 enumConstantsTree.add(heading); 110 enumConstantsTree.add(links.createAnchor(name(enumConstant))); 111 return HtmlTree.SECTION(HtmlStyle.detail, enumConstantsTree); 112 } 113 114 /** 115 * {@inheritDoc} 116 */ 117 @Override 118 public Content getSignature(VariableElement enumConstant) { 119 return new MemberSignature(enumConstant) 120 .addType(enumConstant.asType()) 121 .toContent(); 122 } 123 124 /** 125 * {@inheritDoc} 126 */ 127 @Override 128 public void addDeprecated(VariableElement enumConstant, Content enumConstantsTree) { 129 addDeprecatedInfo(enumConstant, enumConstantsTree); 130 } 131 132 /** 133 * {@inheritDoc} 134 */ 135 @Override 136 public void addComments(VariableElement enumConstant, Content enumConstantsTree) { 137 addComment(enumConstant, enumConstantsTree); 138 } 139 140 /** 141 * {@inheritDoc} 142 */ 143 @Override 144 public void addTags(VariableElement enumConstant, Content enumConstantsTree) { 145 writer.addTagsInfo(enumConstant, enumConstantsTree); 146 } 147 148 /** 149 * {@inheritDoc} 150 */ 151 @Override 152 public Content getEnumConstantsDetails(Content enumConstantsDetailsTreeHeader, 153 Content enumConstantsDetailsTree) { 154 Content enumConstantsDetails = 155 new ContentBuilder(enumConstantsDetailsTreeHeader, enumConstantsDetailsTree); 156 return getMemberTree(HtmlTree.SECTION(HtmlStyle.constantDetails, enumConstantsDetails)); 157 } 158 159 /** 160 * {@inheritDoc} 161 */ 162 @Override 163 public Content getEnumConstants(Content enumConstantsTree, 164 boolean isLastContent) { 165 return getMemberTree(enumConstantsTree, isLastContent); 166 } 167 168 /** 169 * {@inheritDoc} 170 */ 171 @Override 172 public void addSummaryLabel(Content memberTree) { 173 Content label = HtmlTree.HEADING(Headings.TypeDeclaration.SUMMARY_HEADING, 174 contents.enumConstantSummary); 175 memberTree.add(label); 176 } 177 178 /** 179 * {@inheritDoc} 180 */ 181 @Override 182 public TableHeader getSummaryTableHeader(Element member) { 183 return new TableHeader(contents.enumConstantLabel, contents.descriptionLabel); 184 } 185 186 /** 187 * {@inheritDoc} 188 */ 189 @Override 190 protected Table createSummaryTable() { 191 return new Table(HtmlStyle.memberSummary) 192 .setCaption(contents.getContent("doclet.Enum_Constants")) 193 .setHeader(getSummaryTableHeader(typeElement)) 194 .setColumnStyles(HtmlStyle.colFirst, HtmlStyle.colLast); 195 } 196 197 /** 198 * {@inheritDoc} 199 */ 200 @Override 201 public void addSummaryAnchor(TypeElement typeElement, Content memberTree) { 202 memberTree.add(links.createAnchor(SectionName.ENUM_CONSTANT_SUMMARY)); 203 } 204 205 /** 206 * {@inheritDoc} 207 */ 208 @Override 209 public void addInheritedSummaryAnchor(TypeElement typeElement, Content inheritedTree) { 210 } 211 212 /** 213 * {@inheritDoc} 214 */ 215 @Override 216 public void addInheritedSummaryLabel(TypeElement typeElement, Content inheritedTree) { 217 } 218 219 /** 220 * {@inheritDoc} 221 */ 222 @Override 223 protected void addSummaryLink(LinkInfoImpl.Kind context, TypeElement typeElement, Element member, 224 Content tdSummary) { 225 Content memberLink = HtmlTree.SPAN(HtmlStyle.memberNameLink, 226 writer.getDocLink(context, member, name(member), false)); 227 Content code = HtmlTree.CODE(memberLink); 228 tdSummary.add(code); 229 } 230 231 /** 232 * {@inheritDoc} 233 */ 234 @Override 235 protected void addInheritedSummaryLink(TypeElement typeElement, Element member, Content linksTree) { 236 } 237 238 /** 239 * {@inheritDoc} 240 */ 241 @Override 242 protected void addSummaryType(Element member, Content tdSummaryType) { 243 //Not applicable. 244 } 245 246 /** 247 * {@inheritDoc} 248 */ 249 @Override 250 protected Content getDeprecatedLink(Element member) { 251 String name = utils.getFullyQualifiedName(member) + "." + member.getSimpleName(); 252 return writer.getDocLink(LinkInfoImpl.Kind.MEMBER, member, name); 253 } 254 255 @Override 256 public Content getMemberTreeHeader(){ 257 return writer.getMemberTreeHeader(); 258 } 259 }