APIdia Launch Partner
Top Description Fields Constructors Methods
jdk.javadoc.internal.doclets.toolkit.util

public Class MetaKeywords

extends Object
Class Inheritance
Imports
java.util.*, javax.lang.model.element.Element, .ModuleElement, .PackageElement, .TypeElement, jdk.javadoc.internal.doclets.toolkit.BaseConfiguration, .BaseOptions, .Resources
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.

Field Summary

Modifier and TypeField and Description
private final BaseOptions
options

private final Resources
resources

private final Utils
utils

Constructor Summary

AccessConstructor and Description
public
MetaKeywords(BaseConfiguration configuration)

Constructor

Method Summary

Modifier and TypeMethod and Description
protected List<String>
getClassKeyword(TypeElement typeElement)

Get the current class for a meta tag keyword, as a singleton list.

protected List<String>
getMemberKeywords(List<? extends Element>
array of members to be added to keywords
members)

Get members for meta tag keywords as an array, where each member name is a string element of the array.

public List<String>
getMetaKeywords(TypeElement typeElement)

Returns an array of strings where each element is a class, method or field name.

public List<String>
getMetaKeywords(PackageElement packageElement)

Get the package keywords.

public List<String>
getMetaKeywordsForModule(ModuleElement
the module being documented
mdle)

Get the module keywords.

public List<String>
getOverviewMetaKeywords(String title, String docTitle)

Get the overview keywords.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

optionsback to summary
private final BaseOptions options
resourcesback to summary
private final Resources resources
utilsback to summary
private final Utils utils

Constructor Detail

MetaKeywordsback to summary
public MetaKeywords(BaseConfiguration configuration)

Constructor

Method Detail

getClassKeywordback to summary
protected List<String> getClassKeyword(TypeElement typeElement)

Get the current class for a meta tag keyword, as a singleton list.

getMemberKeywordsback to summary
protected List<String> getMemberKeywords(List<? extends Element> members)

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
members:List<? extends Element>

array of members to be added to keywords

getMetaKeywordsback to summary
public List<String> getMetaKeywords(TypeElement typeElement)

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.

getMetaKeywordsback to summary
public List<String> getMetaKeywords(PackageElement packageElement)

Get the package keywords.

getMetaKeywordsForModuleback to summary
public List<String> getMetaKeywordsForModule(ModuleElement mdle)

Get the module keywords.

Parameters
mdle:ModuleElement

the module being documented

getOverviewMetaKeywordsback to summary
public List<String> getOverviewMetaKeywords(String title, String docTitle)

Get the overview keywords.