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