OpenJDK 1.23 · jdk.javadoc.internal.doclets.formats.html.taglets.Taglet

Modifier and Type	Class and Description
public static class	Taglet.UnsupportedTagletOperationException

Method Summary

Modifier and Type	Method and Description
public Content	Returns: the output for this tag getAllBlockTagOutput(Element the element for the enclosing doc comment owner, TagletWriter the taglet-writer used in this doclet tagletWriter) Returns the content to be included in the generated output for all instances of block tags handled by this taglet.
public Set<Taglet.Location>	Returns: the set of allowable locations getAllowedLocations() Returns the set of allowed locations for a block tag handled by this taglet.
public Content	Returns: the output for this tag getInlineTagOutput(Element the element for the enclosing doc comment owner, DocTree the tag tag, TagletWriter the taglet-writer used in this doclet tagletWriter) Returns the content to be included in the generated output for an instance of an inline tag handled by this taglet.
public String	Returns: the name of this tag getName() Returns the name of this tag.
public default boolean	Returns: `true` if this `Taglet` can be used in constructor documentation and `false` otherwise inConstructor() Indicates whether this `Taglet` can be used in constructor documentation.
public default boolean	Returns: `true` if this `Taglet` can be used in field documentation and `false` otherwise inField() Indicates whether this `Taglet` can be used in field documentation.
public default boolean	Returns: `true` if this `Taglet` can be used in method documentation and `false` otherwise inMethod() Indicates whether this `Taglet` can be used in method documentation.
public default boolean	Returns: `true` if this `Taglet` can be used in module documentation and `false` otherwise inModule() Indicates whether this `Taglet` can be used in module documentation.
public default boolean	Returns: `true` if this `Taglet` can be used in overview documentation and `false` otherwise inOverview() Indicates whether this `Taglet` can be used in overview documentation.
public default boolean	Returns: `true` if this `Taglet` can be used in package documentation and `false` otherwise inPackage() Indicates whether this `Taglet` can be used in package documentation.
public default boolean	Returns: `true` if this `Taglet` can be used in type documentation and `false` otherwise inType() Indicates whether this `Taglet` can be used in type documentation (classes or interfaces).
public default boolean	Returns: `true` if this `Taglet` represents a block tag isBlockTag() Indicates whether this `Taglet` represents a block tag.
public boolean	Returns: `true` if this `Taglet` represents an inline tag and `false` otherwise isInlineTag() Indicates whether this `Taglet` represents an inline tag.

Method Detail

getAllBlockTagOutput	back to summary
public Content getAllBlockTagOutput(Element owner, TagletWriter tagletWriter) throws UnsupportedTagletOperationException Returns the content to be included in the generated output for all instances of block tags handled by this taglet. Parameters owner:Element the element for the enclosing doc comment tagletWriter:TagletWriter the taglet-writer used in this doclet Returns:Content the output for this tag Exceptions UnsupportedTagletOperationException: if the method is not supported by the taglet

getAllBlockTagOutput

back to summary

public Content getAllBlockTagOutput(Element owner, TagletWriter tagletWriter) throws UnsupportedTagletOperationException

Returns the content to be included in the generated output for all instances of block tags handled by this taglet.

Parameters

owner:Element: the element for the enclosing doc comment
tagletWriter:TagletWriter: the taglet-writer used in this doclet

Returns:Content

the output for this tag

Exceptions

UnsupportedTagletOperationException:: if the method is not supported by the taglet

getAllowedLocations	back to summary
public Set<Taglet.Location> getAllowedLocations() Returns the set of allowed locations for a block tag handled by this taglet. Returns:Set<Taglet.Location> the set of allowable locations

getAllowedLocations

back to summary

public Set<Taglet.Location> getAllowedLocations()

Returns the set of allowed locations for a block tag handled by this taglet.

Returns:Set<Taglet.Location>: the set of allowable locations

getInlineTagOutput	back to summary
public Content getInlineTagOutput(Element owner, DocTree tag, TagletWriter tagletWriter) throws UnsupportedTagletOperationException Returns the content to be included in the generated output for an instance of an inline tag handled by this taglet. Parameters owner:Element the element for the enclosing doc comment tag:DocTree the tag tagletWriter:TagletWriter the taglet-writer used in this doclet Returns:Content the output for this tag Exceptions UnsupportedTagletOperationException: if the method is not supported by the taglet

getInlineTagOutput

back to summary

public Content getInlineTagOutput(Element owner, DocTree tag, TagletWriter tagletWriter) throws UnsupportedTagletOperationException

Returns the content to be included in the generated output for an instance of an inline tag handled by this taglet.

Parameters

owner:Element: the element for the enclosing doc comment
tag:DocTree: the tag
tagletWriter:TagletWriter: the taglet-writer used in this doclet

Returns:Content

the output for this tag

Exceptions

UnsupportedTagletOperationException:: if the method is not supported by the taglet

getName	back to summary
public String getName() Returns the name of this tag. Returns:String the name of this tag

getName

back to summary

public String getName()

Returns the name of this tag.

Returns:String: the name of this tag

inConstructor back to summary

inConstructor	back to summary
public default boolean inConstructor() Indicates whether this `Taglet` can be used in constructor documentation. Returns:boolean `true` if this `Taglet` can be used in constructor documentation and `false` otherwise

public default boolean inConstructor()

Indicates whether this Taglet can be used in constructor documentation.

Returns:boolean: true if this Taglet can be used in constructor documentation and false otherwise

inField back to summary

inField	back to summary
public default boolean inField() Indicates whether this `Taglet` can be used in field documentation. Returns:boolean `true` if this `Taglet` can be used in field documentation and `false` otherwise

public default boolean inField()

Indicates whether this Taglet can be used in field documentation.

Returns:boolean: true if this Taglet can be used in field documentation and false otherwise

inMethod back to summary

inMethod	back to summary
public default boolean inMethod() Indicates whether this `Taglet` can be used in method documentation. Returns:boolean `true` if this `Taglet` can be used in method documentation and `false` otherwise

public default boolean inMethod()

Indicates whether this Taglet can be used in method documentation.

Returns:boolean: true if this Taglet can be used in method documentation and false otherwise

inModule back to summary

inModule	back to summary
public default boolean inModule() Indicates whether this `Taglet` can be used in module documentation. Returns:boolean `true` if this `Taglet` can be used in module documentation and `false` otherwise

public default boolean inModule()

Indicates whether this Taglet can be used in module documentation.

Returns:boolean: true if this Taglet can be used in module documentation and false otherwise

inOverview back to summary

inOverview	back to summary
public default boolean inOverview() Indicates whether this `Taglet` can be used in overview documentation. Returns:boolean `true` if this `Taglet` can be used in overview documentation and `false` otherwise

public default boolean inOverview()

Indicates whether this Taglet can be used in overview documentation.

Returns:boolean: true if this Taglet can be used in overview documentation and false otherwise

inPackage back to summary

inPackage	back to summary
public default boolean inPackage() Indicates whether this `Taglet` can be used in package documentation. Returns:boolean `true` if this `Taglet` can be used in package documentation and `false` otherwise

public default boolean inPackage()

Indicates whether this Taglet can be used in package documentation.

Returns:boolean: true if this Taglet can be used in package documentation and false otherwise

inType back to summary

inType	back to summary
public default boolean inType() Indicates whether this `Taglet` can be used in type documentation (classes or interfaces). Returns:boolean `true` if this `Taglet` can be used in type documentation and `false` otherwise

public default boolean inType()

Indicates whether this Taglet can be used in type documentation (classes or interfaces).

Returns:boolean: true if this Taglet can be used in type documentation and false otherwise

isBlockTag back to summary

isBlockTag	back to summary
public default boolean isBlockTag() Indicates whether this `Taglet` represents a block tag. Implementation Specification This implementation returns the inverse result to `isInlineTag`. Returns:boolean `true` if this `Taglet` represents a block tag

public default boolean isBlockTag()

Indicates whether this Taglet represents a block tag.

Implementation Specification

This implementation returns the inverse result to isInlineTag.

Returns:boolean: true if this Taglet represents a block tag

isInlineTag back to summary

isInlineTag	back to summary
public boolean isInlineTag() Indicates whether this `Taglet` represents an inline tag. Returns:boolean `true` if this `Taglet` represents an inline tag and `false` otherwise

public boolean isInlineTag()

Indicates whether this Taglet represents an inline tag.

Returns:boolean: true if this Taglet represents an inline tag and false otherwise

public Interface Taglet

Nested and Inner Type Summary

Method Summary

Method Detail

public Class Taglet.UnsupportedTagletOperationException

Field Summary

Constructor Summary

Field Detail

Constructor Detail