Top Description Fields Constructors Methods
jdk.javadoc.internal.doclets.formats.html.taglets

public final Class UserTaglet

extends Object
implements Taglet
Class Inheritance
All Implemented Interfaces
jdk.javadoc.internal.doclets.formats.html.taglets.Taglet
Imports
java.util.List, .Set, javax.lang.model.element.Element, com.sun.source.doctree.DocTree, jdk.javadoc.internal.doclets.formats.html.markup.RawHtml, jdk.javadoc.internal.doclets.formats.html.Content
A taglet wrapper, allows the public taglet jdk.javadoc.doclet.Taglet wrapped into an internal Taglet representation.

Field Summary

Modifier and TypeField and Description
private final Taglet
userTaglet

Constructor Summary

AccessConstructor and Description
pack-priv
UserTaglet(Taglet t)

Method Summary

Modifier and TypeMethod and Description
public Content
getAllBlockTagOutput(Element
the element for the enclosing doc comment
holder, TagletWriter
the taglet-writer used in this doclet
tagletWriter)

Implements jdk.javadoc.internal.doclets.formats.html.taglets.Taglet.getAllBlockTagOutput.

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

public Set<Taglet.Location>
getAllowedLocations()

Implements jdk.javadoc.internal.doclets.formats.html.taglets.Taglet.getAllowedLocations.

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

public Content
getInlineTagOutput(Element
the element for the enclosing doc comment
element, DocTree
the tag
tag, TagletWriter
the taglet-writer used in this doclet
tagletWriter)

Implements jdk.javadoc.internal.doclets.formats.html.taglets.Taglet.getInlineTagOutput.

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

public String
getName()

Implements jdk.javadoc.internal.doclets.formats.html.taglets.Taglet.getName.

Returns the name of this tag.

public boolean
isBlockTag()

Overrides default jdk.javadoc.internal.doclets.formats.html.taglets.Taglet.isBlockTag.

Indicates whether this Taglet represents a block tag.

public boolean
isInlineTag()

Implements jdk.javadoc.internal.doclets.formats.html.taglets.Taglet.isInlineTag.

Indicates whether this Taglet represents an inline tag.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

userTagletback to summary
private final Taglet userTaglet

Constructor Detail

UserTagletback to summary
pack-priv UserTaglet(Taglet t)

Method Detail

getAllBlockTagOutputback to summary
public Content getAllBlockTagOutput(Element holder, TagletWriter tagletWriter)

Implements jdk.javadoc.internal.doclets.formats.html.taglets.Taglet.getAllBlockTagOutput.

Doc from jdk.javadoc.internal.doclets.formats.html.taglets.Taglet.getAllBlockTagOutput.

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

Parameters
holder:Element

the element for the enclosing doc comment

tagletWriter:TagletWriter

the taglet-writer used in this doclet

Returns:Content

the output for this tag

Annotations
@Override
getAllowedLocationsback to summary
public Set<Taglet.Location> getAllowedLocations()

Implements jdk.javadoc.internal.doclets.formats.html.taglets.Taglet.getAllowedLocations.

Doc from jdk.javadoc.internal.doclets.formats.html.taglets.Taglet.getAllowedLocations.

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

Returns:Set<Taglet.Location>

the set of allowable locations

Annotations
@Override
getInlineTagOutputback to summary
public Content getInlineTagOutput(Element element, DocTree tag, TagletWriter tagletWriter)

Implements jdk.javadoc.internal.doclets.formats.html.taglets.Taglet.getInlineTagOutput.

Doc from jdk.javadoc.internal.doclets.formats.html.taglets.Taglet.getInlineTagOutput.

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

Parameters
element: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

Annotations
@Override
getNameback to summary
public String getName()

Implements jdk.javadoc.internal.doclets.formats.html.taglets.Taglet.getName.

Doc from jdk.javadoc.internal.doclets.formats.html.taglets.Taglet.getName.

Returns the name of this tag.

Returns:String

the name of this tag

Annotations
@Override
isBlockTagback to summary
public boolean isBlockTag()

Overrides default jdk.javadoc.internal.doclets.formats.html.taglets.Taglet.isBlockTag.

Doc from jdk.javadoc.internal.doclets.formats.html.taglets.Taglet.isBlockTag.

Indicates whether this Taglet represents a block tag.

Returns:boolean

true if this Taglet represents a block tag

Annotations
@Override
isInlineTagback to summary
public boolean isInlineTag()

Implements jdk.javadoc.internal.doclets.formats.html.taglets.Taglet.isInlineTag.

Doc from jdk.javadoc.internal.doclets.formats.html.taglets.Taglet.isInlineTag.

Indicates whether this Taglet represents an inline tag.

Returns:boolean

true if this Taglet represents an inline tag and false otherwise

Annotations
@Override