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

public Class IndexRedirectWriter

extends HtmlDocletWriter
Class Inheritance
Imports
java.util.List, .Objects, jdk.javadoc.internal.doclets.formats.html.markup.Head, .HtmlDocument, .HtmlStyles, jdk.javadoc.internal.doclets.toolkit.util.DocFile, .DocFileIOException, .DocPath, .DocPaths, jdk.javadoc.internal.html.ContentBuilder, .HtmlAttr, .HtmlTag, .HtmlTree, .Script, .Text
Writes a file that tries to redirect to an alternate page. The redirect uses JavaScript, if enabled, falling back on <meta http-equiv=refresh content="0,<uri>">. If neither are supported/enabled in a browser, the page displays the standard "JavaScript not enabled" message, and a link to the alternate page.

Field Summary

Modifier and TypeField and Description
private final DocPath
target

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

Constructor Summary

AccessConstructor and Description
private
IndexRedirectWriter(HtmlConfiguration configuration, DocPath filename, DocPath target)

Method Summary

Modifier and TypeMethod and Description
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 void
generate(HtmlConfiguration configuration)

public static void
generate(HtmlConfiguration configuration, DocPath fileName, DocPath target)

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

Field Detail

targetback to summary
private final DocPath target

Constructor Detail

IndexRedirectWriterback to summary
private IndexRedirectWriter(HtmlConfiguration configuration, DocPath filename, DocPath target)

Method Detail

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
generateback to summary
public static void generate(HtmlConfiguration configuration) throws DocFileIOException
generateback to summary
public static void generate(HtmlConfiguration configuration, DocPath fileName, DocPath target) throws DocFileIOException