diff -r 000000000000 -r 9a66ca7c79fa src/share/classes/com/sun/tools/doclets/formats/html/TagletWriterImpl.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/src/share/classes/com/sun/tools/doclets/formats/html/TagletWriterImpl.java Sat Dec 01 00:00:00 2007 +0000
@@ -0,0 +1,304 @@
+/*
+ * Copyright 2003-2005 Sun Microsystems, Inc. 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. Sun designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
+ * CA 95054 USA or visit www.sun.com if you need additional information or
+ * have any questions.
+ */
+
+package com.sun.tools.doclets.formats.html;
+
+import com.sun.tools.doclets.internal.toolkit.*;
+import com.sun.tools.doclets.internal.toolkit.builders.SerializedFormBuilder;
+import com.sun.tools.doclets.internal.toolkit.taglets.*;
+import com.sun.tools.doclets.internal.toolkit.util.*;
+import com.sun.javadoc.*;
+
+/**
+ * The taglet writer that writes HTML.
+ *
+ * @since 1.5
+ * @author Jamie Ho
+ */
+
+public class TagletWriterImpl extends TagletWriter {
+
+ private HtmlDocletWriter htmlWriter;
+
+ public TagletWriterImpl(HtmlDocletWriter htmlWriter, boolean isFirstSentence) {
+ this.htmlWriter = htmlWriter;
+ this.isFirstSentence = isFirstSentence;
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public TagletOutput getOutputInstance() {
+ return new TagletOutputImpl("");
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public TagletOutput getDocRootOutput() {
+ return new TagletOutputImpl(htmlWriter.relativepathNoSlash);
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public TagletOutput deprecatedTagOutput(Doc doc) {
+ StringBuffer output = new StringBuffer();
+ Tag[] deprs = doc.tags("deprecated");
+ if (doc instanceof ClassDoc) {
+ if (Util.isDeprecated((ProgramElementDoc) doc)) {
+ output.append("" +
+ ConfigurationImpl.getInstance().
+ getText("doclet.Deprecated") + " ");
+ if (deprs.length > 0) {
+ Tag[] commentTags = deprs[0].inlineTags();
+ if (commentTags.length > 0) {
+
+ output.append(commentTagsToOutput(null, doc,
+ deprs[0].inlineTags(), false).toString()
+ );
+ }
+ }
+ output.append("
");
+ }
+ } else {
+ MemberDoc member = (MemberDoc) doc;
+ if (Util.isDeprecated((ProgramElementDoc) doc)) {
+ output.append("
" +
+ ConfigurationImpl.getInstance().
+ getText("doclet.Deprecated") + " ");
+ if (deprs.length > 0) {
+ output.append("");
+ output.append(commentTagsToOutput(null, doc,
+ deprs[0].inlineTags(), false).toString());
+ output.append("");
+ }
+ if (member instanceof ExecutableMemberDoc) {
+ output.append(DocletConstants.NL + "" +
+ DocletConstants.NL);
+ }
+ } else {
+ if (Util.isDeprecated(member.containingClass())) {
+ output.append("
" +
+ ConfigurationImpl.getInstance().
+ getText("doclet.Deprecated") + " ");
+ }
+ }
+ }
+ return new TagletOutputImpl(output.toString());
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public MessageRetriever getMsgRetriever() {
+ return htmlWriter.configuration.message;
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public TagletOutput getParamHeader(String header) {
+ StringBuffer result = new StringBuffer();
+ result.append("");
+ result.append("" + header + "");
+ return new TagletOutputImpl(result.toString());
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public TagletOutput paramTagOutput(ParamTag paramTag, String paramName) {
+ TagletOutput result = new TagletOutputImpl("" + paramName + "
"
+ + " - " + htmlWriter.commentTagsToString(paramTag, null, paramTag.inlineTags(), false));
+ return result;
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public TagletOutput returnTagOutput(Tag returnTag) {
+ TagletOutput result = new TagletOutputImpl(DocletConstants.NL + "" +
+ "" + htmlWriter.configuration.getText("doclet.Returns") +
+ "" + "" +
+ htmlWriter.commentTagsToString(returnTag, null, returnTag.inlineTags(),
+ false));
+ return result;
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public TagletOutput seeTagOutput(Doc holder, SeeTag[] seeTags) {
+ String result = "";
+ if (seeTags.length > 0) {
+ result = addSeeHeader(result);
+ for (int i = 0; i < seeTags.length; ++i) {
+ if (i > 0) {
+ result += ", " + DocletConstants.NL;
+ }
+ result += htmlWriter.seeTagToString(seeTags[i]);
+ }
+ }
+ if (holder.isField() && ((FieldDoc)holder).constantValue() != null &&
+ htmlWriter instanceof ClassWriterImpl) {
+ //Automatically add link to constant values page for constant fields.
+ result = addSeeHeader(result);
+ result += htmlWriter.getHyperLink(htmlWriter.relativePath +
+ ConfigurationImpl.CONSTANTS_FILE_NAME
+ + "#" + ((ClassWriterImpl) htmlWriter).getClassDoc().qualifiedName()
+ + "." + ((FieldDoc) holder).name(),
+ htmlWriter.configuration.getText("doclet.Constants_Summary"));
+ }
+ if (holder.isClass() && ((ClassDoc)holder).isSerializable()) {
+ //Automatically add link to serialized form page for serializable classes.
+ if (!(SerializedFormBuilder.serialInclude(holder) &&
+ SerializedFormBuilder.serialInclude(((ClassDoc)holder).containingPackage()))) {
+ return result.equals("") ? null : new TagletOutputImpl(result);
+ }
+ result = addSeeHeader(result);
+ result += htmlWriter.getHyperLink(htmlWriter.relativePath + "serialized-form.html",
+ ((ClassDoc)holder).qualifiedName(), htmlWriter.configuration.getText("doclet.Serialized_Form"), false);
+ }
+ return result.equals("") ? null : new TagletOutputImpl(result);
+ }
+
+ private String addSeeHeader(String result) {
+ if (result != null && result.length() > 0) {
+ return result + ", " + DocletConstants.NL;
+ } else {
+ return "" + htmlWriter.configuration().getText("doclet.See_Also") + "";
+ }
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public TagletOutput simpleTagOutput(Tag[] simpleTags, String header) {
+ String result = "" + header + "" + DocletConstants.NL +
+ " ";
+ for (int i = 0; i < simpleTags.length; i++) {
+ if (i > 0) {
+ result += ", ";
+ }
+ result += htmlWriter.commentTagsToString(simpleTags[i], null, simpleTags[i].inlineTags(), false);
+ }
+ return new TagletOutputImpl(result + "" + DocletConstants.NL);
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public TagletOutput simpleTagOutput(Tag simpleTag, String header) {
+ return new TagletOutputImpl("" + header + "" + " "
+ + htmlWriter.commentTagsToString(simpleTag, null, simpleTag.inlineTags(), false)
+ + "" + DocletConstants.NL);
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public TagletOutput getThrowsHeader() {
+ return new TagletOutputImpl(DocletConstants.NL + "" + "" +
+ htmlWriter.configuration().getText("doclet.Throws") + "");
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public TagletOutput throwsTagOutput(ThrowsTag throwsTag) {
+ String result = DocletConstants.NL + "";
+ result += throwsTag.exceptionType() == null ?
+ htmlWriter.codeText(throwsTag.exceptionName()) :
+ htmlWriter.codeText(
+ htmlWriter.getLink(new LinkInfoImpl(LinkInfoImpl.CONTEXT_MEMBER,
+ throwsTag.exceptionType())));
+ TagletOutput text = new TagletOutputImpl(
+ htmlWriter.commentTagsToString(throwsTag, null,
+ throwsTag.inlineTags(), false));
+ if (text != null && text.toString().length() > 0) {
+ result += " - " + text;
+ }
+ return new TagletOutputImpl(result);
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public TagletOutput throwsTagOutput(Type throwsType) {
+ return new TagletOutputImpl(DocletConstants.NL + "" +
+ htmlWriter.codeText(htmlWriter.getLink(
+ new LinkInfoImpl(LinkInfoImpl.CONTEXT_MEMBER, throwsType))));
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public TagletOutput valueTagOutput(FieldDoc field, String constantVal,
+ boolean includeLink) {
+ return new TagletOutputImpl(includeLink ?
+ htmlWriter.getDocLink(LinkInfoImpl.CONTEXT_VALUE_TAG, field,
+ constantVal, false) : constantVal);
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public TagletOutput commentTagsToOutput(Tag holderTag, Tag[] tags) {
+ return commentTagsToOutput(holderTag, null, tags, false);
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public TagletOutput commentTagsToOutput(Doc holderDoc, Tag[] tags) {
+ return commentTagsToOutput(null, holderDoc, tags, false);
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public TagletOutput commentTagsToOutput(Tag holderTag,
+ Doc holderDoc, Tag[] tags, boolean isFirstSentence) {
+ return new TagletOutputImpl(htmlWriter.commentTagsToString(
+ holderTag, holderDoc, tags, isFirstSentence));
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public Configuration configuration() {
+ return htmlWriter.configuration();
+ }
+
+ /**
+ * Return an instance of a TagletWriter that knows how to write HTML.
+ *
+ * @return an instance of a TagletWriter that knows how to write HTML.
+ */
+ public TagletOutput getTagletOutputInstance() {
+ return new TagletOutputImpl("");
+ }
+}