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

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

src/share/classes/com/sun/tools/doclets/internal/toolkit/taglets/BaseTaglet.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.internal.toolkit.Content;
aoqi@0	30
aoqi@0	31	/**
aoqi@0	32	* An abstract class for that implements the {@link Taglet} interface.
aoqi@0	33	*
aoqi@0	34	* <p><b>This is NOT part of any supported API.
aoqi@0	35	* If you write code that depends on this, you do so at your own risk.
aoqi@0	36	* This code and its internal interfaces are subject to change or
aoqi@0	37	* deletion without notice.</b>
aoqi@0	38	*
aoqi@0	39	* @author Jamie Ho
aoqi@0	40	* @since 1.4
aoqi@0	41	*/
aoqi@0	42	public abstract class BaseTaglet implements Taglet {
aoqi@0	43
aoqi@0	44	protected String name = "Default";
aoqi@0	45
aoqi@0	46	/**
aoqi@0	47	* Return true if this <code>Taglet</code>
aoqi@0	48	* is used in constructor documentation.
aoqi@0	49	* @return true if this <code>Taglet</code>
aoqi@0	50	* is used in constructor documentation and false
aoqi@0	51	* otherwise.
aoqi@0	52	*/
aoqi@0	53	public boolean inConstructor() {
aoqi@0	54	return true;
aoqi@0	55	}
aoqi@0	56
aoqi@0	57	/**
aoqi@0	58	* Return true if this <code>Taglet</code>
aoqi@0	59	* is used in field documentation.
aoqi@0	60	* @return true if this <code>Taglet</code>
aoqi@0	61	* is used in field documentation and false
aoqi@0	62	* otherwise.
aoqi@0	63	*/
aoqi@0	64	public boolean inField() {
aoqi@0	65	return true;
aoqi@0	66	}
aoqi@0	67
aoqi@0	68	/**
aoqi@0	69	* Return true if this <code>Taglet</code>
aoqi@0	70	* is used in method documentation.
aoqi@0	71	* @return true if this <code>Taglet</code>
aoqi@0	72	* is used in method documentation and false
aoqi@0	73	* otherwise.
aoqi@0	74	*/
aoqi@0	75	public boolean inMethod() {
aoqi@0	76	return true;
aoqi@0	77	}
aoqi@0	78
aoqi@0	79	/**
aoqi@0	80	* Return true if this <code>Taglet</code>
aoqi@0	81	* is used in overview documentation.
aoqi@0	82	* @return true if this <code>Taglet</code>
aoqi@0	83	* is used in method documentation and false
aoqi@0	84	* otherwise.
aoqi@0	85	*/
aoqi@0	86	public boolean inOverview() {
aoqi@0	87	return true;
aoqi@0	88	}
aoqi@0	89
aoqi@0	90	/**
aoqi@0	91	* Return true if this <code>Taglet</code>
aoqi@0	92	* is used in package documentation.
aoqi@0	93	* @return true if this <code>Taglet</code>
aoqi@0	94	* is used in package documentation and false
aoqi@0	95	* otherwise.
aoqi@0	96	*/
aoqi@0	97	public boolean inPackage() {
aoqi@0	98	return true;
aoqi@0	99	}
aoqi@0	100
aoqi@0	101	/**
aoqi@0	102	* Return true if this <code>Taglet</code>
aoqi@0	103	* is used in type documentation (classes or interfaces).
aoqi@0	104	* @return true if this <code>Taglet</code>
aoqi@0	105	* is used in type documentation and false
aoqi@0	106	* otherwise.
aoqi@0	107	*/
aoqi@0	108	public boolean inType() {
aoqi@0	109	return true;
aoqi@0	110	}
aoqi@0	111
aoqi@0	112	/**
aoqi@0	113	* Return true if this <code>Taglet</code>
aoqi@0	114	* is an inline tag.
aoqi@0	115	* @return true if this <code>Taglet</code>
aoqi@0	116	* is an inline tag and false otherwise.
aoqi@0	117	*/
aoqi@0	118	public boolean isInlineTag() {
aoqi@0	119	return false;
aoqi@0	120	}
aoqi@0	121
aoqi@0	122	/**
aoqi@0	123	* Return the name of this custom tag.
aoqi@0	124	* @return the name of this custom tag.
aoqi@0	125	*/
aoqi@0	126	public String getName() {
aoqi@0	127	return name;
aoqi@0	128	}
aoqi@0	129
aoqi@0	130	/**
aoqi@0	131	* {@inheritDoc}
aoqi@0	132	* @throws IllegalArgumentException thrown when the method is not supported by the taglet.
aoqi@0	133	*/
aoqi@0	134	public Content getTagletOutput(Tag tag, TagletWriter writer) {
aoqi@0	135	throw new IllegalArgumentException("Method not supported in taglet " + getName() + ".");
aoqi@0	136	}
aoqi@0	137
aoqi@0	138	/**
aoqi@0	139	* {@inheritDoc}
aoqi@0	140	* @throws IllegalArgumentException thrown when the method is not supported by the taglet.
aoqi@0	141	*/
aoqi@0	142	public Content getTagletOutput(Doc holder, TagletWriter writer) {
aoqi@0	143	throw new IllegalArgumentException("Method not supported in taglet " + getName() + ".");
aoqi@0	144	}
aoqi@0	145	}