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

src/share/classes/com/sun/tools/doclets/formats/html/HtmlSerialMethodWriter.java@e468915bad3a (annotated)

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

Thu, 24 May 2018 18:02:46 +0800

author

aoqi

date

Thu, 24 May 2018 18:02:46 +0800

changeset 3446

e468915bad3a

parent 2525

2eb010b6cb22

permissions

-rw-r--r--

Merge

aoqi@0	1	/*
aoqi@0	2	* Copyright (c) 1998, 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 com.sun.javadoc.*;
aoqi@0	29	import com.sun.tools.doclets.formats.html.markup.*;
aoqi@0	30	import com.sun.tools.doclets.internal.toolkit.*;
aoqi@0	31	import com.sun.tools.doclets.internal.toolkit.taglets.*;
aoqi@0	32
aoqi@0	33	/**
aoqi@0	34	* Generate serialized form for Serializable/Externalizable methods.
aoqi@0	35	* Documentation denoted by the <code>serialData</code> tag is processed.
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 Joe Fialli
aoqi@0	43	* @author Bhavesh Patel (Modified)
aoqi@0	44	*/
aoqi@0	45	public class HtmlSerialMethodWriter extends MethodWriterImpl implements
aoqi@0	46	SerializedFormWriter.SerialMethodWriter{
aoqi@0	47
aoqi@0	48	public HtmlSerialMethodWriter(SubWriterHolderWriter writer,
aoqi@0	49	ClassDoc classdoc) {
aoqi@0	50	super(writer, classdoc);
aoqi@0	51	}
aoqi@0	52
aoqi@0	53	/**
aoqi@0	54	* Return the header for serializable methods section.
aoqi@0	55	*
aoqi@0	56	* @return a content tree for the header
aoqi@0	57	*/
aoqi@0	58	public Content getSerializableMethodsHeader() {
aoqi@0	59	HtmlTree ul = new HtmlTree(HtmlTag.UL);
aoqi@0	60	ul.addStyle(HtmlStyle.blockList);
aoqi@0	61	return ul;
aoqi@0	62	}
aoqi@0	63
aoqi@0	64	/**
aoqi@0	65	* Return the header for serializable methods content section.
aoqi@0	66	*
aoqi@0	67	* @param isLastContent true if the cotent being documented is the last content.
aoqi@0	68	* @return a content tree for the header
aoqi@0	69	*/
aoqi@0	70	public Content getMethodsContentHeader(boolean isLastContent) {
aoqi@0	71	HtmlTree li = new HtmlTree(HtmlTag.LI);
aoqi@0	72	if (isLastContent)
aoqi@0	73	li.addStyle(HtmlStyle.blockListLast);
aoqi@0	74	else
aoqi@0	75	li.addStyle(HtmlStyle.blockList);
aoqi@0	76	return li;
aoqi@0	77	}
aoqi@0	78
aoqi@0	79	/**
aoqi@0	80	* Add serializable methods.
aoqi@0	81	*
aoqi@0	82	* @param heading the heading for the section
aoqi@0	83	* @param serializableMethodContent the tree to be added to the serializable methods
aoqi@0	84	* content tree
aoqi@0	85	* @return a content tree for the serializable methods content
aoqi@0	86	*/
aoqi@0	87	public Content getSerializableMethods(String heading, Content serializableMethodContent) {
aoqi@0	88	Content headingContent = new StringContent(heading);
aoqi@0	89	Content serialHeading = HtmlTree.HEADING(HtmlConstants.SERIALIZED_MEMBER_HEADING,
aoqi@0	90	headingContent);
aoqi@0	91	Content li = HtmlTree.LI(HtmlStyle.blockList, serialHeading);
aoqi@0	92	li.addContent(serializableMethodContent);
aoqi@0	93	return li;
aoqi@0	94	}
aoqi@0	95
aoqi@0	96	/**
aoqi@0	97	* Return the no customization message.
aoqi@0	98	*
aoqi@0	99	* @param msg the message to be displayed
aoqi@0	100	* @return no customization message content
aoqi@0	101	*/
aoqi@0	102	public Content getNoCustomizationMsg(String msg) {
aoqi@0	103	Content noCustomizationMsg = new StringContent(msg);
aoqi@0	104	return noCustomizationMsg;
aoqi@0	105	}
aoqi@0	106
aoqi@0	107	/**
aoqi@0	108	* Add the member header.
aoqi@0	109	*
aoqi@0	110	* @param member the method document to be listed
aoqi@0	111	* @param methodsContentTree the content tree to which the member header will be added
aoqi@0	112	*/
aoqi@0	113	public void addMemberHeader(MethodDoc member, Content methodsContentTree) {
aoqi@0	114	methodsContentTree.addContent(getHead(member));
aoqi@0	115	methodsContentTree.addContent(getSignature(member));
aoqi@0	116	}
aoqi@0	117
aoqi@0	118	/**
aoqi@0	119	* Add the deprecated information for this member.
aoqi@0	120	*
aoqi@0	121	* @param member the method to document.
aoqi@0	122	* @param methodsContentTree the tree to which the deprecated info will be added
aoqi@0	123	*/
aoqi@0	124	public void addDeprecatedMemberInfo(MethodDoc member, Content methodsContentTree) {
aoqi@0	125	addDeprecatedInfo(member, methodsContentTree);
aoqi@0	126	}
aoqi@0	127
aoqi@0	128	/**
aoqi@0	129	* Add the description text for this member.
aoqi@0	130	*
aoqi@0	131	* @param member the method to document.
aoqi@0	132	* @param methodsContentTree the tree to which the deprecated info will be added
aoqi@0	133	*/
aoqi@0	134	public void addMemberDescription(MethodDoc member, Content methodsContentTree) {
aoqi@0	135	addComment(member, methodsContentTree);
aoqi@0	136	}
aoqi@0	137
aoqi@0	138	/**
aoqi@0	139	* Add the tag information for this member.
aoqi@0	140	*
aoqi@0	141	* @param member the method to document.
aoqi@0	142	* @param methodsContentTree the tree to which the member tags info will be added
aoqi@0	143	*/
aoqi@0	144	public void addMemberTags(MethodDoc member, Content methodsContentTree) {
aoqi@0	145	Content tagContent = new ContentBuilder();
aoqi@0	146	TagletManager tagletManager =
aoqi@0	147	configuration.tagletManager;
aoqi@0	148	TagletWriter.genTagOuput(tagletManager, member,
aoqi@0	149	tagletManager.getSerializedFormTaglets(),
aoqi@0	150	writer.getTagletWriterInstance(false), tagContent);
aoqi@0	151	Content dlTags = new HtmlTree(HtmlTag.DL);
aoqi@0	152	dlTags.addContent(tagContent);
aoqi@0	153	methodsContentTree.addContent(dlTags); // TODO: what if empty?
aoqi@0	154	MethodDoc method = member;
aoqi@0	155	if (method.name().compareTo("writeExternal") == 0
aoqi@0	156	&& method.tags("serialData").length == 0) {
aoqi@0	157	serialWarning(member.position(), "doclet.MissingSerialDataTag",
aoqi@0	158	method.containingClass().qualifiedName(), method.name());
aoqi@0	159	}
aoqi@0	160	}
aoqi@0	161	}