Mercurial > jdk8-mips64-public > langtools / file diff

     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/src/share/classes/com/sun/tools/doclets/formats/html/HtmlSerialMethodWriter.java	Sat Dec 01 00:00:00 2007 +0000
     1.3 @@ -0,0 +1,112 @@
     1.4 +/*
     1.5 + * Copyright 1998-2003 Sun Microsystems, Inc.  All Rights Reserved.
     1.6 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
     1.7 + *
     1.8 + * This code is free software; you can redistribute it and/or modify it
     1.9 + * under the terms of the GNU General Public License version 2 only, as
    1.10 + * published by the Free Software Foundation.  Sun designates this
    1.11 + * particular file as subject to the "Classpath" exception as provided
    1.12 + * by Sun in the LICENSE file that accompanied this code.
    1.13 + *
    1.14 + * This code is distributed in the hope that it will be useful, but WITHOUT
    1.15 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    1.16 + * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    1.17 + * version 2 for more details (a copy is included in the LICENSE file that
    1.18 + * accompanied this code).
    1.19 + *
    1.20 + * You should have received a copy of the GNU General Public License version
    1.21 + * 2 along with this work; if not, write to the Free Software Foundation,
    1.22 + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
    1.23 + *
    1.24 + * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
    1.25 + * CA 95054 USA or visit www.sun.com if you need additional information or
    1.26 + * have any questions.
    1.27 + */
    1.28 +
    1.29 +package com.sun.tools.doclets.formats.html;
    1.30 +
    1.31 +import com.sun.tools.doclets.internal.toolkit.*;
    1.32 +import com.sun.tools.doclets.internal.toolkit.taglets.*;
    1.33 +import com.sun.javadoc.*;
    1.34 +
    1.35 +/**
    1.36 + * Generate serialized form for Serializable/Externalizable methods.
    1.37 + * Documentation denoted by the <code>serialData</code> tag is processed.
    1.38 + *
    1.39 + * @author Joe Fialli
    1.40 + */
    1.41 +public class HtmlSerialMethodWriter extends MethodWriterImpl implements
    1.42 +        SerializedFormWriter.SerialMethodWriter{
    1.43 +
    1.44 +    private boolean printedFirstMember = false;
    1.45 +
    1.46 +    public HtmlSerialMethodWriter(SubWriterHolderWriter writer,
    1.47 +            ClassDoc classdoc) {
    1.48 +        super(writer, classdoc);
    1.49 +    }
    1.50 +
    1.51 +    public void writeHeader(String heading) {
    1.52 +        writer.anchor("serialized_methods");
    1.53 +        writer.printTableHeadingBackground(heading);
    1.54 +        writer.p();
    1.55 +    }
    1.56 +
    1.57 +    public void writeNoCustomizationMsg(String msg) {
    1.58 +        writer.print(msg);
    1.59 +        writer.p();
    1.60 +    }
    1.61 +
    1.62 +    public void writeMemberHeader(MethodDoc member) {
    1.63 +        if (printedFirstMember) {
    1.64 +            writer.printMemberHeader();
    1.65 +        }
    1.66 +        printedFirstMember = true;
    1.67 +        writer.anchor(member);
    1.68 +        printHead(member);
    1.69 +        writeSignature(member);
    1.70 +    }
    1.71 +
    1.72 +    public void writeMemberFooter(MethodDoc member) {
    1.73 +        writer.dlEnd();
    1.74 +    }
    1.75 +
    1.76 +    public void writeDeprecatedMemberInfo(MethodDoc member) {
    1.77 +        print(((TagletOutputImpl)
    1.78 +            (new DeprecatedTaglet()).getTagletOutput(member,
    1.79 +            writer.getTagletWriterInstance(false))).toString());
    1.80 +    }
    1.81 +
    1.82 +    public void writeMemberDescription(MethodDoc member) {
    1.83 +        printComment(member);
    1.84 +    }
    1.85 +
    1.86 +    public void writeMemberTags(MethodDoc member) {
    1.87 +        writer.dd();
    1.88 +        writer.dl();
    1.89 +        TagletOutputImpl output = new TagletOutputImpl("");
    1.90 +        TagletManager tagletManager =
    1.91 +            ConfigurationImpl.getInstance().tagletManager;
    1.92 +        TagletWriter.genTagOuput(tagletManager, member,
    1.93 +            tagletManager.getSerializedFormTags(),
    1.94 +            writer.getTagletWriterInstance(false), output);
    1.95 +        print(output.toString());
    1.96 +        MethodDoc method = (MethodDoc)member;
    1.97 +        if (method.name().compareTo("writeExternal") == 0
    1.98 +                && method.tags("serialData").length == 0) {
    1.99 +            serialWarning(member.position(), "doclet.MissingSerialDataTag",
   1.100 +                method.containingClass().qualifiedName(), method.name());
   1.101 +        }
   1.102 +        writer.ddEnd();
   1.103 +        writer.dlEnd();
   1.104 +    }
   1.105 +
   1.106 +    protected void printTypeLinkNoDimension(Type type) {
   1.107 +        ClassDoc cd = type.asClassDoc();
   1.108 +        if (type.isPrimitive() || cd.isPackagePrivate()) {
   1.109 +            print(type.typeName());
   1.110 +        } else {
   1.111 +            writer.printLink(new LinkInfoImpl(
   1.112 +                LinkInfoImpl.CONTEXT_SERIAL_MEMBER,type));
   1.113 +        }
   1.114 +    }
   1.115 +}