langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/taglets/LegacyTaglet.java
changeset 10 06bc494ca11e
child 5520 86e4b9a9da40
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/taglets/LegacyTaglet.java	Sat Dec 01 00:00:00 2007 +0000
@@ -0,0 +1,133 @@
+/*
+ * Copyright 2003 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.internal.toolkit.taglets;
+
+import com.sun.javadoc.*;
+
+/**
+ * This taglet acts as a wrapper to enable
+ * {@link com.sun.tools.doclets.Taglet} type taglets to work
+ * with the current version of Javadoc.
+ * Note: this taglet only works with legacy taglets (those compatible with
+ * Javadoc 1.4.x) that writes strings.
+ * This taglet is able to wrap most most legacy taglets because
+ * the standard doclet is the only known doclet to use legacy taglets.
+ *
+ * This code is not part of an API.
+ * It is implementation that is subject to change.
+ * Do not use it as an API
+ *
+ * @since 1.5
+ * @author Jamie Ho
+ */
+
+public class LegacyTaglet implements Taglet {
+
+    private com.sun.tools.doclets.Taglet legacyTaglet;
+
+    public LegacyTaglet(com.sun.tools.doclets.Taglet t) {
+        legacyTaglet = t;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public boolean inField() {
+        return legacyTaglet.isInlineTag() || legacyTaglet.inField();
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public boolean inConstructor() {
+        return legacyTaglet.isInlineTag() || legacyTaglet.inConstructor();
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public boolean inMethod() {
+        return legacyTaglet.isInlineTag() || legacyTaglet.inMethod();
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public boolean inOverview() {
+        return legacyTaglet.isInlineTag() || legacyTaglet.inOverview();
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public boolean inPackage() {
+        return legacyTaglet.isInlineTag() || legacyTaglet.inPackage();
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public boolean inType() {
+        return legacyTaglet.isInlineTag() || legacyTaglet.inType();
+    }
+
+    /**
+     * Return true if this <code>Taglet</code>
+     * is an inline tag.
+     * @return true if this <code>Taglet</code>
+     * is an inline tag and false otherwise.
+     */
+    public boolean isInlineTag() {
+        return legacyTaglet.isInlineTag();
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public String getName() {
+        return legacyTaglet.getName();
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public TagletOutput getTagletOutput(Tag tag, TagletWriter writer)
+            throws IllegalArgumentException {
+        TagletOutput output = writer.getOutputInstance();
+        output.setOutput(legacyTaglet.toString(tag));
+        return output;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public TagletOutput getTagletOutput(Doc holder, TagletWriter writer)
+            throws IllegalArgumentException {
+        TagletOutput output = writer.getOutputInstance();
+        output.setOutput(legacyTaglet.toString(holder.tags(getName())));
+        return output;
+    }
+}