java.lang.Object
- gw.gosudoc.com.sun.tools.doclets.internal.toolkit.taglets.TagletManager

```
@Deprecated
public class TagletManager
extends java.lang.Object
```
Deprecated.

Manages theTaglets used by doclets.
This is NOT part of any supported API. If you write code that depends on this, you do so at your own risk. This code and its internal interfaces are subject to change or deletion without notice.

Since:

1.4

Field Summary

Fields
Modifier and Type	Field	Description
`static java.lang.String`	`ALT_SIMPLE_TAGLET_OPT_SEPARATOR`	Deprecated. The alternate separator for simple tag options.
`private Taglet[]`	`constructorTags`	Deprecated. The array of custom tags that can appear in constructors.
`private java.util.LinkedHashMap<java.lang.String,Taglet>`	`customTags`	Deprecated. The map of custom tags.
`private boolean`	`exportInternalAPI`	Deprecated.
`private Taglet[]`	`fieldTags`	Deprecated. The array of custom tags that can appear in fields.
`private Taglet[]`	`inlineTags`	Deprecated. The array of custom tags that can appear in comments.
`private boolean`	`javafx`	Deprecated. True if we want to use JavaFX-related tags (@propertyGetter,
`private MessageRetriever`	`message`	Deprecated. The message retriever that will be used to print error messages.
`private Taglet[]`	`methodTags`	Deprecated. The array of custom tags that can appear in methods.
`private boolean`	`nosince`	Deprecated. True if we do not want to use @since tags.
`private java.util.Set<java.lang.String>`	`overridenStandardTags`	Deprecated. Keep track of overriden standard tags.
`private Taglet[]`	`overviewTags`	Deprecated. The array of custom tags that can appear in the overview.
`private Taglet[]`	`packageTags`	Deprecated. The array of custom tags that can appear in packages.
`private java.util.Set<java.lang.String>`	`potentiallyConflictingTags`	Deprecated. Keep track of the tags that may conflict with standard tags in the future (any custom tag without a period in its name).
`private Taglet[]`	`serializedFormTags`	Deprecated. The array of custom tags that can appear in the serialized form.
`private boolean`	`showauthor`	Deprecated. True if we want to use @author tags.
`private boolean`	`showversion`	Deprecated. True if we want to use @version tags.
`static char`	`SIMPLE_TAGLET_OPT_SEPARATOR`	Deprecated. The default separator for the simple tag option.
`private java.util.Set<java.lang.String>`	`standardTags`	Deprecated. Keep track of standard tags.
`private java.util.Set<java.lang.String>`	`standardTagsLowercase`	Deprecated. Keep track of standard tags in lowercase to compare for better error messages when a tag like @docRoot is mistakenly spelled lowercase @docroot.
`private Taglet[]`	`typeTags`	Deprecated. The array of custom tags that can appear in classes or interfaces.
`private java.util.Set<java.lang.String>`	`unseenCustomTags`	Deprecated. The set of unseen custom tags.

Constructor Summary

Constructors
Constructor	Description
`TagletManager(boolean nosince, boolean showversion, boolean showauthor, boolean javafx, boolean exportInternalAPI, MessageRetriever message)`	Deprecated. Construct a new `TagletManager`.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`void`	`addCustomTag(Taglet customTag)`	Deprecated. Add a new `CustomTag`.
`void`	`addCustomTag(java.lang.String classname, javax.tools.JavaFileManager fileManager, java.lang.String tagletPath)`	Deprecated. Add a new `Taglet`.
`void`	`addNewSimpleCustomTag(java.lang.String tagName, java.lang.String header, java.lang.String locations)`	Deprecated. Add a new `SimpleTaglet`.
`(package private) void`	`addStandardTaglet(boolean enable, Taglet taglet)`	Deprecated.
`(package private) void`	`addStandardTaglet(Taglet taglet)`	Deprecated.
`private java.lang.String`	`appendPath(java.lang.String path1, java.lang.String path2)`	Deprecated.
`private void`	`checkTaglet(java.lang.Object taglet)`	Deprecated. Check the taglet to see if it is a legacy taglet.
`private void`	`checkTagName(java.lang.String name)`	Deprecated. Given a tag name, add it to the set of tags it belongs to.
`void`	`checkTags(Doc doc, Tag[] tags, boolean areInlineTags)`	Deprecated. Given an array of `Tag`s, check for spelling mistakes.
`private void`	`exportInternalAPI(java.lang.ClassLoader cl)`	Deprecated. Export javadoc internal API to the unnamed module for a classloader.
`Taglet[]`	`getConstructorCustomTaglets()`	Deprecated. Return the array of `Taglet`s that can appear in constructors.
`Taglet[]`	`getCustomTaglets(Doc doc)`	Deprecated.
`java.util.Set<java.lang.String>`	`getCustomTagNames()`	Deprecated.
`Taglet[]`	`getFieldCustomTaglets()`	Deprecated. Return the array of `Taglet`s that can appear in fields.
`Taglet[]`	`getInlineCustomTaglets()`	Deprecated. Return the array of inline `Taglet`s that can appear in comments.
`Taglet[]`	`getMethodCustomTaglets()`	Deprecated. Return the array of `Taglet`s that can appear in methods.
`Taglet[]`	`getOverviewCustomTaglets()`	Deprecated. Return the array of `Taglet`s that can appear in an overview.
`Taglet[]`	`getPackageCustomTaglets()`	Deprecated. Return the array of `Taglet`s that can appear in packages.
`Taglet[]`	`getSerializedFormTaglets()`	Deprecated. Return the array of `Taglet`s that can appear in the serialized form.
`Taglet`	`getTaglet(java.lang.String name)`	Deprecated. Given the name of a tag, return the corresponding taglet.
`Taglet[]`	`getTypeCustomTaglets()`	Deprecated. Return the array of `Taglet`s that can appear in classes or interfaces.
`private void`	`initCustomTagletArrays()`	Deprecated. Initialize the custom tag arrays.
`private void`	`initJavaFXTaglets()`	Deprecated. Initialize JavaFX-related tags.
`private void`	`initStandardTaglets()`	Deprecated. Initialize standard Javadoc tags for ordering purposes.
`private void`	`initStandardTagsLowercase()`	Deprecated. Initialize lowercase version of standard Javadoc tags.
`boolean`	`isKnownCustomTag(java.lang.String tagName)`	Deprecated.
`private java.net.URL[]`	`pathToURLs(java.lang.String path)`	Deprecated. Utility method for converting a search path string to an array of directory and JAR file URLs.
`void`	`printReport()`	Deprecated. Print a list of `Taglet`s that might conflict with standard tags in the future and a list of standard tags that have been overriden.
`private void`	`printReportHelper(java.lang.String noticeKey, java.util.Set<java.lang.String> names)`	Deprecated.
`private void`	`printTagMisuseWarn(Taglet taglet, Tag tag, java.lang.String holderType)`	Deprecated. Given the taglet, the tag and the type of documentation that the tag was found in, print a tag misuse warning.
`void`	`seenCustomTag(java.lang.String name)`	Deprecated. Given a name of a seen custom tag, remove it from the set of unseen custom tags.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SIMPLE_TAGLET_OPT_SEPARATOR
```
public static final char SIMPLE_TAGLET_OPT_SEPARATOR
```
    Deprecated.
    
    The default separator for the simple tag option.
    
    See Also:
    
    Constant Field Values
  - ALT_SIMPLE_TAGLET_OPT_SEPARATOR
```
public static final java.lang.String ALT_SIMPLE_TAGLET_OPT_SEPARATOR
```
    Deprecated.
    
    The alternate separator for simple tag options. Use this when you want the default separator to be in the name of the custom tag.
    
    See Also:
    
    Constant Field Values
  - customTags
```
private java.util.LinkedHashMap<java.lang.String,Taglet> customTags
```
    Deprecated.
    
    The map of custom tags.
  - packageTags
```
private Taglet[] packageTags
```
    Deprecated.
    
    The array of custom tags that can appear in packages.
  - typeTags
```
private Taglet[] typeTags
```
    Deprecated.
    
    The array of custom tags that can appear in classes or interfaces.
  - fieldTags
```
private Taglet[] fieldTags
```
    Deprecated.
    
    The array of custom tags that can appear in fields.
  - constructorTags
```
private Taglet[] constructorTags
```
    Deprecated.
    
    The array of custom tags that can appear in constructors.
  - methodTags
```
private Taglet[] methodTags
```
    Deprecated.
    
    The array of custom tags that can appear in methods.
  - overviewTags
```
private Taglet[] overviewTags
```
    Deprecated.
    
    The array of custom tags that can appear in the overview.
  - inlineTags
```
private Taglet[] inlineTags
```
    Deprecated.
    
    The array of custom tags that can appear in comments.
  - serializedFormTags
```
private Taglet[] serializedFormTags
```
    Deprecated.
    
    The array of custom tags that can appear in the serialized form.
  - message
```
private MessageRetriever message
```
    Deprecated.
    
    The message retriever that will be used to print error messages.
  - standardTags
```
private java.util.Set<java.lang.String> standardTags
```
    Deprecated.
    
    Keep track of standard tags.
  - standardTagsLowercase
```
private java.util.Set<java.lang.String> standardTagsLowercase
```
    Deprecated.
    
    Keep track of standard tags in lowercase to compare for better error messages when a tag like @docRoot is mistakenly spelled lowercase @docroot.
  - overridenStandardTags
```
private java.util.Set<java.lang.String> overridenStandardTags
```
    Deprecated.
    
    Keep track of overriden standard tags.
  - potentiallyConflictingTags
```
private java.util.Set<java.lang.String> potentiallyConflictingTags
```
    Deprecated.
    
    Keep track of the tags that may conflict with standard tags in the future (any custom tag without a period in its name).
  - unseenCustomTags
```
private java.util.Set<java.lang.String> unseenCustomTags
```
    Deprecated.
    
    The set of unseen custom tags.
  - nosince
```
private boolean nosince
```
    Deprecated.
    
    True if we do not want to use @since tags.
  - showversion
```
private boolean showversion
```
    Deprecated.
    
    True if we want to use @version tags.
  - showauthor
```
private boolean showauthor
```
    Deprecated.
    
    True if we want to use @author tags.
  - javafx
```
private boolean javafx
```
    Deprecated.
    
    True if we want to use JavaFX-related tags (@propertyGetter,
  - exportInternalAPI
```
private boolean exportInternalAPI
```
    Deprecated.
- Constructor Detail
  - TagletManager
```
public TagletManager(boolean nosince,
                     boolean showversion,
                     boolean showauthor,
                     boolean javafx,
                     boolean exportInternalAPI,
                     MessageRetriever message)
```
    Deprecated.
    
    Construct a new TagletManager.
    
    Parameters:
    
    nosince - true if we do not want to use @since tags.
    
    showversion - true if we want to use @version tags.
    
    showauthor - true if we want to use @author tags.
    
    message - the message retriever to print warnings.
- Method Detail
  - addCustomTag
```
public void addCustomTag(Taglet customTag)
```
    Deprecated.
    
    Add a new CustomTag. This is used to add a Taglet from within a Doclet. No message is printed to indicate that the Taglet is properly registered because these Taglets are typically added for every execution of the Doclet. We don't want to see this type of error message every time.
    
    Parameters:
    
    customTag - the new CustomTag to add.
  - getCustomTagNames
```
public java.util.Set<java.lang.String> getCustomTagNames()
```
    Deprecated.
  - addCustomTag
```
public void addCustomTag(java.lang.String classname,
                         javax.tools.JavaFileManager fileManager,
                         java.lang.String tagletPath)
```
    Deprecated.
    
    Add a new Taglet. Print a message to indicate whether or not the Taglet was registered properly.
    
    Parameters:
    
    classname - the name of the class representing the custom tag.
    
    tagletPath - the path to the class representing the custom tag.
  - exportInternalAPI
```
private void exportInternalAPI(java.lang.ClassLoader cl)
```
    Deprecated.
    
    Export javadoc internal API to the unnamed module for a classloader. This is to support continued use of existing non-standard doclets that use the internal toolkit API and related classes.
    
    Parameters:
    
    cl - the classloader
  - appendPath
```
private java.lang.String appendPath(java.lang.String path1,
                                    java.lang.String path2)
```
    Deprecated.
  - pathToURLs
```
private java.net.URL[] pathToURLs(java.lang.String path)
```
    Deprecated.
    
    Utility method for converting a search path string to an array of directory and JAR file URLs.
    
    Parameters:
    
    path - the search path string
    
    Returns:
    
    the resulting array of directory and JAR file URLs
  - addNewSimpleCustomTag
```
public void addNewSimpleCustomTag(java.lang.String tagName,
                                  java.lang.String header,
                                  java.lang.String locations)
```
    Deprecated.
    
    Add 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 new one. Otherwise, add new SimpleTaglet to list.
    
    Parameters:
    
    tagName - the name of this tag
    
    header - the header to output.
    
    locations - the possible locations that this tag can appear in.
  - checkTagName
```
private void checkTagName(java.lang.String name)
```
    Deprecated.
    
    Given a tag name, add it to the set of tags it belongs to.
  - checkTaglet
```
private void checkTaglet(java.lang.Object taglet)
```
    Deprecated.
    
    Check the taglet to see if it is a legacy taglet. Also check its name for errors.
  - seenCustomTag
```
public void seenCustomTag(java.lang.String name)
```
    Deprecated.
    
    Given a name of a seen custom tag, remove it from the set of unseen custom tags.
    
    Parameters:
    
    name - the name of the seen custom tag.
  - checkTags
```
public void checkTags(Doc doc,
                      Tag[] tags,
                      boolean areInlineTags)
```
    Deprecated.
    
    Given an array of Tags, check for spelling mistakes.
    
    Parameters:
    
    doc - the Doc object that holds the tags.
    
    tags - the list of Tags to check.
    
    areInlineTags - true if the array of tags are inline and false otherwise.
  - printTagMisuseWarn
```
private void printTagMisuseWarn(Taglet taglet,
                                Tag tag,
                                java.lang.String holderType)
```
    Deprecated.
    
    Given the taglet, the tag and the type of documentation that the tag was found in, print a tag misuse warning.
    
    Parameters:
    
    taglet - the taglet representing the misused tag.
    
    tag - the misused tag.
    
    holderType - the type of documentation that the misused tag was found in.
  - getPackageCustomTaglets
```
public Taglet[] getPackageCustomTaglets()
```
    Deprecated.
    
    Return the array of Taglets that can appear in packages.
    
    Returns:
    
    the array of Taglets that can appear in packages.
  - getTypeCustomTaglets
```
public Taglet[] getTypeCustomTaglets()
```
    Deprecated.
    
    Return the array of Taglets that can appear in classes or interfaces.
    
    Returns:
    
    the array of Taglets that can appear in classes or interfaces.
  - getInlineCustomTaglets
```
public Taglet[] getInlineCustomTaglets()
```
    Deprecated.
    
    Return the array of inline Taglets that can appear in comments.
    
    Returns:
    
    the array of Taglets that can appear in comments.
  - getFieldCustomTaglets
```
public Taglet[] getFieldCustomTaglets()
```
    Deprecated.
    
    Return the array of Taglets that can appear in fields.
    
    Returns:
    
    the array of Taglets that can appear in field.
  - getSerializedFormTaglets
```
public Taglet[] getSerializedFormTaglets()
```
    Deprecated.
    
    Return the array of Taglets that can appear in the serialized form.
    
    Returns:
    
    the array of Taglets that can appear in the serialized form.
  - getCustomTaglets
```
public Taglet[] getCustomTaglets(Doc doc)
```
    Deprecated.
    
    Returns:
    
    the array of Taglets that can appear in the given Doc.
  - getConstructorCustomTaglets
```
public Taglet[] getConstructorCustomTaglets()
```
    Deprecated.
    
    Return the array of Taglets that can appear in constructors.
    
    Returns:
    
    the array of Taglets that can appear in constructors.
  - getMethodCustomTaglets
```
public Taglet[] getMethodCustomTaglets()
```
    Deprecated.
    
    Return the array of Taglets that can appear in methods.
    
    Returns:
    
    the array of Taglets that can appear in methods.
  - getOverviewCustomTaglets
```
public Taglet[] getOverviewCustomTaglets()
```
    Deprecated.
    
    Return the array of Taglets that can appear in an overview.
    
    Returns:
    
    the array of Taglets that can appear in overview.
  - initCustomTagletArrays
```
private void initCustomTagletArrays()
```
    Deprecated.
    
    Initialize the custom tag arrays.
  - initStandardTaglets
```
private void initStandardTaglets()
```
    Deprecated.
    
    Initialize standard Javadoc tags for ordering purposes.
  - initJavaFXTaglets
```
private void initJavaFXTaglets()
```
    Deprecated.
    
    Initialize JavaFX-related tags.
  - addStandardTaglet
```
void addStandardTaglet(Taglet taglet)
```
    Deprecated.
  - addStandardTaglet
```
void addStandardTaglet(boolean enable,
                       Taglet taglet)
```
    Deprecated.
  - initStandardTagsLowercase
```
private void initStandardTagsLowercase()
```
    Deprecated.
    
    Initialize lowercase version of standard Javadoc tags.
  - isKnownCustomTag
```
public boolean isKnownCustomTag(java.lang.String tagName)
```
    Deprecated.
  - printReport
```
public void printReport()
```
    Deprecated.
    
    Print a list of Taglets that might conflict with standard tags in the future and a list of standard tags that have been overriden.
  - printReportHelper
```
private void printReportHelper(java.lang.String noticeKey,
                               java.util.Set<java.lang.String> names)
```
    Deprecated.
  - getTaglet
```
public Taglet getTaglet(java.lang.String name)
```
    Deprecated.
    
    Given the name of a tag, return the corresponding taglet. Return null if the tag is unknown.
    
    Parameters:
    
    name - the name of the taglet to retrieve.
    
    Returns:
    
    return the corresponding taglet. Return null if the tag is unknown.

Class TagletManager

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SIMPLE_TAGLET_OPT_SEPARATOR

ALT_SIMPLE_TAGLET_OPT_SEPARATOR

customTags

packageTags

typeTags

fieldTags

constructorTags

methodTags

overviewTags

inlineTags

serializedFormTags

message

standardTags

standardTagsLowercase

overridenStandardTags

potentiallyConflictingTags

unseenCustomTags

nosince

showversion

showauthor

javafx

exportInternalAPI

Constructor Detail

TagletManager

Method Detail

addCustomTag

getCustomTagNames

addCustomTag

exportInternalAPI

appendPath

pathToURLs

addNewSimpleCustomTag

checkTagName

checkTaglet

seenCustomTag

checkTags

printTagMisuseWarn

getPackageCustomTaglets

getTypeCustomTaglets

getInlineCustomTaglets

getFieldCustomTaglets

getSerializedFormTaglets

getCustomTaglets

getConstructorCustomTaglets

getMethodCustomTaglets

getOverviewCustomTaglets

initCustomTagletArrays

initStandardTaglets

initJavaFXTaglets

addStandardTaglet

addStandardTaglet

initStandardTagsLowercase

isKnownCustomTag

printReport

printReportHelper

getTaglet