com.sun.tools.doclets.internal.toolkit.taglets
Interface Taglet

All Known Subinterfaces:

InheritableTaglet

All Known Implementing Classes:

BaseExecutableMemberTaglet, BaseInlineTaglet, BaseTaglet, DeprecatedTaglet, DocRootTaglet, InheritDocTaglet, LegacyTaglet, ParamTaglet, ReturnTaglet, SeeTaglet, SimpleTaglet, ThrowsTaglet, ValueTaglet

public interface Taglet

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

java.lang.String	getName() Return the name of this custom tag.
TagletOutput	getTagletOutput(Doc holder, TagletWriter writer) Given a Doc object, check if it holds any tags of this type.
TagletOutput	getTagletOutput(Tag tag, TagletWriter writer) Given the Tag representation of this custom tag, return its TagletOutput representation, which is output to the generated page.
boolean	inConstructor() Return true if this Taglet is used in constructor documentation.
boolean	inField() Return true if this Taglet is used in field documentation.
boolean	inMethod() Return true if this Taglet is used in method documentation.
boolean	inOverview() Return true if this Taglet is used in overview documentation.
boolean	inPackage() Return true if this Taglet is used in package documentation.
boolean	inType() Return true if this Taglet is used in type documentation (classes or interfaces).
boolean	isInlineTag() Return true if this Taglet is an inline tag.

Method Detail

inField

boolean inField()

Return true if this Taglet is used in field documentation.

Returns:

true if this Taglet is used in field documentation and false otherwise.

inConstructor

boolean inConstructor()

Return true if this Taglet is used in constructor documentation.

Returns:

true if this Taglet is used in constructor documentation and false otherwise.

inMethod

boolean inMethod()

Return true if this Taglet is used in method documentation.

Returns:

true if this Taglet is used in method documentation and false otherwise.

inOverview

boolean inOverview()

Return true if this Taglet is used in overview documentation.

Returns:

true if this Taglet is used in method documentation and false otherwise.

inPackage

boolean inPackage()

Return true if this Taglet is used in package documentation.

Returns:

true if this Taglet is used in package documentation and false otherwise.

inType

boolean inType()

Return true if this Taglet is used in type documentation (classes or interfaces).

Returns:

true if this Taglet is used in type documentation and false otherwise.

isInlineTag

boolean isInlineTag()

Return true if this Taglet is an inline tag. Return false otherwise.

Returns:

true if this Taglet is an inline tag and false otherwise.

getName

java.lang.String getName()

Return the name of this custom tag.

Returns:

the name of this custom tag.

getTagletOutput

TagletOutput getTagletOutput(Tag tag,
                             TagletWriter writer)
                             throws java.lang.IllegalArgumentException

Given the Tag representation of this custom tag, return its TagletOutput representation, which is output to the generated page.

Parameters:

tag - the Tag representation of this custom tag.

writer - a TagletWriter Taglet writer.

Returns:

the TagletOutput representation of this Tag.

Throws:

java.lang.IllegalArgumentException - thrown when the method is not supported by the taglet.

getTagletOutput

TagletOutput getTagletOutput(Doc holder,
                             TagletWriter writer)
                             throws java.lang.IllegalArgumentException

Given a Doc 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 - a Doc object holding the custom tag.

writer - a TagletWriter Taglet writer.

Returns:

the TagletOutput representation of this Tag.

Throws:

java.lang.IllegalArgumentException - thrown when the method is not supported by the taglet.