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

Class MetaKeywords

  • @Deprecated
public class MetaKeywords
extends java.lang.Object
    Deprecated.
    Provides methods for creating an array of class, method and field names to be included as meta keywords in the HTML header of class pages. These keywords improve search results on browsers that look for keywords.

    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.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private Configuration configuration
      Deprecated.
      The global configuration information for this run.
      private Utils utils
      Deprecated.
       

    • Constructor Summary

      Constructors 
      Constructor Description
      MetaKeywords​(Configuration configuration)
      Deprecated.
      Constructor

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      protected java.util.ArrayList<java.lang.String> getClassKeyword​(ClassDoc classdoc)
      Deprecated.
      Get the current class for a meta tag keyword, as the first and only element of an array list.
      protected java.util.ArrayList<java.lang.String> getMemberKeywords​(MemberDoc[] memberdocs)
      Deprecated.
      Get members for meta tag keywords as an array, where each member name is a string element of the array.
      java.lang.String[] getMetaKeywords​(ClassDoc classdoc)
      Deprecated.
      Returns an array of strings where each element is a class, method or field name.
      java.lang.String[] getMetaKeywords​(PackageDoc packageDoc)
      Deprecated.
      Get the package keywords.
      java.lang.String[] getOverviewMetaKeywords​(java.lang.String title, java.lang.String docTitle)
      Deprecated.
      Get the overview keywords.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • configuration

        private final Configuration configuration
        Deprecated.
        The global configuration information for this run.

      • utils

        private final Utils utils
        Deprecated.

    • Constructor Detail

      • MetaKeywords

        public MetaKeywords​(Configuration configuration)
        Deprecated.
        Constructor

    • Method Detail

      • getMetaKeywords

        public java.lang.String[] getMetaKeywords​(ClassDoc classdoc)
        Deprecated.
        Returns an array of strings where each element is a class, method or field name. This array is used to create one meta keyword tag for each element. Method parameter lists are converted to "()" and overloads are combined. Constructors are not included because they have the same name as the class, which is already included. Nested class members are not included because their definitions are on separate pages.

      • getClassKeyword

        protected java.util.ArrayList<java.lang.String> getClassKeyword​(ClassDoc classdoc)
        Deprecated.
        Get the current class for a meta tag keyword, as the first and only element of an array list.

      • getMetaKeywords

        public java.lang.String[] getMetaKeywords​(PackageDoc packageDoc)
        Deprecated.
        Get the package keywords.

      • getOverviewMetaKeywords

        public java.lang.String[] getOverviewMetaKeywords​(java.lang.String title,
                                                  java.lang.String docTitle)
        Deprecated.
        Get the overview keywords.

      • getMemberKeywords

        protected java.util.ArrayList<java.lang.String> getMemberKeywords​(MemberDoc[] memberdocs)
        Deprecated.
        Get members for meta tag keywords as an array, where each member name is a string element of the array. The parameter lists are not included in the keywords; therefore all overloaded methods are combined.
        Example: getValue(Object) is returned in array as getValue()
        Parameters:
        memberdocs - array of MemberDoc objects to be added to keywords