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

public Class NestedClassWriter

extends AbstractMemberWriter
Class Inheritance
Imports
javax.lang.model.element.Element, .TypeElement, jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyles, jdk.javadoc.internal.doclets.toolkit.util.VisibleMemberTable, jdk.javadoc.internal.html.Content, .ContentBuilder, .Entity, .HtmlId, .HtmlTree, .Text
Writes nested class documentation in HTML format.

Field Summary

Inherited from jdk.javadoc.internal.doclets.formats.html.AbstractMemberWriter:
configurationcontentsdetailKindshtmlIdskindoptionsresourcessummariesComparatorsummaryKindstypeElementutilsvisibleMemberTablewriter

Constructor Summary

AccessConstructor and Description
public
NestedClassWriter(ClassWriter writer)

public
NestedClassWriter(SubWriterHolderWriter writer)

Method Summary

Modifier and TypeMethod and Description
public void
addInheritedSummaryLabel(TypeElement typeElement, Content content)

Overrides jdk.javadoc.internal.doclets.formats.html.AbstractMemberWriter.addInheritedSummaryLabel.

Adds inherited summary label for the member.

public void
addSummaryLabel(Content content)

Implements abstract jdk.javadoc.internal.doclets.formats.html.AbstractMemberWriter.addSummaryLabel.

Adds the summary label for the member.

protected void
addSummaryType(Element member, Content content)

Implements abstract jdk.javadoc.internal.doclets.formats.html.AbstractMemberWriter.addSummaryType.

Adds the summary type for the member.

protected void
buildDeprecationInfo(Content target)

Implements abstract jdk.javadoc.internal.doclets.formats.html.AbstractMemberWriter.buildDeprecationInfo.

Builds the deprecation info.

public void
buildDetails(Content target)

Implements abstract jdk.javadoc.internal.doclets.formats.html.AbstractMemberWriter.buildDetails.

Builds the list of "details" for all members of this kind.

protected void
buildPreviewInfo(Content target)

Implements abstract jdk.javadoc.internal.doclets.formats.html.AbstractMemberWriter.buildPreviewInfo.

Builds the preview info.

protected void
buildSignature(Content target)

Implements abstract jdk.javadoc.internal.doclets.formats.html.AbstractMemberWriter.buildSignature.

Builds the signature.

public void
buildSummary(Content summariesList, Content content)

Implements abstract jdk.javadoc.internal.doclets.formats.html.AbstractMemberWriter.buildSummary.

Adds the given summary to the list of summaries.

protected Table<Element>
createInheritedSummaryTable(TypeElement typeElement)

Overrides jdk.javadoc.internal.doclets.formats.html.AbstractMemberWriter.createInheritedSummaryTable.

Creates a summary table for members of the kind supported by this writer inherited from typeElement.

protected Table<Element>
createSummaryTable()

Implements abstract jdk.javadoc.internal.doclets.formats.html.AbstractMemberWriter.createSummaryTable.

Creates the summary table for this element.

protected HtmlId
getInheritedSummaryId(TypeElement typeElement)

Overrides jdk.javadoc.internal.doclets.formats.html.AbstractMemberWriter.getInheritedSummaryId.

Creates an id for a summary table for members of the kind supported by this writer inherited from typeElement.

public Content
getMemberSummaryHeader(Content content)

Implements abstract jdk.javadoc.internal.doclets.formats.html.AbstractMemberWriter.getMemberSummaryHeader.

Returns the member summary header for the given class.

public TableHeader
getSummaryTableHeader(Element member)

Implements abstract jdk.javadoc.internal.doclets.formats.html.AbstractMemberWriter.getSummaryTableHeader.

Returns the summary table header for the member.

Inherited from jdk.javadoc.internal.doclets.formats.html.AbstractMemberWriter:
addCommentaddDeprecatedInfoaddInheritedMemberSummaryaddMemberSummaryaddModifiersAndTypeaddPreviewInfoaddRestrictedInfoaddUseInfobuildSummarygetInheritedSummaryHeadergetInheritedSummaryLinksgetMembergetMemberListgetMemberListItemgetMemberSummaryLinkOrFQNgetSummaryTablegetVisibleMembersnameserialWarning

Constructor Detail

NestedClassWriterback to summary
public NestedClassWriter(ClassWriter writer)
NestedClassWriterback to summary
public NestedClassWriter(SubWriterHolderWriter writer)

Method Detail

addInheritedSummaryLabelback to summary
public void addInheritedSummaryLabel(TypeElement typeElement, Content content)

Overrides jdk.javadoc.internal.doclets.formats.html.AbstractMemberWriter.addInheritedSummaryLabel.

Doc from jdk.javadoc.internal.doclets.formats.html.AbstractMemberWriter.addInheritedSummaryLabel.

Adds inherited summary label for the member.

Annotations
@Override
addInheritedSummaryLinkback to summary
protected void addInheritedSummaryLink(TypeElement typeElement, Element member, Content target)

Overrides jdk.javadoc.internal.doclets.formats.html.AbstractMemberWriter.addInheritedSummaryLink.

Doc from jdk.javadoc.internal.doclets.formats.html.AbstractMemberWriter.addInheritedSummaryLink.

Adds the inherited summary link for the member.

Annotations
@Override
addSummaryLabelback to summary
public void addSummaryLabel(Content content)

Implements abstract jdk.javadoc.internal.doclets.formats.html.AbstractMemberWriter.addSummaryLabel.

Doc from jdk.javadoc.internal.doclets.formats.html.AbstractMemberWriter.addSummaryLabel.

Adds the summary label for the member.

Annotations
@Override
addSummaryLinkback to summary
protected void addSummaryLink(HtmlLinkInfo.Kind context, TypeElement typeElement, Element member, Content content)

Implements abstract jdk.javadoc.internal.doclets.formats.html.AbstractMemberWriter.addSummaryLink.

Doc from jdk.javadoc.internal.doclets.formats.html.AbstractMemberWriter.addSummaryLink.

Adds the summary link for the member.

Annotations
@Override
addSummaryLinkback to summary
protected void addSummaryLink(TypeElement typeElement, Element member, Content content)

Overrides jdk.javadoc.internal.doclets.formats.html.AbstractMemberWriter.addSummaryLink.

Doc from jdk.javadoc.internal.doclets.formats.html.AbstractMemberWriter.addSummaryLink.

Adds the summary link for the member.

Annotations
@Override
addSummaryTypeback to summary
protected void addSummaryType(Element member, Content content)

Implements abstract jdk.javadoc.internal.doclets.formats.html.AbstractMemberWriter.addSummaryType.

Doc from jdk.javadoc.internal.doclets.formats.html.AbstractMemberWriter.addSummaryType.

Adds the summary type for the member.

Annotations
@Override
buildDeprecationInfoback to summary
protected void buildDeprecationInfo(Content target)

Implements abstract jdk.javadoc.internal.doclets.formats.html.AbstractMemberWriter.buildDeprecationInfo.

Doc from jdk.javadoc.internal.doclets.formats.html.AbstractMemberWriter.buildDeprecationInfo.

Builds the deprecation info.

buildDetailsback to summary
public void buildDetails(Content target)

Implements abstract jdk.javadoc.internal.doclets.formats.html.AbstractMemberWriter.buildDetails.

Doc from jdk.javadoc.internal.doclets.formats.html.AbstractMemberWriter.buildDetails.

Builds the list of "details" for all members of this kind.

Annotations
@Override
buildPreviewInfoback to summary
protected void buildPreviewInfo(Content target)

Implements abstract jdk.javadoc.internal.doclets.formats.html.AbstractMemberWriter.buildPreviewInfo.

Doc from jdk.javadoc.internal.doclets.formats.html.AbstractMemberWriter.buildPreviewInfo.

Builds the preview info.

buildSignatureback to summary
protected void buildSignature(Content target)

Implements abstract jdk.javadoc.internal.doclets.formats.html.AbstractMemberWriter.buildSignature.

Doc from jdk.javadoc.internal.doclets.formats.html.AbstractMemberWriter.buildSignature.

Builds the signature.

buildSummaryback to summary
public void buildSummary(Content summariesList, Content content)

Implements abstract jdk.javadoc.internal.doclets.formats.html.AbstractMemberWriter.buildSummary.

Doc from jdk.javadoc.internal.doclets.formats.html.AbstractMemberWriter.buildSummary.

Adds the given summary to the list of summaries.

Annotations
@Override
createInheritedSummaryTableback to summary
protected Table<Element> createInheritedSummaryTable(TypeElement typeElement)

Overrides jdk.javadoc.internal.doclets.formats.html.AbstractMemberWriter.createInheritedSummaryTable.

Doc from jdk.javadoc.internal.doclets.formats.html.AbstractMemberWriter.createInheritedSummaryTable.

Creates a summary table for members of the kind supported by this writer inherited from typeElement.

Annotations
@Override
createSummaryTableback to summary
protected Table<Element> createSummaryTable()

Implements abstract jdk.javadoc.internal.doclets.formats.html.AbstractMemberWriter.createSummaryTable.

Doc from jdk.javadoc.internal.doclets.formats.html.AbstractMemberWriter.createSummaryTable.

Creates the summary table for this element. The table should be created and initialized if needed, and configured so that it is ready to add content with Table#addRow(Content[]) and similar methods.

Annotations
@Override
getInheritedSummaryIdback to summary
protected HtmlId getInheritedSummaryId(TypeElement typeElement)

Overrides jdk.javadoc.internal.doclets.formats.html.AbstractMemberWriter.getInheritedSummaryId.

Doc from jdk.javadoc.internal.doclets.formats.html.AbstractMemberWriter.getInheritedSummaryId.

Creates an id for a summary table for members of the kind supported by this writer inherited from typeElement.

Annotations
@Override
getMemberSummaryHeaderback to summary
public Content getMemberSummaryHeader(Content content)

Implements abstract jdk.javadoc.internal.doclets.formats.html.AbstractMemberWriter.getMemberSummaryHeader.

Doc from jdk.javadoc.internal.doclets.formats.html.AbstractMemberWriter.getMemberSummaryHeader.

Returns the member summary header for the given class.

Annotations
@Override
getSummaryLinkback to summary
protected Content getSummaryLink(Element member)

Implements abstract jdk.javadoc.internal.doclets.formats.html.AbstractMemberWriter.getSummaryLink.

Doc from jdk.javadoc.internal.doclets.formats.html.AbstractMemberWriter.getSummaryLink.

Returns a link for summary (deprecated, preview) pages.

Annotations
@Override
getSummaryTableHeaderback to summary
public TableHeader getSummaryTableHeader(Element member)

Implements abstract jdk.javadoc.internal.doclets.formats.html.AbstractMemberWriter.getSummaryTableHeader.

Doc from jdk.javadoc.internal.doclets.formats.html.AbstractMemberWriter.getSummaryTableHeader.

Returns the summary table header for the member.

Annotations
@Override