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

test/com/sun/javadoc/testLegacyTaglet/UnderlineTaglet.java@2eb010b6cb22 (annotated)

test/com/sun/javadoc/testLegacyTaglet/UnderlineTaglet.java

Thu, 31 Aug 2017 15:17:03 +0800

author

aoqi

date

Thu, 31 Aug 2017 15:17:03 +0800

changeset 2525

2eb010b6cb22

parent 554

9d9f26857129

parent 0

959103a6100f

permissions

-rw-r--r--

merge

aoqi@0	1	/*
aoqi@0	2	* Copyright (c) 2003, 2007, 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.
aoqi@0	8	*
aoqi@0	9	* This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0	10	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0	11	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
aoqi@0	12	* version 2 for more details (a copy is included in the LICENSE file that
aoqi@0	13	* accompanied this code).
aoqi@0	14	*
aoqi@0	15	* You should have received a copy of the GNU General Public License version
aoqi@0	16	* 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0	17	* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0	18	*
aoqi@0	19	* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0	20	* or visit www.oracle.com if you need additional information or have any
aoqi@0	21	* questions.
aoqi@0	22	*/
aoqi@0	23
aoqi@0	24	import com.sun.tools.doclets.Taglet;
aoqi@0	25	import com.sun.javadoc.*;
aoqi@0	26	import java.util.Map;
aoqi@0	27
aoqi@0	28	/**
aoqi@0	29	* A sample Inline Taglet representing {@underline ...}. This tag can be used in any kind of
aoqi@0	30	* {@link com.sun.javadoc.Doc}. The text is simple underlined. For
aoqi@0	31	* example, "@underline UNDERLINE ME" would be shown as: <u>UNDERLINE ME</u>.
aoqi@0	32	*
aoqi@0	33	* @author Jamie Ho
aoqi@0	34	* @since 1.4
aoqi@0	35	*/
aoqi@0	36
aoqi@0	37	public class UnderlineTaglet implements Taglet {
aoqi@0	38
aoqi@0	39	private String NAME = "underline";
aoqi@0	40
aoqi@0	41	/**
aoqi@0	42	* Return the name of this custom tag.
aoqi@0	43	*/
aoqi@0	44	public String getName() {
aoqi@0	45	return NAME;
aoqi@0	46	}
aoqi@0	47
aoqi@0	48	/**
aoqi@0	49	* Will return false since this is an inline tag.
aoqi@0	50	* @return false since this is an inline tag.
aoqi@0	51	*/
aoqi@0	52	public boolean inField() {
aoqi@0	53	return false;
aoqi@0	54	}
aoqi@0	55
aoqi@0	56	/**
aoqi@0	57	* Will return false since this is an inline tag.
aoqi@0	58	* @return false since this is an inline tag.
aoqi@0	59	*/
aoqi@0	60	public boolean inConstructor() {
aoqi@0	61	return true;
aoqi@0	62	}
aoqi@0	63
aoqi@0	64	/**
aoqi@0	65	* Will return false since this is an inline tag.
aoqi@0	66	* @return false since this is an inline tag.
aoqi@0	67	*/
aoqi@0	68	public boolean inMethod() {
aoqi@0	69	return false;
aoqi@0	70	}
aoqi@0	71
aoqi@0	72	/**
aoqi@0	73	* Will return false since this is an inline tag.
aoqi@0	74	* @return false since this is an inline tag.
aoqi@0	75	*/
aoqi@0	76	public boolean inOverview() {
aoqi@0	77	return false;
aoqi@0	78	}
aoqi@0	79
aoqi@0	80	/**
aoqi@0	81	* Will return false since this is an inline tag.
aoqi@0	82	* @return false since this is an inline tag.
aoqi@0	83	*/
aoqi@0	84	public boolean inPackage() {
aoqi@0	85	return false;
aoqi@0	86	}
aoqi@0	87
aoqi@0	88	/**
aoqi@0	89	* Will return false since this is an inline tag.
aoqi@0	90	* @return false since this is an inline tag.
aoqi@0	91	*/
aoqi@0	92	public boolean inType() {
aoqi@0	93	return false;
aoqi@0	94	}
aoqi@0	95
aoqi@0	96	/**
aoqi@0	97	* Will return true since this is an inline tag.
aoqi@0	98	* @return true since this is an inline tag.
aoqi@0	99	*/
aoqi@0	100
aoqi@0	101	public boolean isInlineTag() {
aoqi@0	102	return true;
aoqi@0	103	}
aoqi@0	104
aoqi@0	105	/**
aoqi@0	106	* Register this Taglet.
aoqi@0	107	* @param tagletMap the map to register this tag to.
aoqi@0	108	*/
aoqi@0	109	public static void register(Map tagletMap) {
aoqi@0	110	UnderlineTaglet tag = new UnderlineTaglet();
aoqi@0	111	Taglet t = (Taglet) tagletMap.get(tag.getName());
aoqi@0	112	if (t != null) {
aoqi@0	113	tagletMap.remove(tag.getName());
aoqi@0	114	}
aoqi@0	115	tagletMap.put(tag.getName(), tag);
aoqi@0	116	}
aoqi@0	117
aoqi@0	118	/**
aoqi@0	119	* Given the <code>Tag</code> representation of this custom
aoqi@0	120	* tag, return its string representation.
aoqi@0	121	* @param tag he <code>Tag</code> representation of this custom tag.
aoqi@0	122	*/
aoqi@0	123	public String toString(Tag tag) {
aoqi@0	124	return "<u>" + tag.text() + "</u>";
aoqi@0	125	}
aoqi@0	126
aoqi@0	127	/**
aoqi@0	128	* This method should not be called since arrays of inline tags do not
aoqi@0	129	* exist. Method {@link #tostring(Tag)} should be used to convert this
aoqi@0	130	* inline tag to a string.
aoqi@0	131	* @param tags the array of <code>Tag</code>s representing of this custom tag.
aoqi@0	132	*/
aoqi@0	133	public String toString(Tag[] tags) {
aoqi@0	134	return null;
aoqi@0	135	}
aoqi@0	136	}