Mercurial > jdk8-mips64-public > langtools / annotate
src/share/classes/com/sun/tools/doclets/formats/html/HtmlSerialMethodWriter.java@06e06ec0d6f2 (annotated)
src/share/classes/com/sun/tools/doclets/formats/html/HtmlSerialMethodWriter.java
Sun, 11 Apr 2010 23:24:24 -0700
- author
- yhuang
- date
- Sun, 11 Apr 2010 23:24:24 -0700
- changeset 539
- 06e06ec0d6f2
- parent 233
- 5240b1120530
- child 554
- 9d9f26857129
- permissions
- -rw-r--r--
6875904: Java 7 message synchronization 1
Reviewed-by: ogino, faryad
| duke@1 | 1 | /* |
| xdono@117 | 2 | * Copyright 1998-2008 Sun Microsystems, Inc. All Rights Reserved. |
| duke@1 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| duke@1 | 4 | * |
| duke@1 | 5 | * This code is free software; you can redistribute it and/or modify it |
| duke@1 | 6 | * under the terms of the GNU General Public License version 2 only, as |
| duke@1 | 7 | * published by the Free Software Foundation. Sun designates this |
| duke@1 | 8 | * particular file as subject to the "Classpath" exception as provided |
| duke@1 | 9 | * by Sun in the LICENSE file that accompanied this code. |
| duke@1 | 10 | * |
| duke@1 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| duke@1 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| duke@1 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| duke@1 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| duke@1 | 15 | * accompanied this code). |
| duke@1 | 16 | * |
| duke@1 | 17 | * You should have received a copy of the GNU General Public License version |
| duke@1 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| duke@1 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| duke@1 | 20 | * |
| duke@1 | 21 | * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, |
| duke@1 | 22 | * CA 95054 USA or visit www.sun.com if you need additional information or |
| duke@1 | 23 | * have any questions. |
| duke@1 | 24 | */ |
| duke@1 | 25 | |
| duke@1 | 26 | package com.sun.tools.doclets.formats.html; |
| duke@1 | 27 | |
| bpatel@233 | 28 | import com.sun.javadoc.*; |
| duke@1 | 29 | import com.sun.tools.doclets.internal.toolkit.*; |
| duke@1 | 30 | import com.sun.tools.doclets.internal.toolkit.taglets.*; |
| duke@1 | 31 | |
| duke@1 | 32 | /** |
| duke@1 | 33 | * Generate serialized form for Serializable/Externalizable methods. |
| duke@1 | 34 | * Documentation denoted by the <code>serialData</code> tag is processed. |
| duke@1 | 35 | * |
| duke@1 | 36 | * @author Joe Fialli |
| duke@1 | 37 | */ |
| duke@1 | 38 | public class HtmlSerialMethodWriter extends MethodWriterImpl implements |
| duke@1 | 39 | SerializedFormWriter.SerialMethodWriter{ |
| duke@1 | 40 | |
| duke@1 | 41 | private boolean printedFirstMember = false; |
| duke@1 | 42 | |
| duke@1 | 43 | public HtmlSerialMethodWriter(SubWriterHolderWriter writer, |
| duke@1 | 44 | ClassDoc classdoc) { |
| duke@1 | 45 | super(writer, classdoc); |
| duke@1 | 46 | } |
| duke@1 | 47 | |
| duke@1 | 48 | public void writeHeader(String heading) { |
| duke@1 | 49 | writer.anchor("serialized_methods"); |
| duke@1 | 50 | writer.printTableHeadingBackground(heading); |
| duke@1 | 51 | writer.p(); |
| duke@1 | 52 | } |
| duke@1 | 53 | |
| duke@1 | 54 | public void writeNoCustomizationMsg(String msg) { |
| duke@1 | 55 | writer.print(msg); |
| duke@1 | 56 | writer.p(); |
| duke@1 | 57 | } |
| duke@1 | 58 | |
| duke@1 | 59 | public void writeMemberHeader(MethodDoc member) { |
| duke@1 | 60 | if (printedFirstMember) { |
| duke@1 | 61 | writer.printMemberHeader(); |
| duke@1 | 62 | } |
| duke@1 | 63 | printedFirstMember = true; |
| duke@1 | 64 | writer.anchor(member); |
| duke@1 | 65 | printHead(member); |
| duke@1 | 66 | writeSignature(member); |
| duke@1 | 67 | } |
| duke@1 | 68 | |
| bpatel@233 | 69 | public void writeMemberFooter() { |
| bpatel@233 | 70 | printMemberFooter(); |
| duke@1 | 71 | } |
| duke@1 | 72 | |
| duke@1 | 73 | public void writeDeprecatedMemberInfo(MethodDoc member) { |
| bpatel@233 | 74 | printDeprecated(member); |
| duke@1 | 75 | } |
| duke@1 | 76 | |
| duke@1 | 77 | public void writeMemberDescription(MethodDoc member) { |
| duke@1 | 78 | printComment(member); |
| duke@1 | 79 | } |
| duke@1 | 80 | |
| duke@1 | 81 | public void writeMemberTags(MethodDoc member) { |
| duke@1 | 82 | TagletOutputImpl output = new TagletOutputImpl(""); |
| duke@1 | 83 | TagletManager tagletManager = |
| duke@1 | 84 | ConfigurationImpl.getInstance().tagletManager; |
| duke@1 | 85 | TagletWriter.genTagOuput(tagletManager, member, |
| duke@1 | 86 | tagletManager.getSerializedFormTags(), |
| duke@1 | 87 | writer.getTagletWriterInstance(false), output); |
| bpatel@233 | 88 | String outputString = output.toString().trim(); |
| bpatel@233 | 89 | if (!outputString.isEmpty()) { |
| bpatel@233 | 90 | writer.printMemberDetailsListStartTag(); |
| bpatel@233 | 91 | writer.dd(); |
| bpatel@233 | 92 | writer.dl(); |
| bpatel@233 | 93 | print(outputString); |
| bpatel@233 | 94 | writer.dlEnd(); |
| bpatel@233 | 95 | writer.ddEnd(); |
| bpatel@233 | 96 | } |
| jjg@74 | 97 | MethodDoc method = member; |
| duke@1 | 98 | if (method.name().compareTo("writeExternal") == 0 |
| duke@1 | 99 | && method.tags("serialData").length == 0) { |
| duke@1 | 100 | serialWarning(member.position(), "doclet.MissingSerialDataTag", |
| duke@1 | 101 | method.containingClass().qualifiedName(), method.name()); |
| duke@1 | 102 | } |
| duke@1 | 103 | } |
| duke@1 | 104 | |
| duke@1 | 105 | protected void printTypeLinkNoDimension(Type type) { |
| duke@1 | 106 | ClassDoc cd = type.asClassDoc(); |
| duke@1 | 107 | if (type.isPrimitive() || cd.isPackagePrivate()) { |
| duke@1 | 108 | print(type.typeName()); |
| duke@1 | 109 | } else { |
| duke@1 | 110 | writer.printLink(new LinkInfoImpl( |
| duke@1 | 111 | LinkInfoImpl.CONTEXT_SERIAL_MEMBER,type)); |
| duke@1 | 112 | } |
| duke@1 | 113 | } |
| duke@1 | 114 | } |
