/*
* Copyright (c) 1998, 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 javax.lang.model.element.ExecutableElement;
import javax.lang.model.element.TypeElement;
import jdk.javadoc.internal.doclets.formats.html.markup.ContentBuilder;
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.SerializedFormWriter;
import jdk.javadoc.internal.doclets.toolkit.taglets.TagletManager;
import jdk.javadoc.internal.doclets.toolkit.taglets.TagletWriter;
/**
* Generate serialized form for Serializable/Externalizable methods.
* Documentation denoted by the serialData
tag is processed.
*
*
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. * * @author Joe Fialli * @author Bhavesh Patel (Modified) */ public class HtmlSerialMethodWriter extends MethodWriterImpl implements SerializedFormWriter.SerialMethodWriter{ public HtmlSerialMethodWriter(SubWriterHolderWriter writer, TypeElement typeElement) { super(writer, typeElement); } /** * Return the header for serializable methods section. * * @return a content tree for the header */ public Content getSerializableMethodsHeader() { HtmlTree ul = new HtmlTree(HtmlTag.UL); ul.addStyle(HtmlStyle.blockList); return ul; } /** * Return the header for serializable methods content section. * * @param isLastContent true if the cotent being documented is the last content. * @return a content tree for the header */ public Content getMethodsContentHeader(boolean isLastContent) { HtmlTree li = new HtmlTree(HtmlTag.LI); if (isLastContent) li.addStyle(HtmlStyle.blockListLast); else li.addStyle(HtmlStyle.blockList); return li; } /** * Add serializable methods. * * @param heading the heading for the section * @param serializableMethodContent the tree to be added to the serializable methods * content tree * @return a content tree for the serializable methods content */ public Content getSerializableMethods(String heading, Content serializableMethodContent) { Content headingContent = new StringContent(heading); Content serialHeading = HtmlTree.HEADING(HtmlConstants.SERIALIZED_MEMBER_HEADING, headingContent); Content li = HtmlTree.LI(HtmlStyle.blockList, serialHeading); li.addContent(serializableMethodContent); return li; } /** * Return the no customization message. * * @param msg the message to be displayed * @return no customization message content */ public Content getNoCustomizationMsg(String msg) { Content noCustomizationMsg = new StringContent(msg); return noCustomizationMsg; } /** * Add the member header. * * @param member the method document to be listed * @param methodsContentTree the content tree to which the member header will be added */ public void addMemberHeader(ExecutableElement member, Content methodsContentTree) { methodsContentTree.addContent(getHead(member)); methodsContentTree.addContent(getSignature(member)); } /** * Add the deprecated information for this member. * * @param member the method to document. * @param methodsContentTree the tree to which the deprecated info will be added */ public void addDeprecatedMemberInfo(ExecutableElement member, Content methodsContentTree) { addDeprecatedInfo(member, methodsContentTree); } /** * Add the description text for this member. * * @param member the method to document. * @param methodsContentTree the tree to which the deprecated info will be added */ public void addMemberDescription(ExecutableElement member, Content methodsContentTree) { addComment(member, methodsContentTree); } /** * Add the tag information for this member. * * @param member the method to document. * @param methodsContentTree the tree to which the member tags info will be added */ public void addMemberTags(ExecutableElement member, Content methodsContentTree) { Content tagContent = new ContentBuilder(); TagletManager tagletManager = configuration.tagletManager; TagletWriter.genTagOutput(tagletManager, member, tagletManager.getSerializedFormTaglets(), writer.getTagletWriterInstance(false), tagContent); Content dlTags = new HtmlTree(HtmlTag.DL); dlTags.addContent(tagContent); methodsContentTree.addContent(dlTags); if (name(member).compareTo("writeExternal") == 0 && utils.getSerialDataTrees(member).isEmpty()) { serialWarning(member, "doclet.MissingSerialDataTag", utils.getFullyQualifiedName(member.getEnclosingElement()), name(member)); } } }