• file
• revisions
• annotate
• diff
• comparison
• raw

src/share/classes/com/sun/tools/doclets/formats/html/AnnotationTypeOptionalMemberWriterImpl.java@93012e2a5d1d (annotated)

src/share/classes/com/sun/tools/doclets/formats/html/AnnotationTypeOptionalMemberWriterImpl.java

Sat, 07 Nov 2020 10:30:02 +0800

author

aoqi

date

Sat, 07 Nov 2020 10:30:02 +0800

changeset 3938

93012e2a5d1d

parent 2525

2eb010b6cb22

permissions

-rw-r--r--

Added tag mips-jdk8u275-b01 for changeset eb6ee6a5f2fe

aoqi@0	1	/*
aoqi@0	2	* Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved.
aoqi@0	3	* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0	4	*
aoqi@0	5	* This code is free software; you can redistribute it and/or modify it
aoqi@0	6	* under the terms of the GNU General Public License version 2 only, as
aoqi@0	7	* published by the Free Software Foundation. Oracle designates this
aoqi@0	8	* particular file as subject to the "Classpath" exception as provided
aoqi@0	9	* by Oracle in the LICENSE file that accompanied this code.
aoqi@0	10	*
aoqi@0	11	* This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0	12	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0	13	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
aoqi@0	14	* version 2 for more details (a copy is included in the LICENSE file that
aoqi@0	15	* accompanied this code).
aoqi@0	16	*
aoqi@0	17	* You should have received a copy of the GNU General Public License version
aoqi@0	18	* 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0	19	* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0	20	*
aoqi@0	21	* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0	22	* or visit www.oracle.com if you need additional information or have any
aoqi@0	23	* questions.
aoqi@0	24	*/
aoqi@0	25
aoqi@0	26	package com.sun.tools.doclets.formats.html;
aoqi@0	27
aoqi@0	28	import java.io.*;
aoqi@0	29
aoqi@0	30	import com.sun.javadoc.*;
aoqi@0	31	import com.sun.tools.doclets.formats.html.markup.*;
aoqi@0	32	import com.sun.tools.doclets.internal.toolkit.*;
aoqi@0	33
aoqi@0	34	/**
aoqi@0	35	* Writes annotation type optional member documentation in HTML format.
aoqi@0	36	*
aoqi@0	37	* <p><b>This is NOT part of any supported API.
aoqi@0	38	* If you write code that depends on this, you do so at your own risk.
aoqi@0	39	* This code and its internal interfaces are subject to change or
aoqi@0	40	* deletion without notice.</b>
aoqi@0	41	*
aoqi@0	42	* @author Jamie Ho
aoqi@0	43	* @author Bhavesh Patel (Modified)
aoqi@0	44	*/
aoqi@0	45	public class AnnotationTypeOptionalMemberWriterImpl extends
aoqi@0	46	AnnotationTypeRequiredMemberWriterImpl
aoqi@0	47	implements AnnotationTypeOptionalMemberWriter, MemberSummaryWriter {
aoqi@0	48
aoqi@0	49	/**
aoqi@0	50	* Construct a new AnnotationTypeOptionalMemberWriterImpl.
aoqi@0	51	*
aoqi@0	52	* @param writer the writer that will write the output.
aoqi@0	53	* @param annotationType the AnnotationType that holds this member.
aoqi@0	54	*/
aoqi@0	55	public AnnotationTypeOptionalMemberWriterImpl(SubWriterHolderWriter writer,
aoqi@0	56	AnnotationTypeDoc annotationType) {
aoqi@0	57	super(writer, annotationType);
aoqi@0	58	}
aoqi@0	59
aoqi@0	60	/**
aoqi@0	61	* {@inheritDoc}
aoqi@0	62	*/
aoqi@0	63	public Content getMemberSummaryHeader(ClassDoc classDoc,
aoqi@0	64	Content memberSummaryTree) {
aoqi@0	65	memberSummaryTree.addContent(
aoqi@0	66	HtmlConstants.START_OF_ANNOTATION_TYPE_OPTIONAL_MEMBER_SUMMARY);
aoqi@0	67	Content memberTree = writer.getMemberTreeHeader();
aoqi@0	68	writer.addSummaryHeader(this, classDoc, memberTree);
aoqi@0	69	return memberTree;
aoqi@0	70	}
aoqi@0	71
aoqi@0	72	/**
aoqi@0	73	* {@inheritDoc}
aoqi@0	74	*/
aoqi@0	75	public void addDefaultValueInfo(MemberDoc member, Content annotationDocTree) {
aoqi@0	76	if (((AnnotationTypeElementDoc) member).defaultValue() != null) {
aoqi@0	77	Content dt = HtmlTree.DT(writer.getResource("doclet.Default"));
aoqi@0	78	Content dl = HtmlTree.DL(dt);
aoqi@0	79	Content dd = HtmlTree.DD(new StringContent(
aoqi@0	80	((AnnotationTypeElementDoc) member).defaultValue().toString()));
aoqi@0	81	dl.addContent(dd);
aoqi@0	82	annotationDocTree.addContent(dl);
aoqi@0	83	}
aoqi@0	84	}
aoqi@0	85
aoqi@0	86	/**
aoqi@0	87	* {@inheritDoc}
aoqi@0	88	*/
aoqi@0	89	public void close() throws IOException {
aoqi@0	90	writer.close();
aoqi@0	91	}
aoqi@0	92
aoqi@0	93	/**
aoqi@0	94	* {@inheritDoc}
aoqi@0	95	*/
aoqi@0	96	public void addSummaryLabel(Content memberTree) {
aoqi@0	97	Content label = HtmlTree.HEADING(HtmlConstants.SUMMARY_HEADING,
aoqi@0	98	writer.getResource("doclet.Annotation_Type_Optional_Member_Summary"));
aoqi@0	99	memberTree.addContent(label);
aoqi@0	100	}
aoqi@0	101
aoqi@0	102	/**
aoqi@0	103	* {@inheritDoc}
aoqi@0	104	*/
aoqi@0	105	public String getTableSummary() {
aoqi@0	106	return configuration.getText("doclet.Member_Table_Summary",
aoqi@0	107	configuration.getText("doclet.Annotation_Type_Optional_Member_Summary"),
aoqi@0	108	configuration.getText("doclet.annotation_type_optional_members"));
aoqi@0	109	}
aoqi@0	110
aoqi@0	111	/**
aoqi@0	112	* {@inheritDoc}
aoqi@0	113	*/
aoqi@0	114	public Content getCaption() {
aoqi@0	115	return configuration.getResource("doclet.Annotation_Type_Optional_Members");
aoqi@0	116	}
aoqi@0	117
aoqi@0	118	/**
aoqi@0	119	* {@inheritDoc}
aoqi@0	120	*/
aoqi@0	121	public String[] getSummaryTableHeader(ProgramElementDoc member) {
aoqi@0	122	String[] header = new String[] {
aoqi@0	123	writer.getModifierTypeHeader(),
aoqi@0	124	configuration.getText("doclet.0_and_1",
aoqi@0	125	configuration.getText("doclet.Annotation_Type_Optional_Member"),
aoqi@0	126	configuration.getText("doclet.Description"))
aoqi@0	127	};
aoqi@0	128	return header;
aoqi@0	129	}
aoqi@0	130
aoqi@0	131	/**
aoqi@0	132	* {@inheritDoc}
aoqi@0	133	*/
aoqi@0	134	public void addSummaryAnchor(ClassDoc cd, Content memberTree) {
aoqi@0	135	memberTree.addContent(writer.getMarkerAnchor(
aoqi@0	136	SectionName.ANNOTATION_TYPE_OPTIONAL_ELEMENT_SUMMARY));
aoqi@0	137	}
aoqi@0	138
aoqi@0	139	/**
aoqi@0	140	* {@inheritDoc}
aoqi@0	141	*/
aoqi@0	142	protected Content getNavSummaryLink(ClassDoc cd, boolean link) {
aoqi@0	143	if (link) {
aoqi@0	144	return writer.getHyperLink(
aoqi@0	145	SectionName.ANNOTATION_TYPE_OPTIONAL_ELEMENT_SUMMARY,
aoqi@0	146	writer.getResource("doclet.navAnnotationTypeOptionalMember"));
aoqi@0	147	} else {
aoqi@0	148	return writer.getResource("doclet.navAnnotationTypeOptionalMember");
aoqi@0	149	}
aoqi@0	150	}
aoqi@0	151	}