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

public Class ExternalSpecsWriter

extends HtmlDocletWriter
Class Inheritance
Imports
java.net.URI, .URISyntaxException, java.nio.file.Path, java.text.Collator, java.util.ArrayList, .Comparator, .HashMap, .List, .Map, .TreeMap, .TreeSet, .WeakHashMap, java.util.function.Predicate, javax.lang.model.element.Element, javax.tools.Diagnostic, com.sun.source.doctree.DocTree, .SpecTree, com.sun.source.util.DocTreePath, .TreePath, 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, .DocPaths, .IndexItem, jdk.javadoc.internal.html.Content, .ContentBuilder, .HtmlAttr, .HtmlId, .HtmlTag, .HtmlTree, .Script, .Text
Generates the file with the summary of all the references to external specifications.

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
public
ExternalSpecsWriter(HtmlConfiguration
The current configuration
configuration)

Constructs ExternalSpecsWriter object.

Method Summary

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

Adds all the references to external specifications to the content tree.

public void
buildPage()

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

Prints all the "external specs" to the file.

protected void
checkUniqueItems()

private Content
createHostSelect(List<String> hosts, boolean hasLocal)

private static int
find(String s, int start, Predicate<Character> p)

private URI

Returns:

the fully-resolved URI in index item for a @spec tag
getSpecURI(IndexItem
the index item
i)

Returns the fully-resolved URI in index item for a @spec tag.

pack-priv Comparator<String>
getTitleComparator()

private Map<String, List<IndexItem>>
groupExternalSpecs()

private void
report(IndexItem ii, String key, Object... args)

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

ExternalSpecsWriterback to summary
public ExternalSpecsWriter(HtmlConfiguration configuration)

Constructs ExternalSpecsWriter object.

Parameters
configuration:HtmlConfiguration

The current configuration

Method Detail

addExternalSpecsback to summary
protected void addExternalSpecs(Content content)

Adds all the references to external specifications to the content tree.

Parameters
content:Content

HtmlTree content to which the links will be added

buildPageback to summary
public void buildPage() throws DocFileIOException

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

Prints all the "external specs" to the file.

Annotations
@Override
checkUniqueItemsback to summary
protected void checkUniqueItems()
createHostSelectback to summary
private Content createHostSelect(List<String> hosts, boolean hasLocal)
createLinkback to summary
private Content createLink(IndexItem i)
createSpecLinkback to summary
private Content createSpecLink(IndexItem i)
findback to summary
private static int find(String s, int start, Predicate<Character> p)
getSpecURIback to summary
private URI getSpecURI(IndexItem i) throws URISyntaxException

Returns the fully-resolved URI in index item for a @spec tag. While the signature declares that it may throw URISynaxException, that should not occur: items with bad URIs should not make it into the index.

Parameters
i:IndexItem

the index item

Returns:URI

the fully-resolved URI in index item for a @spec tag

Exceptions
URISyntaxException:
if there is an issue creating the URI
getTitleComparatorback to summary
pack-priv Comparator<String> getTitleComparator()
groupExternalSpecsback to summary
private Map<String, List<IndexItem>> groupExternalSpecs()
reportback to summary
private void report(IndexItem ii, String key, Object... args)