Sat, 01 Dec 2007 00:00:00 +0000
Initial load
duke@1 | 1 | /* |
duke@1 | 2 | * Copyright 2003 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.internal.toolkit.taglets; |
duke@1 | 27 | |
duke@1 | 28 | import com.sun.javadoc.*; |
duke@1 | 29 | |
duke@1 | 30 | /** |
duke@1 | 31 | * This taglet acts as a wrapper to enable |
duke@1 | 32 | * {@link com.sun.tools.doclets.Taglet} type taglets to work |
duke@1 | 33 | * with the current version of Javadoc. |
duke@1 | 34 | * Note: this taglet only works with legacy taglets (those compatible with |
duke@1 | 35 | * Javadoc 1.4.x) that writes strings. |
duke@1 | 36 | * This taglet is able to wrap most most legacy taglets because |
duke@1 | 37 | * the standard doclet is the only known doclet to use legacy taglets. |
duke@1 | 38 | * |
duke@1 | 39 | * This code is not part of an API. |
duke@1 | 40 | * It is implementation that is subject to change. |
duke@1 | 41 | * Do not use it as an API |
duke@1 | 42 | * |
duke@1 | 43 | * @since 1.5 |
duke@1 | 44 | * @author Jamie Ho |
duke@1 | 45 | */ |
duke@1 | 46 | |
duke@1 | 47 | public class LegacyTaglet implements Taglet { |
duke@1 | 48 | |
duke@1 | 49 | private com.sun.tools.doclets.Taglet legacyTaglet; |
duke@1 | 50 | |
duke@1 | 51 | public LegacyTaglet(com.sun.tools.doclets.Taglet t) { |
duke@1 | 52 | legacyTaglet = t; |
duke@1 | 53 | } |
duke@1 | 54 | |
duke@1 | 55 | /** |
duke@1 | 56 | * {@inheritDoc} |
duke@1 | 57 | */ |
duke@1 | 58 | public boolean inField() { |
duke@1 | 59 | return legacyTaglet.isInlineTag() || legacyTaglet.inField(); |
duke@1 | 60 | } |
duke@1 | 61 | |
duke@1 | 62 | /** |
duke@1 | 63 | * {@inheritDoc} |
duke@1 | 64 | */ |
duke@1 | 65 | public boolean inConstructor() { |
duke@1 | 66 | return legacyTaglet.isInlineTag() || legacyTaglet.inConstructor(); |
duke@1 | 67 | } |
duke@1 | 68 | |
duke@1 | 69 | /** |
duke@1 | 70 | * {@inheritDoc} |
duke@1 | 71 | */ |
duke@1 | 72 | public boolean inMethod() { |
duke@1 | 73 | return legacyTaglet.isInlineTag() || legacyTaglet.inMethod(); |
duke@1 | 74 | } |
duke@1 | 75 | |
duke@1 | 76 | /** |
duke@1 | 77 | * {@inheritDoc} |
duke@1 | 78 | */ |
duke@1 | 79 | public boolean inOverview() { |
duke@1 | 80 | return legacyTaglet.isInlineTag() || legacyTaglet.inOverview(); |
duke@1 | 81 | } |
duke@1 | 82 | |
duke@1 | 83 | /** |
duke@1 | 84 | * {@inheritDoc} |
duke@1 | 85 | */ |
duke@1 | 86 | public boolean inPackage() { |
duke@1 | 87 | return legacyTaglet.isInlineTag() || legacyTaglet.inPackage(); |
duke@1 | 88 | } |
duke@1 | 89 | |
duke@1 | 90 | /** |
duke@1 | 91 | * {@inheritDoc} |
duke@1 | 92 | */ |
duke@1 | 93 | public boolean inType() { |
duke@1 | 94 | return legacyTaglet.isInlineTag() || legacyTaglet.inType(); |
duke@1 | 95 | } |
duke@1 | 96 | |
duke@1 | 97 | /** |
duke@1 | 98 | * Return true if this <code>Taglet</code> |
duke@1 | 99 | * is an inline tag. |
duke@1 | 100 | * @return true if this <code>Taglet</code> |
duke@1 | 101 | * is an inline tag and false otherwise. |
duke@1 | 102 | */ |
duke@1 | 103 | public boolean isInlineTag() { |
duke@1 | 104 | return legacyTaglet.isInlineTag(); |
duke@1 | 105 | } |
duke@1 | 106 | |
duke@1 | 107 | /** |
duke@1 | 108 | * {@inheritDoc} |
duke@1 | 109 | */ |
duke@1 | 110 | public String getName() { |
duke@1 | 111 | return legacyTaglet.getName(); |
duke@1 | 112 | } |
duke@1 | 113 | |
duke@1 | 114 | /** |
duke@1 | 115 | * {@inheritDoc} |
duke@1 | 116 | */ |
duke@1 | 117 | public TagletOutput getTagletOutput(Tag tag, TagletWriter writer) |
duke@1 | 118 | throws IllegalArgumentException { |
duke@1 | 119 | TagletOutput output = writer.getOutputInstance(); |
duke@1 | 120 | output.setOutput(legacyTaglet.toString(tag)); |
duke@1 | 121 | return output; |
duke@1 | 122 | } |
duke@1 | 123 | |
duke@1 | 124 | /** |
duke@1 | 125 | * {@inheritDoc} |
duke@1 | 126 | */ |
duke@1 | 127 | public TagletOutput getTagletOutput(Doc holder, TagletWriter writer) |
duke@1 | 128 | throws IllegalArgumentException { |
duke@1 | 129 | TagletOutput output = writer.getOutputInstance(); |
duke@1 | 130 | output.setOutput(legacyTaglet.toString(holder.tags(getName()))); |
duke@1 | 131 | return output; |
duke@1 | 132 | } |
duke@1 | 133 | } |