Package gw.gosudoc.com.sun.tools.doclets.internal.toolkit.taglets

Class TagletManager

  • @Deprecated
public class TagletManager
extends 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
    Author:
    Jamie Ho

    • 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 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

    • 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 Set<String> getCustomTagNames()
        Deprecated.

      • addCustomTag

        public void addCustomTag​(String classname,
                         JavaFileManager fileManager,
                         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.

      • addNewSimpleCustomTag

        public void addNewSimpleCustomTag​(String tagName,
                                  String header,
                                  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.

      • seenCustomTag

        public void seenCustomTag​(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.

      • 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.

      • isKnownCustomTag

        public boolean isKnownCustomTag​(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.

      • getTaglet

        public Taglet getTaglet​(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.