1 /* 2 * Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle in the LICENSE file that accompanied this code. 10 * 11 * This code is distributed in the hope that it will be useful, but WITHOUT 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14 * version 2 for more details (a copy is included in the LICENSE file that 15 * accompanied this code). 16 * 17 * You should have received a copy of the GNU General Public License version 18 * 2 along with this work; if not, write to the Free Software Foundation, 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 * 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25 26 package com.sun.tools.doclets.internal.toolkit.taglets; 27 28 import com.sun.javadoc.*; 29 import com.sun.tools.doclets.formats.html.markup.RawHtml; 30 import com.sun.tools.doclets.internal.toolkit.Content; 31 32 /** 33 * This taglet acts as a wrapper to enable 34 * {@link com.sun.tools.doclets.Taglet} type taglets to work 35 * with the current version of Javadoc. 36 * Note: this taglet only works with legacy taglets (those compatible with 37 * Javadoc 1.4.x) that writes strings. 38 * This taglet is able to wrap most most legacy taglets because 39 * the standard doclet is the only known doclet to use legacy taglets. 40 * 41 * <p><b>This is NOT part of any supported API. 42 * If you write code that depends on this, you do so at your own risk. 43 * This code and its internal interfaces are subject to change or 44 * deletion without notice.</b> 45 * 46 * @since 1.5 47 * @author Jamie Ho 48 */ 49 50 public class LegacyTaglet implements Taglet { 51 52 private com.sun.tools.doclets.Taglet legacyTaglet; 53 LegacyTaglet(com.sun.tools.doclets.Taglet t)54 public LegacyTaglet(com.sun.tools.doclets.Taglet t) { 55 legacyTaglet = t; 56 } 57 58 /** 59 * {@inheritDoc} 60 */ inField()61 public boolean inField() { 62 return legacyTaglet.isInlineTag() || legacyTaglet.inField(); 63 } 64 65 /** 66 * {@inheritDoc} 67 */ inConstructor()68 public boolean inConstructor() { 69 return legacyTaglet.isInlineTag() || legacyTaglet.inConstructor(); 70 } 71 72 /** 73 * {@inheritDoc} 74 */ inMethod()75 public boolean inMethod() { 76 return legacyTaglet.isInlineTag() || legacyTaglet.inMethod(); 77 } 78 79 /** 80 * {@inheritDoc} 81 */ inOverview()82 public boolean inOverview() { 83 return legacyTaglet.isInlineTag() || legacyTaglet.inOverview(); 84 } 85 86 /** 87 * {@inheritDoc} 88 */ inPackage()89 public boolean inPackage() { 90 return legacyTaglet.isInlineTag() || legacyTaglet.inPackage(); 91 } 92 93 /** 94 * {@inheritDoc} 95 */ inType()96 public boolean inType() { 97 return legacyTaglet.isInlineTag() || legacyTaglet.inType(); 98 } 99 100 /** 101 * Return true if this <code>Taglet</code> 102 * is an inline tag. 103 * @return true if this <code>Taglet</code> 104 * is an inline tag and false otherwise. 105 */ isInlineTag()106 public boolean isInlineTag() { 107 return legacyTaglet.isInlineTag(); 108 } 109 110 /** 111 * {@inheritDoc} 112 */ getName()113 public String getName() { 114 return legacyTaglet.getName(); 115 } 116 117 /** 118 * {@inheritDoc} 119 */ getTagletOutput(Tag tag, TagletWriter writer)120 public Content getTagletOutput(Tag tag, TagletWriter writer) 121 throws IllegalArgumentException { 122 Content output = writer.getOutputInstance(); 123 output.addContent(new RawHtml(legacyTaglet.toString(tag))); 124 return output; 125 } 126 127 /** 128 * {@inheritDoc} 129 */ getTagletOutput(Doc holder, TagletWriter writer)130 public Content getTagletOutput(Doc holder, TagletWriter writer) 131 throws IllegalArgumentException { 132 Content output = writer.getOutputInstance(); 133 Tag[] tags = holder.tags(getName()); 134 if (tags.length > 0) { 135 String tagString = legacyTaglet.toString(tags); 136 if (tagString != null) { 137 output.addContent(new RawHtml(tagString)); 138 } 139 } 140 return output; 141 } 142 } 143