APIdia Launch Partner
Top Description Fields Constructors Methods
jdk.javadoc.internal.doclets.formats.html

public Class HtmlIndexBuilder

extends IndexBuilder
Class Inheritance
Imports
java.io.IOException, .Writer, java.util.HashMap, .Map, .SortedSet, javax.lang.model.element.Element, .ExecutableElement, .TypeElement, jdk.javadoc.internal.doclets.toolkit.Resources, jdk.javadoc.internal.doclets.toolkit.util.DocFile, .DocFileIOException, .DocPath, .DocPaths, .IndexBuilder, .IndexItem, jdk.javadoc.internal.html.HtmlTree

Extensions to IndexBuilder to fill in remaining fields in index items: containingModule, containingPackage, containingClass, and url, and to write out the JavaScript files.

Field Summary

Modifier and TypeField and Description
private final HtmlIds
private final Resources
Inherited from jdk.javadoc.internal.doclets.toolkit.util.IndexBuilder:
configurationutils

Constructor Summary

AccessConstructor and Description
pack-priv
HtmlIndexBuilder(HtmlConfiguration
the current configuration of the doclet
configuration
)

Creates a new HtmlIndexBuilder.

Method Summary

Modifier and TypeMethod and Description
private void
addContainingInfo(IndexItem item, boolean addModuleInfo)

public void
addElements()

Overrides jdk.javadoc.internal.doclets.toolkit.util.IndexBuilder.addElements.

Adds all the selected modules, packages, types and their members to the index.

private void
createSearchIndexFile(DocPath
the file for the JavaScript to be generated
searchIndexJS
,
SortedSet<IndexItem>
the search index items
indexItems
,
String
the variable name to write in the JavaScript file
varName
)

Creates a search index file.

public void
createSearchIndexFiles()

Generates the set of index files used by interactive search.

Inherited from jdk.javadoc.internal.doclets.toolkit.util.IndexBuilder:
addgetFirstCharactersgetItemsgetItemsgetItemsmakeGenericSearchIndexComparatormakeTypeSearchIndexComparator

Field Detail

htmlIdsback to summary
private final HtmlIds htmlIds
resourcesback to summary
private final Resources resources

Constructor Detail

HtmlIndexBuilderback to summary
pack-priv HtmlIndexBuilder(HtmlConfiguration configuration)

Creates a new HtmlIndexBuilder.

Parameters
configuration:HtmlConfiguration

the current configuration of the doclet

Method Detail

addContainingInfoback to summary
private void addContainingInfo(IndexItem item, boolean addModuleInfo)
addElementsback to summary
public void addElements()

Overrides jdk.javadoc.internal.doclets.toolkit.util.IndexBuilder.addElements.

Doc from jdk.javadoc.internal.doclets.toolkit.util.IndexBuilder.addElements.

Adds all the selected modules, packages, types and their members to the index. After the initial work to add the element items, the remaining fields in the items are also initialized.

Annotations
@Override
createSearchIndexFileback to summary
private void createSearchIndexFile(DocPath searchIndexJS, SortedSet<IndexItem> indexItems, String varName) throws DocFileIOException

Creates a search index file.

Parameters
searchIndexJS:DocPath

the file for the JavaScript to be generated

indexItems:SortedSet<IndexItem>

the search index items

varName:String

the variable name to write in the JavaScript file

Exceptions
DocFileIOException:
if there is a problem creating the search index file
createSearchIndexFilesback to summary
public void createSearchIndexFiles() throws DocFileIOException

Generates the set of index files used by interactive search.

Exceptions
DocFileIOException:
if there is a problem creating any of the search index files