1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/src/share/classes/com/sun/tools/doclets/internal/toolkit/taglets/LegacyTaglet.java Wed Apr 27 01:34:52 2016 +0800
1.3 @@ -0,0 +1,142 @@
1.4 +/*
1.5 + * Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved.
1.6 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
1.7 + *
1.8 + * This code is free software; you can redistribute it and/or modify it
1.9 + * under the terms of the GNU General Public License version 2 only, as
1.10 + * published by the Free Software Foundation. Oracle designates this
1.11 + * particular file as subject to the "Classpath" exception as provided
1.12 + * by Oracle in the LICENSE file that accompanied this code.
1.13 + *
1.14 + * This code is distributed in the hope that it will be useful, but WITHOUT
1.15 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
1.16 + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
1.17 + * version 2 for more details (a copy is included in the LICENSE file that
1.18 + * accompanied this code).
1.19 + *
1.20 + * You should have received a copy of the GNU General Public License version
1.21 + * 2 along with this work; if not, write to the Free Software Foundation,
1.22 + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
1.23 + *
1.24 + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
1.25 + * or visit www.oracle.com if you need additional information or have any
1.26 + * questions.
1.27 + */
1.28 +
1.29 +package com.sun.tools.doclets.internal.toolkit.taglets;
1.30 +
1.31 +import com.sun.javadoc.*;
1.32 +import com.sun.tools.doclets.formats.html.markup.RawHtml;
1.33 +import com.sun.tools.doclets.internal.toolkit.Content;
1.34 +
1.35 +/**
1.36 + * This taglet acts as a wrapper to enable
1.37 + * {@link com.sun.tools.doclets.Taglet} type taglets to work
1.38 + * with the current version of Javadoc.
1.39 + * Note: this taglet only works with legacy taglets (those compatible with
1.40 + * Javadoc 1.4.x) that writes strings.
1.41 + * This taglet is able to wrap most most legacy taglets because
1.42 + * the standard doclet is the only known doclet to use legacy taglets.
1.43 + *
1.44 + * <p><b>This is NOT part of any supported API.
1.45 + * If you write code that depends on this, you do so at your own risk.
1.46 + * This code and its internal interfaces are subject to change or
1.47 + * deletion without notice.</b>
1.48 + *
1.49 + * @since 1.5
1.50 + * @author Jamie Ho
1.51 + */
1.52 +
1.53 +public class LegacyTaglet implements Taglet {
1.54 +
1.55 + private com.sun.tools.doclets.Taglet legacyTaglet;
1.56 +
1.57 + public LegacyTaglet(com.sun.tools.doclets.Taglet t) {
1.58 + legacyTaglet = t;
1.59 + }
1.60 +
1.61 + /**
1.62 + * {@inheritDoc}
1.63 + */
1.64 + public boolean inField() {
1.65 + return legacyTaglet.isInlineTag() || legacyTaglet.inField();
1.66 + }
1.67 +
1.68 + /**
1.69 + * {@inheritDoc}
1.70 + */
1.71 + public boolean inConstructor() {
1.72 + return legacyTaglet.isInlineTag() || legacyTaglet.inConstructor();
1.73 + }
1.74 +
1.75 + /**
1.76 + * {@inheritDoc}
1.77 + */
1.78 + public boolean inMethod() {
1.79 + return legacyTaglet.isInlineTag() || legacyTaglet.inMethod();
1.80 + }
1.81 +
1.82 + /**
1.83 + * {@inheritDoc}
1.84 + */
1.85 + public boolean inOverview() {
1.86 + return legacyTaglet.isInlineTag() || legacyTaglet.inOverview();
1.87 + }
1.88 +
1.89 + /**
1.90 + * {@inheritDoc}
1.91 + */
1.92 + public boolean inPackage() {
1.93 + return legacyTaglet.isInlineTag() || legacyTaglet.inPackage();
1.94 + }
1.95 +
1.96 + /**
1.97 + * {@inheritDoc}
1.98 + */
1.99 + public boolean inType() {
1.100 + return legacyTaglet.isInlineTag() || legacyTaglet.inType();
1.101 + }
1.102 +
1.103 + /**
1.104 + * Return true if this <code>Taglet</code>
1.105 + * is an inline tag.
1.106 + * @return true if this <code>Taglet</code>
1.107 + * is an inline tag and false otherwise.
1.108 + */
1.109 + public boolean isInlineTag() {
1.110 + return legacyTaglet.isInlineTag();
1.111 + }
1.112 +
1.113 + /**
1.114 + * {@inheritDoc}
1.115 + */
1.116 + public String getName() {
1.117 + return legacyTaglet.getName();
1.118 + }
1.119 +
1.120 + /**
1.121 + * {@inheritDoc}
1.122 + */
1.123 + public Content getTagletOutput(Tag tag, TagletWriter writer)
1.124 + throws IllegalArgumentException {
1.125 + Content output = writer.getOutputInstance();
1.126 + output.addContent(new RawHtml(legacyTaglet.toString(tag)));
1.127 + return output;
1.128 + }
1.129 +
1.130 + /**
1.131 + * {@inheritDoc}
1.132 + */
1.133 + public Content getTagletOutput(Doc holder, TagletWriter writer)
1.134 + throws IllegalArgumentException {
1.135 + Content output = writer.getOutputInstance();
1.136 + Tag[] tags = holder.tags(getName());
1.137 + if (tags.length > 0) {
1.138 + String tagString = legacyTaglet.toString(tags);
1.139 + if (tagString != null) {
1.140 + output.addContent(new RawHtml(tagString));
1.141 + }
1.142 + }
1.143 + return output;
1.144 + }
1.145 +}
