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

public Class RestrictedListWriter

extends SummaryListWriter<RestrictedAPIListBuilder>
Class Inheritance
Imports
javax.lang.model.element.Element, jdk.javadoc.internal.doclets.formats.html.Navigation.PageMode, jdk.javadoc.internal.doclets.toolkit.util.DocPaths, .IndexItem, .RestrictedAPIListBuilder, jdk.javadoc.internal.html.Content
Generate File to list all the restricted methods with the appropriate links.

Field Summary

Inherited from jdk.javadoc.internal.doclets.formats.html.SummaryListWriter:
builderID_ALLID_OTHER

Constructor Summary

AccessConstructor and Description
public
RestrictedListWriter(HtmlConfiguration
the configuration for this doclet
configuration)

Constructor.

Method Summary

Modifier and TypeMethod and Description
protected void
addComments(Element e, Content desc)

Overrides jdk.javadoc.internal.doclets.formats.html.SummaryListWriter.addComments.

Add summary text for the given element.

protected String
getDescription()

Implements abstract jdk.javadoc.internal.doclets.formats.html.SummaryListWriter.getDescription.

Returns the page descrition, for the <meta> element.

protected Content
getHeadContent()

Implements abstract jdk.javadoc.internal.doclets.formats.html.SummaryListWriter.getHeadContent.

Returns the heading for the page.

protected Navigation.PageMode
getPageMode()

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

Returns the page mode to use.

protected String
getTitleKey()

Implements abstract jdk.javadoc.internal.doclets.formats.html.SummaryListWriter.getTitleKey.

Returns the title for the page.

protected boolean
showContentsList()

Overrides jdk.javadoc.internal.doclets.formats.html.SummaryListWriter.showContentsList.

Returns true if the contents list should be generated, false if not.

Inherited from jdk.javadoc.internal.doclets.formats.html.SummaryListWriter:
addContentSelectorsaddSummariesaddSummaryAPIaddTableTabsbuildPagegetCheckboxgetColumnStylesgetExtraContentgetHeadergetHeadingKeygetIndexLinkgetIndexLinksgetSummaryLinkgetTableCaptiongetTableHeader

Constructor Detail

RestrictedListWriterback to summary
public RestrictedListWriter(HtmlConfiguration configuration)

Constructor.

Parameters
configuration:HtmlConfiguration

the configuration for this doclet

Method Detail

addCommentsback to summary
protected void addComments(Element e, Content desc)

Overrides jdk.javadoc.internal.doclets.formats.html.SummaryListWriter.addComments.

Doc from jdk.javadoc.internal.doclets.formats.html.SummaryListWriter.addComments.

Add summary text for the given element.

Annotations
@Override
getDescriptionback to summary
protected String getDescription()

Implements abstract jdk.javadoc.internal.doclets.formats.html.SummaryListWriter.getDescription.

Doc from jdk.javadoc.internal.doclets.formats.html.SummaryListWriter.getDescription.

Returns the page descrition, for the <meta> element.

Annotations
@Override
getHeadContentback to summary
protected Content getHeadContent()

Implements abstract jdk.javadoc.internal.doclets.formats.html.SummaryListWriter.getHeadContent.

Doc from jdk.javadoc.internal.doclets.formats.html.SummaryListWriter.getHeadContent.

Returns the heading for the page.

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

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

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

Returns the page mode to use.

Annotations
@Override
getTitleKeyback to summary
protected String getTitleKey()

Implements abstract jdk.javadoc.internal.doclets.formats.html.SummaryListWriter.getTitleKey.

Doc from jdk.javadoc.internal.doclets.formats.html.SummaryListWriter.getTitleKey.

Returns the title for the page.

Annotations
@Override
showContentsListback to summary
protected boolean showContentsList()

Overrides jdk.javadoc.internal.doclets.formats.html.SummaryListWriter.showContentsList.

Doc from jdk.javadoc.internal.doclets.formats.html.SummaryListWriter.showContentsList.

Returns true if the contents list should be generated, false if not.

Annotations
@Override