duke@1: /*
duke@1:  * Copyright 1998-2003 Sun Microsystems, Inc.  All Rights Reserved.
duke@1:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1:  *
duke@1:  * This code is free software; you can redistribute it and/or modify it
duke@1:  * under the terms of the GNU General Public License version 2 only, as
duke@1:  * published by the Free Software Foundation.  Sun designates this
duke@1:  * particular file as subject to the "Classpath" exception as provided
duke@1:  * by Sun in the LICENSE file that accompanied this code.
duke@1:  *
duke@1:  * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
duke@1:  * version 2 for more details (a copy is included in the LICENSE file that
duke@1:  * accompanied this code).
duke@1:  *
duke@1:  * You should have received a copy of the GNU General Public License version
duke@1:  * 2 along with this work; if not, write to the Free Software Foundation,
duke@1:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1:  *
duke@1:  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
duke@1:  * CA 95054 USA or visit www.sun.com if you need additional information or
duke@1:  * have any questions.
duke@1:  */
duke@1: 
duke@1: package com.sun.tools.doclets.formats.html;
duke@1: 
duke@1: import com.sun.tools.doclets.internal.toolkit.*;
duke@1: import com.sun.tools.doclets.internal.toolkit.taglets.*;
duke@1: import com.sun.javadoc.*;
duke@1: 
duke@1: /**
duke@1:  * Generate serialized form for Serializable/Externalizable methods.
duke@1:  * Documentation denoted by the <code>serialData</code> tag is processed.
duke@1:  *
duke@1:  * @author Joe Fialli
duke@1:  */
duke@1: public class HtmlSerialMethodWriter extends MethodWriterImpl implements
duke@1:         SerializedFormWriter.SerialMethodWriter{
duke@1: 
duke@1:     private boolean printedFirstMember = false;
duke@1: 
duke@1:     public HtmlSerialMethodWriter(SubWriterHolderWriter writer,
duke@1:             ClassDoc classdoc) {
duke@1:         super(writer, classdoc);
duke@1:     }
duke@1: 
duke@1:     public void writeHeader(String heading) {
duke@1:         writer.anchor("serialized_methods");
duke@1:         writer.printTableHeadingBackground(heading);
duke@1:         writer.p();
duke@1:     }
duke@1: 
duke@1:     public void writeNoCustomizationMsg(String msg) {
duke@1:         writer.print(msg);
duke@1:         writer.p();
duke@1:     }
duke@1: 
duke@1:     public void writeMemberHeader(MethodDoc member) {
duke@1:         if (printedFirstMember) {
duke@1:             writer.printMemberHeader();
duke@1:         }
duke@1:         printedFirstMember = true;
duke@1:         writer.anchor(member);
duke@1:         printHead(member);
duke@1:         writeSignature(member);
duke@1:     }
duke@1: 
duke@1:     public void writeMemberFooter(MethodDoc member) {
duke@1:         writer.dlEnd();
duke@1:     }
duke@1: 
duke@1:     public void writeDeprecatedMemberInfo(MethodDoc member) {
duke@1:         print(((TagletOutputImpl)
duke@1:             (new DeprecatedTaglet()).getTagletOutput(member,
duke@1:             writer.getTagletWriterInstance(false))).toString());
duke@1:     }
duke@1: 
duke@1:     public void writeMemberDescription(MethodDoc member) {
duke@1:         printComment(member);
duke@1:     }
duke@1: 
duke@1:     public void writeMemberTags(MethodDoc member) {
duke@1:         writer.dd();
duke@1:         writer.dl();
duke@1:         TagletOutputImpl output = new TagletOutputImpl("");
duke@1:         TagletManager tagletManager =
duke@1:             ConfigurationImpl.getInstance().tagletManager;
duke@1:         TagletWriter.genTagOuput(tagletManager, member,
duke@1:             tagletManager.getSerializedFormTags(),
duke@1:             writer.getTagletWriterInstance(false), output);
duke@1:         print(output.toString());
duke@1:         MethodDoc method = (MethodDoc)member;
duke@1:         if (method.name().compareTo("writeExternal") == 0
duke@1:                 && method.tags("serialData").length == 0) {
duke@1:             serialWarning(member.position(), "doclet.MissingSerialDataTag",
duke@1:                 method.containingClass().qualifiedName(), method.name());
duke@1:         }
duke@1:         writer.ddEnd();
duke@1:         writer.dlEnd();
duke@1:     }
duke@1: 
duke@1:     protected void printTypeLinkNoDimension(Type type) {
duke@1:         ClassDoc cd = type.asClassDoc();
duke@1:         if (type.isPrimitive() || cd.isPackagePrivate()) {
duke@1:             print(type.typeName());
duke@1:         } else {
duke@1:             writer.printLink(new LinkInfoImpl(
duke@1:                 LinkInfoImpl.CONTEXT_SERIAL_MEMBER,type));
duke@1:         }
duke@1:     }
duke@1: }