Interface Taglet
- All Known Subinterfaces:
InheritableTaglet
- All Known Implementing Classes:
BaseExecutableMemberTaglet
,BaseInlineTaglet
,BasePropertyTaglet
,BaseTaglet
,CodeTaglet
,DeprecatedTaglet
,DocRootTaglet
,IndexTaglet
,InheritDocTaglet
,LegacyTaglet
,LiteralTaglet
,ParamTaglet
,PropertyGetterTaglet
,PropertySetterTaglet
,ReturnTaglet
,SeeTaglet
,SimpleTaglet
,ThrowsTaglet
,ValueTaglet
Deprecated.
The interface for a custom tag used by Doclets. A custom
tag must implement this interface. To be loaded and used by
doclets at run-time, the taglet must have a static method called
register
that accepts a Map
as an
argument with the following signature:
public void register(Map map)This method should add an instance of the custom taglet to the map with the name of the taglet as the key. If overriding a taglet, to avoid a name conflict, the overridden taglet must be deleted from the map before an instance of the new taglet is added to the map.
It is recommended that the taglet throw an exception when it fails to register itself. The exception that it throws is up to the user.
Here are two sample taglets:
- ToDoTaglet.java - Standalone taglet
- UnderlineTaglet.java - Inline taglet
For more information on how to create your own Taglets, please see the Taglet Overview.
- Since:
- 1.4
-
Method Summary
Modifier and TypeMethodDescriptiongetName()
Deprecated.Return the name of this custom tag.getTagletOutput
(Doc holder, TagletWriter writer) Deprecated.Given aDoc
object, check if it holds any tags of this type.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
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
Deprecated.Return true if thisTaglet
is used in overview documentation.boolean
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
Deprecated.Return true if thisTaglet
is an inline tag.toString()
Deprecated.
-
Method Details
-
inField
boolean inField()Deprecated.Return true if thisTaglet
is used in field documentation.- Returns:
- true if this
Taglet
is used in field documentation and false otherwise.
-
inConstructor
boolean inConstructor()Deprecated.Return true if thisTaglet
is used in constructor documentation.- Returns:
- true if this
Taglet
is used in constructor documentation and false otherwise.
-
inMethod
boolean inMethod()Deprecated.Return true if thisTaglet
is used in method documentation.- Returns:
- true if this
Taglet
is used in method documentation and false otherwise.
-
inOverview
boolean inOverview()Deprecated.Return true if thisTaglet
is used in overview documentation.- Returns:
- true if this
Taglet
is used in method documentation and false otherwise.
-
inPackage
boolean inPackage()Deprecated.Return true if thisTaglet
is used in package documentation.- Returns:
- true if this
Taglet
is used in package documentation and false otherwise.
-
inType
boolean inType()Deprecated.Return true if thisTaglet
is used in type documentation (classes or interfaces).- Returns:
- true if this
Taglet
is used in type documentation and false otherwise.
-
isInlineTag
boolean isInlineTag()Deprecated.Return true if thisTaglet
is an inline tag. Return false otherwise.- Returns:
- true if this
Taglet
is an inline tag and false otherwise.
-
getName
String getName()Deprecated.Return the name of this custom tag.- Returns:
- the name of this custom tag.
-
getTagletOutput
Deprecated.Given theTag
representation of this custom tag, return its Content representation, which is output to the generated page.- 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
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.- 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.
-
toString
String toString()Deprecated.
-