Module jdk.javadoc

Package jdk.javadoc.doclet.taglet

Interface Taglet

public interface Taglet

The interface for a custom tag used by Doclets. A custom tag must implement this interface, and must have a public default constructor (i.e. a public constructor with no parameters), by which, the doclet will instantiate and register the custom tag.

Since:

9

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Taglet.Location	The kind of location.

Method Summary

Modifier and Type	Method	Description
Set<Taglet.Location>	getAllowedLocations()	Returns the set of locations in which a taglet may be used.
String	getName()	Returns the name of the tag.
boolean	isInlineTag()	Indicates the tag is an inline or a body tag.
String	toString(com.sun.source.doctree.DocTree tag)	Given the DocTree representation of this custom tag, return its string representation, which is output to the generated page.
String	toString(List<? extends com.sun.source.doctree.DocTree> tags)	Given a List of DocTrees representing this custom tag, return its string representation, which is output to the generated page.

Method Detail

getAllowedLocations

Set<Taglet.Location> getAllowedLocations()

Returns the set of locations in which a taglet may be used.

Returns:

the set of locations in which a taglet may be used allowed in or an empty set.

isInlineTag

boolean isInlineTag()

Indicates the tag is an inline or a body tag.

Returns:

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

getName

String getName()

Returns the name of the tag.

Returns:

the name of this custom tag.

toString

String toString(com.sun.source.doctree.DocTree tag)

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

Parameters:

tag - the Tag representation of this custom tag.

Returns:

the string representation of this Tag.

toString

String toString(List<? extends com.sun.source.doctree.DocTree> tags)

Given a List of DocTrees representing this custom tag, return its string representation, which is output to the generated page. This method should return null if this taglet represents an inline or body tag.

Parameters:

tags - the list of DocTrees representing this custom tag.

Returns:

the string representation of this Tag.