src/share/classes/com/sun/tools/doclets/internal/toolkit/taglets/LegacyTaglet.java

Tue, 18 Jun 2013 20:56:04 -0700

author
mfang
date
Tue, 18 Jun 2013 20:56:04 -0700
changeset 1841
792c40d5185a
parent 1751
ca8808c88f94
child 1996
7a2fe98cb0e6
permissions
-rw-r--r--

8015657: jdk8 l10n resource file translation update 3
Reviewed-by: yhuang

duke@1 1 /*
jjg@1751 2 * Copyright (c) 2003, 2013, Oracle and/or its affiliates. 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
ohair@554 7 * published by the Free Software Foundation. Oracle designates this
duke@1 8 * particular file as subject to the "Classpath" exception as provided
ohair@554 9 * by Oracle 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 *
ohair@554 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@554 22 * or visit www.oracle.com if you need additional information or have any
ohair@554 23 * 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.*;
jjg@1751 29 import com.sun.tools.doclets.formats.html.markup.RawHtml;
jjg@1751 30 import com.sun.tools.doclets.internal.toolkit.Content;
duke@1 31
duke@1 32 /**
duke@1 33 * This taglet acts as a wrapper to enable
duke@1 34 * {@link com.sun.tools.doclets.Taglet} type taglets to work
duke@1 35 * with the current version of Javadoc.
duke@1 36 * Note: this taglet only works with legacy taglets (those compatible with
duke@1 37 * Javadoc 1.4.x) that writes strings.
duke@1 38 * This taglet is able to wrap most most legacy taglets because
duke@1 39 * the standard doclet is the only known doclet to use legacy taglets.
duke@1 40 *
jjg@1359 41 * <p><b>This is NOT part of any supported API.
jjg@1359 42 * If you write code that depends on this, you do so at your own risk.
jjg@1359 43 * This code and its internal interfaces are subject to change or
jjg@1359 44 * deletion without notice.</b>
duke@1 45 *
duke@1 46 * @since 1.5
duke@1 47 * @author Jamie Ho
duke@1 48 */
duke@1 49
duke@1 50 public class LegacyTaglet implements Taglet {
duke@1 51
duke@1 52 private com.sun.tools.doclets.Taglet legacyTaglet;
duke@1 53
duke@1 54 public LegacyTaglet(com.sun.tools.doclets.Taglet t) {
duke@1 55 legacyTaglet = t;
duke@1 56 }
duke@1 57
duke@1 58 /**
duke@1 59 * {@inheritDoc}
duke@1 60 */
duke@1 61 public boolean inField() {
duke@1 62 return legacyTaglet.isInlineTag() || legacyTaglet.inField();
duke@1 63 }
duke@1 64
duke@1 65 /**
duke@1 66 * {@inheritDoc}
duke@1 67 */
duke@1 68 public boolean inConstructor() {
duke@1 69 return legacyTaglet.isInlineTag() || legacyTaglet.inConstructor();
duke@1 70 }
duke@1 71
duke@1 72 /**
duke@1 73 * {@inheritDoc}
duke@1 74 */
duke@1 75 public boolean inMethod() {
duke@1 76 return legacyTaglet.isInlineTag() || legacyTaglet.inMethod();
duke@1 77 }
duke@1 78
duke@1 79 /**
duke@1 80 * {@inheritDoc}
duke@1 81 */
duke@1 82 public boolean inOverview() {
duke@1 83 return legacyTaglet.isInlineTag() || legacyTaglet.inOverview();
duke@1 84 }
duke@1 85
duke@1 86 /**
duke@1 87 * {@inheritDoc}
duke@1 88 */
duke@1 89 public boolean inPackage() {
duke@1 90 return legacyTaglet.isInlineTag() || legacyTaglet.inPackage();
duke@1 91 }
duke@1 92
duke@1 93 /**
duke@1 94 * {@inheritDoc}
duke@1 95 */
duke@1 96 public boolean inType() {
duke@1 97 return legacyTaglet.isInlineTag() || legacyTaglet.inType();
duke@1 98 }
duke@1 99
duke@1 100 /**
duke@1 101 * Return true if this <code>Taglet</code>
duke@1 102 * is an inline tag.
duke@1 103 * @return true if this <code>Taglet</code>
duke@1 104 * is an inline tag and false otherwise.
duke@1 105 */
duke@1 106 public boolean isInlineTag() {
duke@1 107 return legacyTaglet.isInlineTag();
duke@1 108 }
duke@1 109
duke@1 110 /**
duke@1 111 * {@inheritDoc}
duke@1 112 */
duke@1 113 public String getName() {
duke@1 114 return legacyTaglet.getName();
duke@1 115 }
duke@1 116
duke@1 117 /**
duke@1 118 * {@inheritDoc}
duke@1 119 */
jjg@1751 120 public Content getTagletOutput(Tag tag, TagletWriter writer)
duke@1 121 throws IllegalArgumentException {
jjg@1751 122 Content output = writer.getOutputInstance();
jjg@1751 123 output.addContent(new RawHtml(legacyTaglet.toString(tag)));
duke@1 124 return output;
duke@1 125 }
duke@1 126
duke@1 127 /**
duke@1 128 * {@inheritDoc}
duke@1 129 */
jjg@1751 130 public Content getTagletOutput(Doc holder, TagletWriter writer)
duke@1 131 throws IllegalArgumentException {
jjg@1751 132 Content output = writer.getOutputInstance();
jjg@1751 133 output.addContent(new RawHtml(legacyTaglet.toString(holder.tags(getName()))));
duke@1 134 return output;
duke@1 135 }
duke@1 136 }

mercurial