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

public Class BaseTaglet

extends Object
implements Taglet
Class Inheritance
All Implemented Interfaces
jdk.javadoc.internal.doclets.formats.html.taglets.Taglet
Known Direct Subclasses
jdk.javadoc.internal.doclets.formats.html.taglets.DeprecatedTaglet, jdk.javadoc.internal.doclets.formats.html.taglets.DocRootTaglet, jdk.javadoc.internal.doclets.formats.html.taglets.IndexTaglet, jdk.javadoc.internal.doclets.formats.html.taglets.InheritDocTaglet, jdk.javadoc.internal.doclets.formats.html.taglets.LinkTaglet, jdk.javadoc.internal.doclets.formats.html.taglets.LiteralTaglet, jdk.javadoc.internal.doclets.formats.html.taglets.ParamTaglet, jdk.javadoc.internal.doclets.formats.html.taglets.ReturnTaglet, jdk.javadoc.internal.doclets.formats.html.taglets.SeeTaglet, jdk.javadoc.internal.doclets.formats.html.taglets.SimpleTaglet, jdk.javadoc.internal.doclets.formats.html.taglets.SnippetTaglet, jdk.javadoc.internal.doclets.formats.html.taglets.SpecTaglet, jdk.javadoc.internal.doclets.formats.html.taglets.SummaryTaglet, jdk.javadoc.internal.doclets.formats.html.taglets.SystemPropertyTaglet, jdk.javadoc.internal.doclets.formats.html.taglets.ThrowsTaglet, jdk.javadoc.internal.doclets.formats.html.taglets.ValueTaglet
Imports
java.util.Set, javax.lang.model.element.Element, com.sun.source.doctree.DocTree, jdk.javadoc.doclet.Taglet.Location, jdk.javadoc.internal.doclets.formats.html.HtmlConfiguration, jdk.javadoc.internal.doclets.toolkit.Messages, .Resources, jdk.javadoc.internal.doclets.toolkit.util.Utils, jdk.javadoc.internal.html.Content
A base class that implements the Taglet interface.

Field Summary

Modifier and TypeField and Description
protected final HtmlConfiguration
config

private final boolean
inline

protected final Messages
messages

protected final String
name

protected final Resources
resources

private final Set<Taglet.Location>
sites

protected final DocTree.Kind
tagKind

protected TagletWriter
tagletWriter

protected final Utils
utils

Constructor Summary

AccessConstructor and Description
public
BaseTaglet(HtmlConfiguration config, DocTree.Kind tagKind, boolean inline, Set<Taglet.Location> sites)

protected
BaseTaglet(HtmlConfiguration config, String name, boolean inline, Set<Taglet.Location> sites)

private
BaseTaglet(HtmlConfiguration config, String name, DocTree.Kind tagKind, boolean inline, Set<Taglet.Location> sites)

Method Summary

Modifier and TypeMethod and Description
public Content
getAllBlockTagOutput(Element holder, TagletWriter 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 element, DocTree tag, TagletWriter 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 DocTree.Kind

Returns:

the kind of trees recognized by this taglet
getTagKind()

Returns the kind of trees recognized by this taglet.

public final 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

configback to summary
protected final HtmlConfiguration config
inlineback to summary
private final boolean inline
messagesback to summary
protected final Messages messages
nameback to summary
protected final String name
resourcesback to summary
protected final Resources resources
sitesback to summary
private final Set<Taglet.Location> sites
tagKindback to summary
protected final DocTree.Kind tagKind
tagletWriterback to summary
protected TagletWriter tagletWriter
utilsback to summary
protected final Utils utils

Constructor Detail

BaseTagletback to summary
public BaseTaglet(HtmlConfiguration config, DocTree.Kind tagKind, boolean inline, Set<Taglet.Location> sites)
BaseTagletback to summary
protected BaseTaglet(HtmlConfiguration config, String name, boolean inline, Set<Taglet.Location> sites)
BaseTagletback to summary
private BaseTaglet(HtmlConfiguration config, String name, DocTree.Kind tagKind, boolean inline, Set<Taglet.Location> sites)

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.

Implementation Specification

This implementation throws UnsupportedTagletOperationException

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.

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.

Implementation Specification

This implementation throws UnsupportedTagletOperationException.

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.

Annotations
@Override
getTagKindback to summary
public DocTree.Kind getTagKind()

Returns the kind of trees recognized by this taglet.

Returns:DocTree.Kind

the kind of trees recognized by this taglet

isInlineTagback to summary
public final 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.

Annotations
@Override