--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/EnumConstantWriterImpl.java Tue Sep 12 19:03:39 2017 +0200
@@ -0,0 +1,322 @@
+/*
+ * 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. 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 jdk.javadoc.internal.doclets.formats.html;
+
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.List;
+
+import javax.lang.model.element.Element;
+import javax.lang.model.element.TypeElement;
+import javax.lang.model.element.VariableElement;
+
+import jdk.javadoc.internal.doclets.formats.html.markup.HtmlAttr;
+import jdk.javadoc.internal.doclets.formats.html.markup.HtmlConstants;
+import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;
+import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTag;
+import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
+import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
+import jdk.javadoc.internal.doclets.toolkit.Content;
+import jdk.javadoc.internal.doclets.toolkit.EnumConstantWriter;
+import jdk.javadoc.internal.doclets.toolkit.MemberSummaryWriter;
+
+/**
+ * Writes enum constant documentation in HTML format.
+ *
+ * <p><b>This is NOT part of any supported API.
+ * If you write code that depends on this, you do so at your own risk.
+ * This code and its internal interfaces are subject to change or
+ * deletion without notice.</b>
+ *
+ * @author Jamie Ho
+ * @author Bhavesh Patel (Modified)
+ */
+public class EnumConstantWriterImpl extends AbstractMemberWriter
+ implements EnumConstantWriter, MemberSummaryWriter {
+
+ public EnumConstantWriterImpl(SubWriterHolderWriter writer, TypeElement typeElement) {
+ super(writer, typeElement);
+ }
+
+ public EnumConstantWriterImpl(SubWriterHolderWriter writer) {
+ super(writer);
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ @Override
+ public Content getMemberSummaryHeader(TypeElement typeElement,
+ Content memberSummaryTree) {
+ memberSummaryTree.addContent(HtmlConstants.START_OF_ENUM_CONSTANT_SUMMARY);
+ Content memberTree = writer.getMemberTreeHeader();
+ writer.addSummaryHeader(this, typeElement, memberTree);
+ return memberTree;
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public void addMemberTree(Content memberSummaryTree, Content memberTree) {
+ writer.addMemberTree(memberSummaryTree, memberTree);
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ @Override
+ public Content getEnumConstantsDetailsTreeHeader(TypeElement typeElement,
+ Content memberDetailsTree) {
+ memberDetailsTree.addContent(HtmlConstants.START_OF_ENUM_CONSTANT_DETAILS);
+ Content enumConstantsDetailsTree = writer.getMemberTreeHeader();
+ enumConstantsDetailsTree.addContent(writer.getMarkerAnchor(
+ SectionName.ENUM_CONSTANT_DETAIL));
+ Content heading = HtmlTree.HEADING(HtmlConstants.DETAILS_HEADING,
+ contents.enumConstantDetailLabel);
+ enumConstantsDetailsTree.addContent(heading);
+ return enumConstantsDetailsTree;
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ @Override
+ public Content getEnumConstantsTreeHeader(VariableElement enumConstant,
+ Content enumConstantsDetailsTree) {
+ enumConstantsDetailsTree.addContent(
+ writer.getMarkerAnchor(name(enumConstant)));
+ Content enumConstantsTree = writer.getMemberTreeHeader();
+ Content heading = new HtmlTree(HtmlConstants.MEMBER_HEADING);
+ heading.addContent(name(enumConstant));
+ enumConstantsTree.addContent(heading);
+ return enumConstantsTree;
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ @Override
+ public Content getSignature(VariableElement enumConstant) {
+ Content pre = new HtmlTree(HtmlTag.PRE);
+ writer.addAnnotationInfo(enumConstant, pre);
+ addModifiers(enumConstant, pre);
+ Content enumConstantLink = writer.getLink(new LinkInfoImpl(
+ configuration, LinkInfoImpl.Kind.MEMBER, enumConstant.asType()));
+ pre.addContent(enumConstantLink);
+ pre.addContent(" ");
+ if (configuration.linksource) {
+ Content enumConstantName = new StringContent(name(enumConstant));
+ writer.addSrcLink(enumConstant, enumConstantName, pre);
+ } else {
+ addName(name(enumConstant), pre);
+ }
+ return pre;
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ @Override
+ public void addDeprecated(VariableElement enumConstant, Content enumConstantsTree) {
+ addDeprecatedInfo(enumConstant, enumConstantsTree);
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ @Override
+ public void addComments(VariableElement enumConstant, Content enumConstantsTree) {
+ addComment(enumConstant, enumConstantsTree);
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ @Override
+ public void addTags(VariableElement enumConstant, Content enumConstantsTree) {
+ writer.addTagsInfo(enumConstant, enumConstantsTree);
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ @Override
+ public Content getEnumConstantsDetails(Content enumConstantsDetailsTree) {
+ if (configuration.allowTag(HtmlTag.SECTION)) {
+ HtmlTree htmlTree = HtmlTree.SECTION(getMemberTree(enumConstantsDetailsTree));
+ return htmlTree;
+ }
+ return getMemberTree(enumConstantsDetailsTree);
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ @Override
+ public Content getEnumConstants(Content enumConstantsTree,
+ boolean isLastContent) {
+ return getMemberTree(enumConstantsTree, isLastContent);
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ @Override
+ public void addSummaryLabel(Content memberTree) {
+ Content label = HtmlTree.HEADING(HtmlConstants.SUMMARY_HEADING,
+ contents.enumConstantSummary);
+ memberTree.addContent(label);
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ @Override
+ public String getTableSummary() {
+ return resources.getText("doclet.Member_Table_Summary",
+ resources.getText("doclet.Enum_Constant_Summary"),
+ resources.getText("doclet.enum_constants"));
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ @Override
+ public Content getCaption() {
+ return configuration.getContent("doclet.Enum_Constants");
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ @Override
+ public List<String> getSummaryTableHeader(Element member) {
+ List<String> header = Arrays.asList(resources.getText("doclet.Enum_Constant"),
+ resources.getText("doclet.Description"));
+ return header;
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ @Override
+ public void addSummaryAnchor(TypeElement typeElement, Content memberTree) {
+ memberTree.addContent(writer.getMarkerAnchor(
+ SectionName.ENUM_CONSTANT_SUMMARY));
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ @Override
+ public void addInheritedSummaryAnchor(TypeElement typeElement, Content inheritedTree) {
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ @Override
+ public void addInheritedSummaryLabel(TypeElement typeElement, Content inheritedTree) {
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ @Override
+ protected void addSummaryLink(LinkInfoImpl.Kind context, TypeElement typeElement, Element member,
+ Content tdSummary) {
+ Content memberLink = HtmlTree.SPAN(HtmlStyle.memberNameLink,
+ writer.getDocLink(context, member, name(member), false));
+ Content code = HtmlTree.CODE(memberLink);
+ tdSummary.addContent(code);
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ @Override
+ public void setSummaryColumnStyleAndScope(HtmlTree thTree) {
+ thTree.addStyle(HtmlStyle.colFirst);
+ thTree.addAttr(HtmlAttr.SCOPE, "row");
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ @Override
+ protected void addInheritedSummaryLink(TypeElement typeElement, Element member, Content linksTree) {
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ @Override
+ protected void addSummaryType(Element member, Content tdSummaryType) {
+ //Not applicable.
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ @Override
+ protected Content getDeprecatedLink(Element member) {
+ String name = utils.getFullyQualifiedName(member) + "." + member.getSimpleName();
+ return writer.getDocLink(LinkInfoImpl.Kind.MEMBER, member, name);
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ @Override
+ protected Content getNavSummaryLink(TypeElement typeElement, boolean link) {
+ if (link) {
+ if (typeElement == null) {
+ return writer.getHyperLink(SectionName.ENUM_CONSTANT_SUMMARY,
+ contents.navEnum);
+ } else {
+ return writer.getHyperLink(
+ SectionName.ENUM_CONSTANTS_INHERITANCE,
+ configuration.getClassName(typeElement), contents.navEnum);
+ }
+ } else {
+ return contents.navEnum;
+ }
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ @Override
+ protected void addNavDetailLink(boolean link, Content liNav) {
+ if (link) {
+ liNav.addContent(writer.getHyperLink(
+ SectionName.ENUM_CONSTANT_DETAIL,
+ contents.navEnum));
+ } else {
+ liNav.addContent(contents.navEnum);
+ }
+ }
+}