• file
• revisions
• annotate
• diff
• comparison
• raw

src/share/classes/com/sun/tools/doclets/internal/toolkit/taglets/LegacyTaglet.java@959103a6100f (annotated)

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

Wed, 27 Apr 2016 01:34:52 +0800

author

aoqi

date

Wed, 27 Apr 2016 01:34:52 +0800

changeset 0

959103a6100f

child 2525

2eb010b6cb22

permissions

-rw-r--r--

Initial load
http://hg.openjdk.java.net/jdk8u/jdk8u/langtools/
changeset: 2573:53ca196be1ae
tag: jdk8u25-b17

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