langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/AnnotationTypeOptionalMemberWriterImpl.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/AnnotationTypeOptionalMemberWriterImpl.java Sat Nov 28 18:52:17 2015 -0800
@@ -0,0 +1,171 @@
+/*
+ * 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.io.*;
+
+import java.util.Arrays;
+import java.util.List;
+
+import javax.lang.model.element.AnnotationValue;
+import javax.lang.model.element.Element;
+import javax.lang.model.element.ExecutableElement;
+import javax.lang.model.element.TypeElement;
+
+import jdk.javadoc.internal.doclets.formats.html.markup.HtmlConstants;
+import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
+import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
+import jdk.javadoc.internal.doclets.toolkit.AnnotationTypeOptionalMemberWriter;
+import jdk.javadoc.internal.doclets.toolkit.Content;
+import jdk.javadoc.internal.doclets.toolkit.MemberSummaryWriter;
+
+
+/**
+ * Writes annotation type optional member 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 AnnotationTypeOptionalMemberWriterImpl extends
+ AnnotationTypeRequiredMemberWriterImpl
+ implements AnnotationTypeOptionalMemberWriter, MemberSummaryWriter {
+
+ /**
+ * Construct a new AnnotationTypeOptionalMemberWriterImpl.
+ *
+ * @param writer the writer that will write the output.
+ * @param annotationType the AnnotationType that holds this member.
+ */
+ public AnnotationTypeOptionalMemberWriterImpl(SubWriterHolderWriter writer,
+ TypeElement annotationType) {
+ super(writer, annotationType);
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public Content getMemberSummaryHeader(TypeElement typeElement,
+ Content memberSummaryTree) {
+ memberSummaryTree.addContent(
+ HtmlConstants.START_OF_ANNOTATION_TYPE_OPTIONAL_MEMBER_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}
+ */
+ public void addDefaultValueInfo(Element member, Content annotationDocTree) {
+ if (utils.isAnnotationType(member)) {
+ ExecutableElement ee = (ExecutableElement)member;
+ AnnotationValue value = ee.getDefaultValue();
+ if (value != null) {
+ Content dt = HtmlTree.DT(writer.getResource("doclet.Default"));
+ Content dl = HtmlTree.DL(dt);
+ Content dd = HtmlTree.DD(new StringContent(value.toString()));
+ dl.addContent(dd);
+ annotationDocTree.addContent(dl);
+ }
+ }
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public void close() throws IOException {
+ writer.close();
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public void addSummaryLabel(Content memberTree) {
+ Content label = HtmlTree.HEADING(HtmlConstants.SUMMARY_HEADING,
+ writer.getResource("doclet.Annotation_Type_Optional_Member_Summary"));
+ memberTree.addContent(label);
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public String getTableSummary() {
+ return configuration.getText("doclet.Member_Table_Summary",
+ configuration.getText("doclet.Annotation_Type_Optional_Member_Summary"),
+ configuration.getText("doclet.annotation_type_optional_members"));
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public Content getCaption() {
+ return configuration.getResource("doclet.Annotation_Type_Optional_Members");
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public List<String> getSummaryTableHeader(Element member) {
+ List<String> header = Arrays.asList(writer.getModifierTypeHeader(),
+ configuration.getText("doclet.0_and_1",
+ configuration.getText("doclet.Annotation_Type_Optional_Member"),
+ configuration.getText("doclet.Description")));
+ return header;
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public void addSummaryAnchor(TypeElement typeElement, Content memberTree) {
+ memberTree.addContent(writer.getMarkerAnchor(
+ SectionName.ANNOTATION_TYPE_OPTIONAL_ELEMENT_SUMMARY));
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ protected Content getNavSummaryLink(TypeElement typeElement, boolean link) {
+ if (link) {
+ return writer.getHyperLink(
+ SectionName.ANNOTATION_TYPE_OPTIONAL_ELEMENT_SUMMARY,
+ writer.getResource("doclet.navAnnotationTypeOptionalMember"));
+ } else {
+ return writer.getResource("doclet.navAnnotationTypeOptionalMember");
+ }
+ }
+}