Class BaseTaglet
- java.lang.Object
-
- gw.gosudoc.com.sun.tools.doclets.internal.toolkit.taglets.BaseTaglet
-
- All Implemented Interfaces:
Taglet
- Direct Known Subclasses:
BaseExecutableMemberTaglet
,BaseInlineTaglet
,BasePropertyTaglet
,DeprecatedTaglet
,ParamTaglet
,SeeTaglet
,SimpleTaglet
@Deprecated public abstract class BaseTaglet extends Object implements Taglet
Deprecated.An abstract class for that implements theTaglet
interface.This is NOT part of any supported API. If you write code that depends on this, you do so at your own risk. This code and its internal interfaces are subject to change or deletion without notice.
- Since:
- 1.4
- Author:
- Jamie Ho
-
-
Constructor Summary
Constructors Constructor Description BaseTaglet()
Deprecated.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description String
getName()
Deprecated.Return the name of this custom tag.Content
getTagletOutput(Doc holder, TagletWriter writer)
Deprecated.Given aDoc
object, check if it holds any tags of this type.Content
getTagletOutput(Tag tag, TagletWriter writer)
Deprecated.Given theTag
representation of this custom tag, return its Content representation, which is output to the generated page.boolean
inConstructor()
Deprecated.Return true if thisTaglet
is used in constructor documentation.boolean
inField()
Deprecated.Return true if thisTaglet
is used in field documentation.boolean
inMethod()
Deprecated.Return true if thisTaglet
is used in method documentation.boolean
inOverview()
Deprecated.Return true if thisTaglet
is used in overview documentation.boolean
inPackage()
Deprecated.Return true if thisTaglet
is used in package documentation.boolean
inType()
Deprecated.Return true if thisTaglet
is used in type documentation (classes or interfaces).boolean
isInlineTag()
Deprecated.Return true if thisTaglet
is an inline tag.
-
-
-
Field Detail
-
name
protected String name
Deprecated.
-
-
Method Detail
-
inConstructor
public boolean inConstructor()
Deprecated.Return true if thisTaglet
is used in constructor documentation.- Specified by:
inConstructor
in interfaceTaglet
- Returns:
- true if this
Taglet
is used in constructor documentation and false otherwise.
-
inField
public boolean inField()
Deprecated.Return true if thisTaglet
is used in field documentation.
-
inMethod
public boolean inMethod()
Deprecated.Return true if thisTaglet
is used in method documentation.
-
inOverview
public boolean inOverview()
Deprecated.Return true if thisTaglet
is used in overview documentation.- Specified by:
inOverview
in interfaceTaglet
- Returns:
- true if this
Taglet
is used in method documentation and false otherwise.
-
inPackage
public boolean inPackage()
Deprecated.Return true if thisTaglet
is used in package documentation.
-
inType
public boolean inType()
Deprecated.Return true if thisTaglet
is used in type documentation (classes or interfaces).
-
isInlineTag
public boolean isInlineTag()
Deprecated.Return true if thisTaglet
is an inline tag.- Specified by:
isInlineTag
in interfaceTaglet
- Returns:
- true if this
Taglet
is an inline tag and false otherwise.
-
getName
public String getName()
Deprecated.Return the name of this custom tag.
-
getTagletOutput
public Content getTagletOutput(Tag tag, TagletWriter writer)
Deprecated.Given theTag
representation of this custom tag, return its Content representation, which is output to the generated page.- Specified by:
getTagletOutput
in interfaceTaglet
- Parameters:
tag
- theTag
representation of this custom tag.writer
- aTagletWriter
Taglet writer.- Returns:
- the Content representation of this
Tag
. - Throws:
IllegalArgumentException
- thrown when the method is not supported by the taglet.
-
getTagletOutput
public Content getTagletOutput(Doc holder, TagletWriter writer)
Deprecated.Given aDoc
object, check if it holds any tags of this type. If it does, return the string representing the output. If it does not, return null.- Specified by:
getTagletOutput
in interfaceTaglet
- Parameters:
holder
- aDoc
object holding the custom tag.writer
- aTagletWriter
Taglet writer.- Returns:
- the TagletOutput representation of this
Tag
. - Throws:
IllegalArgumentException
- thrown when the method is not supported by the taglet.
-
-