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

public Class AllClassesIndexWriter

extends HtmlDocletWriter
Class Inheritance
Imports
java.util.ArrayList, .List, .Set, .TreeSet, javax.lang.model.element.TypeElement, com.sun.source.doctree.DeprecatedTree, jdk.javadoc.internal.doclets.formats.html.Navigation.PageMode, jdk.javadoc.internal.doclets.formats.html.markup.BodyContents, .HtmlStyles, jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException, .DocPaths, .Utils.ElementFlag, jdk.javadoc.internal.html.Content, .ContentBuilder, .HtmlTree

Generate the file with list of all the classes in this run.

Field Summary

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

Constructor Summary

AccessConstructor and Description
public
AllClassesIndexWriter(HtmlConfiguration
The current configuration
configuration
)

Construct AllClassesIndexWriter object.

Method Summary

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

Add all types to the content.

protected void
addTableRow(Table<TypeElement>
the table to which the row will be added
table
,
TypeElement
the type to be added to the table
klass
)

Add table row.

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.

private Set<TypeElement>
Inherited from jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter:
addInlineCommentaddInlineCommentaddInlineDeprecatedCommentaddPreQualifiedClassLinkaddPreQualifiedClassLinkaddPreQualifiedStrongClassLinkaddPreviewCommentaddPreviewInfoaddPreviewSummaryaddRestrictedInfoaddRestrictedSummaryaddSrcLinkaddSummaryCommentaddSummaryCommentaddSummaryDeprecatedCommentaddTagsInfocommentTagsToContentcommentTagsToContentcommentTagsToContentcreateTableOfContentsgetAnnotationInfogetAnnotationInfogetAnnotationsgetBlockTagOutputgetBlockTagOutputgetBodygetBodyStylegetCrossClassLinkgetCrossModuleLinkgetCrossPackageLinkgetCurrentTypeElementgetDeprecatedPhrasegetDescriptiongetDocLinkgetDocLinkgetDocLinkgetDocLinkgetDocLinkgetEnclosingPackageNamegetFileTitlegetFootergetGeneratorgetHeadergetHeadergetLinkgetLocalizedPackageNamegetLocalStylesheetsgetModuleLinkgetModuleLinkgetNavBargetNavLinkToOverviewTreegetPackageLabelgetPackageLinkgetPackageLinkgetPackageTableHeadergetPreQualifiedClassLinkgetQualifiedClassLinkgetTagletWriterInstancegetTagletWriterInstancegetTypeParameterLinksgetWindowTitlehasSerializationOverviewTagsignoreNonInlineTaginvalidTagOutputisIndexablepathStringpathStringprintHtmlDocumentprintHtmlDocumentprintHtmlDocumentreplaceDocRootDirresolveExternalSpecURIwriteGenerating

Constructor Detail

AllClassesIndexWriterback to summary
public AllClassesIndexWriter(HtmlConfiguration configuration)

Construct AllClassesIndexWriter object. Also initializes the indexBuilder variable in this class.

Parameters
configuration:HtmlConfiguration

The current configuration

Method Detail

addContentsback to summary
protected void addContents(Content target)

Add all types to the content.

Parameters
target:Content

the content to which the links will be added

addTableRowback to summary
protected void addTableRow(Table<TypeElement> table, TypeElement klass)

Add table row.

Parameters
table:Table<TypeElement>

the table to which the row will be added

klass:TypeElement

the type to be added to the table

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
getTypeElementsback to summary
private Set<TypeElement> getTypeElements()