duke@1: /*
ohair@554: * Copyright (c) 2003, Oracle and/or its affiliates. All rights reserved.
duke@1: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1: *
duke@1: * This code is free software; you can redistribute it and/or modify it
duke@1: * under the terms of the GNU General Public License version 2 only, as
ohair@554: * published by the Free Software Foundation. Oracle designates this
duke@1: * particular file as subject to the "Classpath" exception as provided
ohair@554: * by Oracle in the LICENSE file that accompanied this code.
duke@1: *
duke@1: * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
duke@1: * version 2 for more details (a copy is included in the LICENSE file that
duke@1: * accompanied this code).
duke@1: *
duke@1: * You should have received a copy of the GNU General Public License version
duke@1: * 2 along with this work; if not, write to the Free Software Foundation,
duke@1: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1: *
ohair@554: * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@554: * or visit www.oracle.com if you need additional information or have any
ohair@554: * questions.
duke@1: */
duke@1:
duke@1: package com.sun.tools.doclets.internal.toolkit.taglets;
duke@1:
duke@1: import com.sun.javadoc.*;
duke@1:
duke@1: /**
duke@1: * This taglet acts as a wrapper to enable
duke@1: * {@link com.sun.tools.doclets.Taglet} type taglets to work
duke@1: * with the current version of Javadoc.
duke@1: * Note: this taglet only works with legacy taglets (those compatible with
duke@1: * Javadoc 1.4.x) that writes strings.
duke@1: * This taglet is able to wrap most most legacy taglets because
duke@1: * the standard doclet is the only known doclet to use legacy taglets.
duke@1: *
duke@1: * This code is not part of an API.
duke@1: * It is implementation that is subject to change.
duke@1: * Do not use it as an API
duke@1: *
duke@1: * @since 1.5
duke@1: * @author Jamie Ho
duke@1: */
duke@1:
duke@1: public class LegacyTaglet implements Taglet {
duke@1:
duke@1: private com.sun.tools.doclets.Taglet legacyTaglet;
duke@1:
duke@1: public LegacyTaglet(com.sun.tools.doclets.Taglet t) {
duke@1: legacyTaglet = t;
duke@1: }
duke@1:
duke@1: /**
duke@1: * {@inheritDoc}
duke@1: */
duke@1: public boolean inField() {
duke@1: return legacyTaglet.isInlineTag() || legacyTaglet.inField();
duke@1: }
duke@1:
duke@1: /**
duke@1: * {@inheritDoc}
duke@1: */
duke@1: public boolean inConstructor() {
duke@1: return legacyTaglet.isInlineTag() || legacyTaglet.inConstructor();
duke@1: }
duke@1:
duke@1: /**
duke@1: * {@inheritDoc}
duke@1: */
duke@1: public boolean inMethod() {
duke@1: return legacyTaglet.isInlineTag() || legacyTaglet.inMethod();
duke@1: }
duke@1:
duke@1: /**
duke@1: * {@inheritDoc}
duke@1: */
duke@1: public boolean inOverview() {
duke@1: return legacyTaglet.isInlineTag() || legacyTaglet.inOverview();
duke@1: }
duke@1:
duke@1: /**
duke@1: * {@inheritDoc}
duke@1: */
duke@1: public boolean inPackage() {
duke@1: return legacyTaglet.isInlineTag() || legacyTaglet.inPackage();
duke@1: }
duke@1:
duke@1: /**
duke@1: * {@inheritDoc}
duke@1: */
duke@1: public boolean inType() {
duke@1: return legacyTaglet.isInlineTag() || legacyTaglet.inType();
duke@1: }
duke@1:
duke@1: /**
duke@1: * Return true if this Taglet
duke@1: * is an inline tag.
duke@1: * @return true if this Taglet
duke@1: * is an inline tag and false otherwise.
duke@1: */
duke@1: public boolean isInlineTag() {
duke@1: return legacyTaglet.isInlineTag();
duke@1: }
duke@1:
duke@1: /**
duke@1: * {@inheritDoc}
duke@1: */
duke@1: public String getName() {
duke@1: return legacyTaglet.getName();
duke@1: }
duke@1:
duke@1: /**
duke@1: * {@inheritDoc}
duke@1: */
duke@1: public TagletOutput getTagletOutput(Tag tag, TagletWriter writer)
duke@1: throws IllegalArgumentException {
duke@1: TagletOutput output = writer.getOutputInstance();
duke@1: output.setOutput(legacyTaglet.toString(tag));
duke@1: return output;
duke@1: }
duke@1:
duke@1: /**
duke@1: * {@inheritDoc}
duke@1: */
duke@1: public TagletOutput getTagletOutput(Doc holder, TagletWriter writer)
duke@1: throws IllegalArgumentException {
duke@1: TagletOutput output = writer.getOutputInstance();
duke@1: output.setOutput(legacyTaglet.toString(holder.tags(getName())));
duke@1: return output;
duke@1: }
duke@1: }