Class TagletManager
java.lang.Object
gw.gosudoc.com.sun.tools.doclets.internal.toolkit.taglets.TagletManager
Deprecated.
Manages the
Taglet
s 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
FieldsModifier and TypeFieldDescriptionstatic final String
Deprecated.The alternate separator for simple tag options.private Taglet[]
Deprecated.The array of custom tags that can appear in constructors.private LinkedHashMap<String,
Taglet> Deprecated.The map of custom tags.private boolean
Deprecated.private Taglet[]
Deprecated.The array of custom tags that can appear in fields.private Taglet[]
Deprecated.The array of custom tags that can appear in comments.private boolean
Deprecated.True if we want to use JavaFX-related tags (@propertyGetter,private MessageRetriever
Deprecated.The message retriever that will be used to print error messages.private Taglet[]
Deprecated.The array of custom tags that can appear in methods.private boolean
Deprecated.True if we do not want to use @since tags.Deprecated.Keep track of overriden standard tags.private Taglet[]
Deprecated.The array of custom tags that can appear in the overview.private Taglet[]
Deprecated.The array of custom tags that can appear in packages.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[]
Deprecated.The array of custom tags that can appear in the serialized form.private boolean
Deprecated.True if we want to use @author tags.private boolean
Deprecated.True if we want to use @version tags.static final char
Deprecated.The default separator for the simple tag option.Deprecated.Keep track of standard tags.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[]
Deprecated.The array of custom tags that can appear in classes or interfaces.Deprecated.The set of unseen custom tags. -
Constructor Summary
ConstructorsConstructorDescriptionTagletManager
(boolean nosince, boolean showversion, boolean showauthor, boolean javafx, boolean exportInternalAPI, MessageRetriever message) Deprecated.Construct a newTagletManager
. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addCustomTag
(Taglet customTag) Deprecated.Add a newCustomTag
.void
addCustomTag
(String classname, JavaFileManager fileManager, String tagletPath) Deprecated.Add a newTaglet
.void
addNewSimpleCustomTag
(String tagName, String header, String locations) Deprecated.Add a newSimpleTaglet
.(package private) void
addStandardTaglet
(boolean enable, Taglet taglet) Deprecated.(package private) void
addStandardTaglet
(Taglet taglet) Deprecated.private String
appendPath
(String path1, String path2) Deprecated.private void
checkTaglet
(Object taglet) Deprecated.Check the taglet to see if it is a legacy taglet.private void
checkTagName
(String name) Deprecated.Given a tag name, add it to the set of tags it belongs to.void
Deprecated.Given an array ofTag
s, check for spelling mistakes.private void
Deprecated.Export javadoc internal API to the unnamed module for a classloader.Taglet[]
Deprecated.Return the array ofTaglet
s that can appear in constructors.Taglet[]
getCustomTaglets
(Doc doc) Deprecated.Deprecated.Taglet[]
Deprecated.Return the array ofTaglet
s that can appear in fields.Taglet[]
Deprecated.Return the array of inlineTaglet
s that can appear in comments.Taglet[]
Deprecated.Return the array ofTaglet
s that can appear in methods.Taglet[]
Deprecated.Return the array ofTaglet
s that can appear in an overview.Taglet[]
Deprecated.Return the array ofTaglet
s that can appear in packages.Taglet[]
Deprecated.Return the array ofTaglet
s that can appear in the serialized form.Deprecated.Given the name of a tag, return the corresponding taglet.Taglet[]
Deprecated.Return the array ofTaglet
s that can appear in classes or interfaces.private void
Deprecated.Initialize the custom tag arrays.private void
Deprecated.Initialize JavaFX-related tags.private void
Deprecated.Initialize standard Javadoc tags for ordering purposes.private void
Deprecated.Initialize lowercase version of standard Javadoc tags.boolean
isKnownCustomTag
(String tagName) Deprecated.private URL[]
pathToURLs
(String path) Deprecated.Utility method for converting a search path string to an array of directory and JAR file URLs.void
Deprecated.Print a list ofTaglet
s that might conflict with standard tags in the future and a list of standard tags that have been overriden.private void
printReportHelper
(String noticeKey, Set<String> names) Deprecated.private void
printTagMisuseWarn
(Taglet taglet, Tag tag, 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
(String name) Deprecated.Given a name of a seen custom tag, remove it from the set of unseen custom tags.
-
Field Details
-
SIMPLE_TAGLET_OPT_SEPARATOR
public static final char SIMPLE_TAGLET_OPT_SEPARATORDeprecated.The default separator for the simple tag option.- See Also:
-
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:
-
customTags
Deprecated.The map of custom tags. -
packageTags
Deprecated.The array of custom tags that can appear in packages. -
typeTags
Deprecated.The array of custom tags that can appear in classes or interfaces. -
fieldTags
Deprecated.The array of custom tags that can appear in fields. -
constructorTags
Deprecated.The array of custom tags that can appear in constructors. -
methodTags
Deprecated.The array of custom tags that can appear in methods. -
overviewTags
Deprecated.The array of custom tags that can appear in the overview. -
inlineTags
Deprecated.The array of custom tags that can appear in comments. -
serializedFormTags
Deprecated.The array of custom tags that can appear in the serialized form. -
message
Deprecated.The message retriever that will be used to print error messages. -
standardTags
Deprecated.Keep track of standard tags. -
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
Deprecated.Keep track of overriden standard tags. -
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
Deprecated.The set of unseen custom tags. -
nosince
private boolean nosinceDeprecated.True if we do not want to use @since tags. -
showversion
private boolean showversionDeprecated.True if we want to use @version tags. -
showauthor
private boolean showauthorDeprecated.True if we want to use @author tags. -
javafx
private boolean javafxDeprecated.True if we want to use JavaFX-related tags (@propertyGetter, -
exportInternalAPI
private boolean exportInternalAPIDeprecated.
-
-
Constructor Details
-
TagletManager
public TagletManager(boolean nosince, boolean showversion, boolean showauthor, boolean javafx, boolean exportInternalAPI, MessageRetriever message) Deprecated.Construct a newTagletManager
.- 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 Details
-
addCustomTag
Deprecated.Add a newCustomTag
. 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 newCustomTag
to add.
-
getCustomTagNames
Deprecated. -
addCustomTag
Deprecated.Add a newTaglet
. 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
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
Deprecated. -
pathToURLs
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
Deprecated.Add a newSimpleTaglet
. 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 tagheader
- the header to output.locations
- the possible locations that this tag can appear in.
-
checkTagName
Deprecated.Given a tag name, add it to the set of tags it belongs to. -
checkTaglet
Deprecated.Check the taglet to see if it is a legacy taglet. Also check its name for errors. -
seenCustomTag
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
Deprecated.Given an array ofTag
s, check for spelling mistakes.- Parameters:
doc
- the Doc object that holds the tags.tags
- the list ofTag
s to check.areInlineTags
- true if the array of tags are inline and false otherwise.
-
printTagMisuseWarn
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
Deprecated.Return the array ofTaglet
s that can appear in packages.- Returns:
- the array of
Taglet
s that can appear in packages.
-
getTypeCustomTaglets
Deprecated.Return the array ofTaglet
s that can appear in classes or interfaces.- Returns:
- the array of
Taglet
s that can appear in classes or interfaces.
-
getInlineCustomTaglets
Deprecated.Return the array of inlineTaglet
s that can appear in comments.- Returns:
- the array of
Taglet
s that can appear in comments.
-
getFieldCustomTaglets
Deprecated.Return the array ofTaglet
s that can appear in fields.- Returns:
- the array of
Taglet
s that can appear in field.
-
getSerializedFormTaglets
Deprecated.Return the array ofTaglet
s that can appear in the serialized form.- Returns:
- the array of
Taglet
s that can appear in the serialized form.
-
getCustomTaglets
Deprecated.- Returns:
- the array of
Taglet
s that can appear in the given Doc.
-
getConstructorCustomTaglets
Deprecated.Return the array ofTaglet
s that can appear in constructors.- Returns:
- the array of
Taglet
s that can appear in constructors.
-
getMethodCustomTaglets
Deprecated.Return the array ofTaglet
s that can appear in methods.- Returns:
- the array of
Taglet
s that can appear in methods.
-
getOverviewCustomTaglets
Deprecated.Return the array ofTaglet
s that can appear in an overview.- Returns:
- the array of
Taglet
s 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
Deprecated. -
addStandardTaglet
Deprecated. -
initStandardTagsLowercase
private void initStandardTagsLowercase()Deprecated.Initialize lowercase version of standard Javadoc tags. -
isKnownCustomTag
Deprecated. -
printReport
public void printReport()Deprecated.Print a list ofTaglet
s that might conflict with standard tags in the future and a list of standard tags that have been overriden. -
printReportHelper
Deprecated. -
getTaglet
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.
-