com.sun.tools.doclets.internal.toolkit.util
Class MetaKeywords

java.lang.Object
  com.sun.tools.doclets.internal.toolkit.util.MetaKeywords

public class MetaKeywords
extends java.lang.Object

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 code is not part of an API. It is implementation that is subject to change. Do not use it as an API

Field Summary

private Configuration

configuration The global configuration information for this run.

Constructor Summary

MetaKeywords(Configuration configuration)
Constructor

Method Summary

protected java.util.ArrayList<java.lang.String>	getClassKeyword(ClassDoc classdoc) 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) 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) Returns an array of strings where each element is a class, method or field name.
java.lang.String[]	getMetaKeywords(PackageDoc packageDoc) Get the package keywords.
java.lang.String[]	getOverviewMetaKeywords(java.lang.String title, java.lang.String docTitle) 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

The global configuration information for this run.

Constructor Detail

MetaKeywords

public MetaKeywords(Configuration configuration)

Constructor

Method Detail

getMetaKeywords

public java.lang.String[] getMetaKeywords(ClassDoc classdoc)

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)

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)

Get the package keywords.

getOverviewMetaKeywords

public java.lang.String[] getOverviewMetaKeywords(java.lang.String title,
                                                  java.lang.String docTitle)

Get the overview keywords.

getMemberKeywords

protected java.util.ArrayList<java.lang.String> getMemberKeywords(MemberDoc[] memberdocs)

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