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

public abstract Class IndexItemListWriter

extends HtmlDocletWriter
Class Inheritance
Known Direct Subclasses
jdk.javadoc.internal.doclets.formats.html.IndexItemListWriter.SystemPropertiesWriter, jdk.javadoc.internal.doclets.formats.html.IndexItemListWriter.SearchTagsWriter
Imports
java.nio.file.Path, java.util.ArrayList, .List, .Locale, .Map, .Objects, .TreeMap, .WeakHashMap, java.util.stream.Collectors, com.sun.source.doctree.DocTree, jdk.javadoc.internal.doclets.formats.html.Navigation.PageMode, jdk.javadoc.internal.doclets.formats.html.markup.BodyContents, .HtmlStyles, jdk.javadoc.internal.doclets.toolkit.DocFileElement, .OverviewElement, jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException, .DocPath, .DocPaths, .IndexItem, jdk.javadoc.internal.html.Content, .ContentBuilder, .HtmlTree, .Text
Generates summary files for tags represented by IndexItem. Supported items are search tags and system properties.

Nested and Inner Type Summary

Modifier and TypeClass and Description
pack-priv static class
IndexItemListWriter.SearchTagsWriter

pack-priv static class
IndexItemListWriter.SystemPropertiesWriter

Field Summary

Modifier and TypeField and Description
pack-priv final Map<DocFileElement, String>
titles

Cached contents of <title>...

Inherited from jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter:
comparatorsconfigurationcontentsdocPathshtmlIdsindexAnchorTablelinksmainBodyScriptmessagesoptionspathpathToRootresourcestableOfContentsutilswinTitle

Constructor Summary

AccessConstructor and Description
protected
IndexItemListWriter(HtmlConfiguration
The current configuration
configuration, DocPath
the doc path of the file to write
path)

Constructs a IndexItemListWriter object.

Method Summary

Modifier and TypeMethod and Description
protected abstract void
addIndexItems(Content
the content to which the table will be added
target)

Adds a table with the included index items to the content.

public void
buildPage()

Implements abstract jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter.buildPage.

The top-level method to generate and write the page represented by this writer.

public static IndexItemListWriter
createSearchTagsWriter(HtmlConfiguration configuration)

public static IndexItemListWriter
createSystemPropertiesWriter(HtmlConfiguration configuration)

protected abstract HtmlConfiguration.ConditionalPage

Returns:

the conditional page value
getConditionalPage()

Returns the conditional page value.

protected abstract DocTree.Kind

Returns:

the kind of index item to list in this page
getKind()

Returns the kind of index item to list in this page.

protected abstract Content

Returns:

the label for the page heading
getPageLabel()

Returns the label for the page heading.

protected abstract Navigation.PageMode

Returns:

the Navigation.PageMode value
getPageMode()

Returns the Navigation.PageMode value.

protected Map<String, List<IndexItem>>
groupTags()

Inherited from jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter:
addInlineCommentaddInlineCommentaddInlineDeprecatedCommentaddPreQualifiedClassLinkaddPreQualifiedClassLinkaddPreQualifiedStrongClassLinkaddPreviewCommentaddPreviewInfoaddPreviewSummaryaddRestrictedInfoaddRestrictedSummaryaddSrcLinkaddSummaryCommentaddSummaryCommentaddSummaryDeprecatedCommentaddTagsInfocommentTagsToContentcommentTagsToContentcommentTagsToContentcreateTableOfContentsgetAnnotationInfogetAnnotationInfogetAnnotationsgetBlockTagOutputgetBlockTagOutputgetBodygetBodyStylegetCrossClassLinkgetCrossModuleLinkgetCrossPackageLinkgetCurrentTypeElementgetDeprecatedPhrasegetDescriptiongetDocLinkgetDocLinkgetDocLinkgetDocLinkgetDocLinkgetEnclosingPackageNamegetFileTitlegetFootergetGeneratorgetHeadergetHeadergetLinkgetLocalizedPackageNamegetLocalStylesheetsgetModuleLinkgetModuleLinkgetNavBargetNavLinkToOverviewTreegetPackageLabelgetPackageLinkgetPackageLinkgetPackageTableHeadergetPreQualifiedClassLinkgetQualifiedClassLinkgetTagletWriterInstancegetTagletWriterInstancegetTypeParameterLinksgetWindowTitlehasSerializationOverviewTagsignoreNonInlineTaginvalidTagOutputisIndexablepathStringpathStringprintHtmlDocumentprintHtmlDocumentprintHtmlDocumentreplaceDocRootDirresolveExternalSpecURIwriteGenerating

Field Detail

titlesback to summary
pack-priv final Map<DocFileElement, String> titles

Cached contents of <title>...</title> tags of the HTML pages.

Constructor Detail

IndexItemListWriterback to summary
protected IndexItemListWriter(HtmlConfiguration configuration, DocPath path)

Constructs a IndexItemListWriter object.

Parameters
configuration:HtmlConfiguration

The current configuration

path:DocPath

the doc path of the file to write

Method Detail

addIndexItemsback to summary
protected abstract void addIndexItems(Content target)

Adds a table with the included index items to the content.

Parameters
target:Content

the content to which the table will be added

buildPageback to summary
public void buildPage() throws DocFileIOException

Implements abstract jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter.buildPage.

Doc from jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter.buildPage.

The top-level method to generate and write the page represented by this writer.

Annotations
@Override
createLinkback to summary
protected Content createLink(IndexItem i)
createSearchTagsWriterback to summary
public static IndexItemListWriter createSearchTagsWriter(HtmlConfiguration configuration)
createSystemPropertiesWriterback to summary
public static IndexItemListWriter createSystemPropertiesWriter(HtmlConfiguration configuration)
getConditionalPageback to summary
protected abstract HtmlConfiguration.ConditionalPage getConditionalPage()

Returns the conditional page value.

Returns:HtmlConfiguration.ConditionalPage

the conditional page value

getKindback to summary
protected abstract DocTree.Kind getKind()

Returns the kind of index item to list in this page.

Returns:DocTree.Kind

the kind of index item to list in this page

getPageLabelback to summary
protected abstract Content getPageLabel()

Returns the label for the page heading.

Returns:Content

the label for the page heading

getPageModeback to summary
protected abstract Navigation.PageMode getPageMode()

Returns the Navigation.PageMode value.

Returns:Navigation.PageMode

the Navigation.PageMode value

groupTagsback to summary
protected Map<String, List<IndexItem>> groupTags()
jdk.javadoc.internal.doclets.formats.html back to summary

pack-priv Class IndexItemListWriter.SearchTagsWriter

extends IndexItemListWriter
Class Inheritance

Field Summary

Inherited from jdk.javadoc.internal.doclets.formats.html.IndexItemListWriter:
titles

Constructor Summary

AccessConstructor and Description
pack-priv
SearchTagsWriter(HtmlConfiguration configuration)

Method Summary

Modifier and TypeMethod and Description
protected void
addIndexItems(Content
the content to which the links will be added
target)

Implements abstract jdk.javadoc.internal.doclets.formats.html.IndexItemListWriter.addIndexItems.

Creates a 3-column table containing search tags.

protected HtmlConfiguration.ConditionalPage
getConditionalPage()

Implements abstract jdk.javadoc.internal.doclets.formats.html.IndexItemListWriter.getConditionalPage.

Returns the conditional page value.

protected DocTree.Kind
getKind()

Implements abstract jdk.javadoc.internal.doclets.formats.html.IndexItemListWriter.getKind.

Returns the kind of index item to list in this page.

protected Content
getPageLabel()

Implements abstract jdk.javadoc.internal.doclets.formats.html.IndexItemListWriter.getPageLabel.

Returns the label for the page heading.

protected Navigation.PageMode
getPageMode()

Implements abstract jdk.javadoc.internal.doclets.formats.html.IndexItemListWriter.getPageMode.

Returns the Navigation.PageMode value.

Inherited from jdk.javadoc.internal.doclets.formats.html.IndexItemListWriter:
buildPagecreateLinkcreateSearchTagsWritercreateSystemPropertiesWritergroupTags

Constructor Detail

SearchTagsWriterback to summary
pack-priv SearchTagsWriter(HtmlConfiguration configuration)

Method Detail

addIndexItemsback to summary
protected void addIndexItems(Content target)

Implements abstract jdk.javadoc.internal.doclets.formats.html.IndexItemListWriter.addIndexItems.

Creates a 3-column table containing search tags.

Parameters
target:Content

the content to which the links will be added

Annotations
@Override
getConditionalPageback to summary
protected HtmlConfiguration.ConditionalPage getConditionalPage()

Implements abstract jdk.javadoc.internal.doclets.formats.html.IndexItemListWriter.getConditionalPage.

Doc from jdk.javadoc.internal.doclets.formats.html.IndexItemListWriter.getConditionalPage.

Returns the conditional page value.

Annotations
@Override
getKindback to summary
protected DocTree.Kind getKind()

Implements abstract jdk.javadoc.internal.doclets.formats.html.IndexItemListWriter.getKind.

Doc from jdk.javadoc.internal.doclets.formats.html.IndexItemListWriter.getKind.

Returns the kind of index item to list in this page.

Annotations
@Override
getPageLabelback to summary
protected Content getPageLabel()

Implements abstract jdk.javadoc.internal.doclets.formats.html.IndexItemListWriter.getPageLabel.

Doc from jdk.javadoc.internal.doclets.formats.html.IndexItemListWriter.getPageLabel.

Returns the label for the page heading.

Annotations
@Override
getPageModeback to summary
protected Navigation.PageMode getPageMode()

Implements abstract jdk.javadoc.internal.doclets.formats.html.IndexItemListWriter.getPageMode.

Doc from jdk.javadoc.internal.doclets.formats.html.IndexItemListWriter.getPageMode.

Returns the Navigation.PageMode value.

Annotations
@Override
jdk.javadoc.internal.doclets.formats.html back to summary

pack-priv Class IndexItemListWriter.SystemPropertiesWriter

extends IndexItemListWriter
Class Inheritance

Field Summary

Inherited from jdk.javadoc.internal.doclets.formats.html.IndexItemListWriter:
titles

Constructor Summary

AccessConstructor and Description
pack-priv
SystemPropertiesWriter(HtmlConfiguration configuration)

Method Summary

Modifier and TypeMethod and Description
protected void
addIndexItems(Content
the content to which the links will be added
target)

Implements abstract jdk.javadoc.internal.doclets.formats.html.IndexItemListWriter.addIndexItems.

Creates a 2-column table containing system properties.

protected HtmlConfiguration.ConditionalPage
getConditionalPage()

Implements abstract jdk.javadoc.internal.doclets.formats.html.IndexItemListWriter.getConditionalPage.

Returns the conditional page value.

protected DocTree.Kind
getKind()

Implements abstract jdk.javadoc.internal.doclets.formats.html.IndexItemListWriter.getKind.

Returns the kind of index item to list in this page.

protected Content
getPageLabel()

Implements abstract jdk.javadoc.internal.doclets.formats.html.IndexItemListWriter.getPageLabel.

Returns the label for the page heading.

protected Navigation.PageMode
getPageMode()

Implements abstract jdk.javadoc.internal.doclets.formats.html.IndexItemListWriter.getPageMode.

Returns the Navigation.PageMode value.

Inherited from jdk.javadoc.internal.doclets.formats.html.IndexItemListWriter:
buildPagecreateLinkcreateSearchTagsWritercreateSystemPropertiesWritergroupTags

Constructor Detail

SystemPropertiesWriterback to summary
pack-priv SystemPropertiesWriter(HtmlConfiguration configuration)

Method Detail

addIndexItemsback to summary
protected void addIndexItems(Content target)

Implements abstract jdk.javadoc.internal.doclets.formats.html.IndexItemListWriter.addIndexItems.

Creates a 2-column table containing system properties.

Parameters
target:Content

the content to which the links will be added

Annotations
@Override
getConditionalPageback to summary
protected HtmlConfiguration.ConditionalPage getConditionalPage()

Implements abstract jdk.javadoc.internal.doclets.formats.html.IndexItemListWriter.getConditionalPage.

Doc from jdk.javadoc.internal.doclets.formats.html.IndexItemListWriter.getConditionalPage.

Returns the conditional page value.

Annotations
@Override
getKindback to summary
protected DocTree.Kind getKind()

Implements abstract jdk.javadoc.internal.doclets.formats.html.IndexItemListWriter.getKind.

Doc from jdk.javadoc.internal.doclets.formats.html.IndexItemListWriter.getKind.

Returns the kind of index item to list in this page.

Annotations
@Override
getPageLabelback to summary
protected Content getPageLabel()

Implements abstract jdk.javadoc.internal.doclets.formats.html.IndexItemListWriter.getPageLabel.

Doc from jdk.javadoc.internal.doclets.formats.html.IndexItemListWriter.getPageLabel.

Returns the label for the page heading.

Annotations
@Override
getPageModeback to summary
protected Navigation.PageMode getPageMode()

Implements abstract jdk.javadoc.internal.doclets.formats.html.IndexItemListWriter.getPageMode.

Doc from jdk.javadoc.internal.doclets.formats.html.IndexItemListWriter.getPageMode.

Returns the Navigation.PageMode value.

Annotations
@Override