OpenJDK 27 · jdk.javadoc.internal.doclets.formats.html.taglets.TagletManager

Field Summary

Modifier and Type	Field and Description
private final LinkedHashMap<String, Taglet>	allTaglets All taglets, keyed either by their `name`, or by an alias.
private Map<Taglet.Location, List<Taglet>>	blockTagletsByLocation Block (non-inline) taglets, grouped by `location`.
private final HtmlConfiguration	config
private final DocletEnvironment	docEnv
private final Doclet	doclet
private Map<String, Taglet>	inlineTags The taglets that can appear inline in descriptive text.
private final boolean	javafx True if we want to use JavaFX-related tags (`@defaultValue`, `@treatAsPrivate`).
private final Messages	messages
private final boolean	nosince True if we do not want to use `@since` tags.
private final Set<String>	overriddenStandardTags Keep track of overridden standard tags.
private final Set<String>	potentiallyConflictingTags Keep track of the tags that may conflict with standard tags in the future (any custom tag without a period in its name).
private final Resources	resources
private List<Taglet>	serializedFormTags The taglets that can appear in the serialized form.
private final boolean	showauthor True if we want to use `@author` tags.
private final boolean	showTaglets Show the taglets table when it has been initialized.
private final boolean	showversion True if we want to use `@version` tags.
private final Set<String>	standardTags Keep track of standard tags.
private final String	tagletPath
private final Set<String>	unseenCustomTags The set of unseen custom tags.
private final Utils	utils

Constructor Summary

Access	Constructor and Description
public	TagletManager(HtmlConfiguration the configuration for this taglet manager config) Constructs a new `TagletManager`.

Method Summary

Modifier and Type	Method and Description
public void	addCustomTag(String the name of the class representing the custom tag classname, JavaFileManager the file manager to load classes and resources fileManager) Adds a new `Taglet`.
public void	addNewSimpleCustomTag(String the name of this tag tagName, String the header to output header, String the possible locations that this tag can appear in locations) Adds a new `SimpleTaglet`.
private void	addStandardTaglet(Taglet taglet)
private void	addStandardTaglet(Taglet taglet, DocTree.Kind alias)
private void	checkTagName(String name) Given a tag name, add it to the set of tags it belongs to.
public void	checkTags(Element the tags holder element, Iterable<? extends DocTree> the trees containing the comments trees) Given a series of `DocTree`s, check for misuse and spelling mistakes.
private String	format(boolean b, String s)
public Set<String>	getAllTagletNames()
public List<Taglet>	Returns: the array of `Taglet`s that can appear in the given element getBlockTaglets(Element the element to get custom tags for e) Returns the custom tags for a given element.
pack-priv Map<String, Taglet>	Returns: the taglets that can appear inline getInlineTaglets() Returns the taglets that can appear inline, in descriptive text.
public List<Taglet>	Returns: the taglet that can appear in the serialized form getSerializedFormTaglets() Returns the taglets that can appear in the serialized form.
pack-priv Taglet	Returns: the corresponding taglet or `null` if the tag is unknown getTaglet(String the name of the taglet to retrieve name) Given the name of a tag, return the corresponding taglet.
public Taglet	getTaglet(DocTree.Kind kind)
private void	initJavaFXTaglets() Initialize JavaFX-related tags.
private void	initStandardTaglets() Initialize standard Javadoc tags for ordering purposes.
public void	initTagletPath(JavaFileManager the file manager to load classes and resources fileManager) Initializes the location TAGLET_PATH which is used to locate the custom taglets.
private void	initTaglets() Initialize the tag collections.
public boolean	isKnownCustomTag(String tagName)
public void	loadTaglets(JavaFileManager the file manager to load the taglets fileManager) Loads taglets from a taglet path using the service loader.
public void	printReport() Print a list of `Taglet`s that might conflict with standard tags in the future and a list of standard tags that have been overridden.
private void	printReportHelper(String noticeKey, Set<String> names)
private void	printTagMisuseWarn(CommentHelper ch, Taglet the taglet representing the misused tag taglet, DocTree the misused tag tag, String the type of documentation that the misused tag was found in holderType) Given the taglet, the tag and the type of documentation that the tag was found in, print a tag misuse warning.
private void	registerTaglet(Taglet the `Taglet` instance instance) Registers the `Taglet`.
pack-priv void	seenTag(String the name of the tag name) Reports that a tag was seen in a doc comment.
private void	showTaglets(PrintStream out)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

allTaglets	back to summary
private final LinkedHashMap<String, Taglet> allTaglets All taglets, keyed either by their `name`, or by an alias. In general, taglets do not provide aliases; the one instance that does is `ThrowsTaglet`, which handles both `@throws` tags and `@exception` tags.

blockTagletsByLocation	back to summary
private Map<Taglet.Location, List<Taglet>> blockTagletsByLocation Block (non-inline) taglets, grouped by `location`.

config	back to summary
private final HtmlConfiguration config

docEnv	back to summary
private final DocletEnvironment docEnv

doclet	back to summary
private final Doclet doclet

inlineTags	back to summary
private Map<String, Taglet> inlineTags The taglets that can appear inline in descriptive text.

javafx	back to summary
private final boolean javafx True if we want to use JavaFX-related tags (`@defaultValue`, `@treatAsPrivate`).

messages	back to summary
private final Messages messages

nosince	back to summary
private final boolean nosince True if we do not want to use `@since` tags.

overriddenStandardTags	back to summary
private final Set<String> overriddenStandardTags Keep track of overridden standard tags.

potentiallyConflictingTags	back to summary
private final Set<String> potentiallyConflictingTags Keep track of the tags that may conflict with standard tags in the future (any custom tag without a period in its name).

resources	back to summary
private final Resources resources

serializedFormTags	back to summary
private List<Taglet> serializedFormTags The taglets that can appear in the serialized form.

showauthor	back to summary
private final boolean showauthor True if we want to use `@author` tags.

showTaglets	back to summary
private final boolean showTaglets Show the taglets table when it has been initialized.

showversion	back to summary
private final boolean showversion True if we want to use `@version` tags.

standardTags	back to summary
private final Set<String> standardTags Keep track of standard tags.

tagletPath	back to summary
private final String tagletPath

unseenCustomTags	back to summary
private final Set<String> unseenCustomTags The set of unseen custom tags.

utils	back to summary
private final Utils utils

Constructor Detail

TagletManager back to summary

TagletManager	back to summary
public TagletManager(HtmlConfiguration config) Constructs a new `TagletManager`. Parameters config:HtmlConfiguration the configuration for this taglet manager

public TagletManager(HtmlConfiguration config)

Constructs a new TagletManager.

Parameters

config:HtmlConfiguration: the configuration for this taglet manager

Method Detail

addCustomTag back to summary

addCustomTag	back to summary
public void addCustomTag(String classname, JavaFileManager fileManager) Adds a new `Taglet`. Prints a message to indicate whether or not the Taglet was registered properly. Parameters classname:String the name of the class representing the custom tag fileManager:JavaFileManager the file manager to load classes and resources

public void addCustomTag(String classname, JavaFileManager fileManager)

Adds a new Taglet. Prints a message to indicate whether or not the Taglet was registered properly.

Parameters

classname:String: the name of the class representing the custom tag
fileManager:JavaFileManager: the file manager to load classes and resources

addNewSimpleCustomTag back to summary

addNewSimpleCustomTag	back to summary
public void addNewSimpleCustomTag(String tagName, String header, String locations) Adds a new `SimpleTaglet`. If this tag already exists and the header passed as an argument is `null`, move tag to the back of the list. If this tag already exists and the header passed as an argument is not `null`, overwrite previous tag with the new one. Otherwise, add a new SimpleTaglet to the list. Parameters tagName:String the name of this tag header:String the header to output locations:String the possible locations that this tag can appear in

public void addNewSimpleCustomTag(String tagName, String header, String locations)

Adds a new SimpleTaglet. If this tag already exists and the header passed as an argument is null, move tag to the back of the list. If this tag already exists and the header passed as an argument is not null, overwrite previous tag with the new one. Otherwise, add a new SimpleTaglet to the list.

Parameters

tagName:String: the name of this tag
header:String: the header to output
locations:String: the possible locations that this tag can appear in

addStandardTaglet	back to summary
private void addStandardTaglet(Taglet taglet)

addStandardTaglet	back to summary
private void addStandardTaglet(Taglet taglet, DocTree.Kind alias)

checkTagName	back to summary
private void checkTagName(String name) Given a tag name, add it to the set of tags it belongs to.

checkTags back to summary

checkTags	back to summary
public void checkTags(Element element, Iterable<? extends DocTree> trees) Given a series of `DocTree`s, check for misuse and spelling mistakes. Parameters element:Element the tags holder trees:Iterable<? extends DocTree> the trees containing the comments

public void checkTags(Element element, Iterable<? extends DocTree> trees)

Given a series of DocTrees, check for misuse and spelling mistakes.

Parameters

element:Element: the tags holder
trees:Iterable<? extends DocTree>: the trees containing the comments

format	back to summary
private String format(boolean b, String s)

getAllTagletNames	back to summary
public Set<String> getAllTagletNames()

getBlockTaglets back to summary

getBlockTaglets	back to summary
public List<Taglet> getBlockTaglets(Element e) Returns the custom tags for a given element. Parameters e:Element the element to get custom tags for Returns:List<Taglet> the array of `Taglet`s that can appear in the given element Annotations @SuppressWarnings:fallthrough

public List<Taglet> getBlockTaglets(Element e)

Returns the custom tags for a given element.

Parameters

e:Element: the element to get custom tags for

Returns:List<Taglet>

the array of Taglets that can appear in the given element

Annotations

@SuppressWarnings:fallthrough

getInlineTaglets	back to summary
pack-priv Map<String, Taglet> getInlineTaglets() Returns the taglets that can appear inline, in descriptive text. Returns:Map<String, Taglet> the taglets that can appear inline

getInlineTaglets

back to summary

pack-priv Map<String, Taglet> getInlineTaglets()

Returns the taglets that can appear inline, in descriptive text.

Returns:Map<String, Taglet>: the taglets that can appear inline

getSerializedFormTaglets	back to summary
public List<Taglet> getSerializedFormTaglets() Returns the taglets that can appear in the serialized form. Returns:List<Taglet> the taglet that can appear in the serialized form

getSerializedFormTaglets

back to summary

public List<Taglet> getSerializedFormTaglets()

Returns the taglets that can appear in the serialized form.

Returns:List<Taglet>: the taglet that can appear in the serialized form

getTaglet back to summary

getTaglet	back to summary
pack-priv Taglet getTaglet(String name) Given the name of a tag, return the corresponding taglet. Parameters name:String the name of the taglet to retrieve Returns:Taglet the corresponding taglet or `null` if the tag is unknown

pack-priv Taglet getTaglet(String name)

Given the name of a tag, return the corresponding taglet.

Parameters

name:String: the name of the taglet to retrieve

Returns:Taglet

the corresponding taglet or null if the tag is unknown

getTaglet	back to summary
public Taglet getTaglet(DocTree.Kind kind)

initJavaFXTaglets	back to summary
private void initJavaFXTaglets() Initialize JavaFX-related tags.

initStandardTaglets	back to summary
private void initStandardTaglets() Initialize standard Javadoc tags for ordering purposes.

initTagletPath	back to summary
public void initTagletPath(JavaFileManager fileManager) throws IOException Initializes the location TAGLET_PATH which is used to locate the custom taglets. Parameters fileManager:JavaFileManager the file manager to load classes and resources Exceptions IOException: if an error occurs while setting the location

initTagletPath

back to summary

public void initTagletPath(JavaFileManager fileManager) throws IOException

Initializes the location TAGLET_PATH which is used to locate the custom taglets.

Parameters

fileManager:JavaFileManager: the file manager to load classes and resources

Exceptions

IOException:: if an error occurs while setting the location

initTaglets	back to summary
private void initTaglets() Initialize the tag collections.

isKnownCustomTag	back to summary
public boolean isKnownCustomTag(String tagName)

loadTaglets	back to summary
public void loadTaglets(JavaFileManager fileManager) throws IOException Loads taglets from a taglet path using the service loader. Parameters fileManager:JavaFileManager the file manager to load the taglets Exceptions IOException: if an error occurs while getting the service loader

loadTaglets

back to summary

public void loadTaglets(JavaFileManager fileManager) throws IOException

Loads taglets from a taglet path using the service loader.

Parameters

fileManager:JavaFileManager: the file manager to load the taglets

Exceptions

IOException:: if an error occurs while getting the service loader

printReport	back to summary
public void printReport() Print a list of `Taglet`s that might conflict with standard tags in the future and a list of standard tags that have been overridden.

printReportHelper	back to summary
private void printReportHelper(String noticeKey, Set<String> names)

printTagMisuseWarn	back to summary
private void printTagMisuseWarn(CommentHelper ch, Taglet taglet, DocTree tag, String holderType) Given the taglet, the tag and the type of documentation that the tag was found in, print a tag misuse warning. Parameters taglet:Taglet the taglet representing the misused tag tag:DocTree the misused tag holderType:String the type of documentation that the misused tag was found in

printTagMisuseWarn

back to summary

private void printTagMisuseWarn(CommentHelper ch, Taglet taglet, DocTree tag, String holderType)

Given the taglet, the tag and the type of documentation that the tag was found in, print a tag misuse warning.

Parameters

taglet:Taglet: the taglet representing the misused tag
tag:DocTree: the misused tag
holderType:String: the type of documentation that the misused tag was found in

registerTaglet back to summary

registerTaglet	back to summary
private void registerTaglet(Taglet instance) Registers the `Taglet`. Prints a message if the `Taglet` got registered properly. Parameters instance:Taglet the `Taglet` instance

private void registerTaglet(Taglet instance)

Registers the Taglet. Prints a message if the Taglet got registered properly.

Parameters

instance:Taglet: the Taglet instance

seenTag	back to summary
pack-priv void seenTag(String name) Reports that a tag was seen in a doc comment. It is removed from the list of custom tags that have not yet been seen. Parameters name:String the name of the tag

seenTag

back to summary

pack-priv void seenTag(String name)

Reports that a tag was seen in a doc comment. It is removed from the list of custom tags that have not yet been seen.

Parameters

name:String: the name of the tag

showTaglets	back to summary
private void showTaglets(PrintStream out)

public Class TagletManager

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail