OpenJDK 27 · jdk.javadoc.internal.doclets.formats.html.SubWriterHolderWriter

Modifier and Type	Field and Description
protected BodyContents	bodyContents The HTML builder for the body contents.

Access	Constructor and Description
public	SubWriterHolderWriter(HtmlConfiguration configuration, DocPath filename)
public	SubWriterHolderWriter(HtmlConfiguration configuration, DocPath filename, boolean generating)

Method Summary

Modifier and Type	Method and Description
public void	addClassContent(Content class content which will be added to the documentation classContent) Add the class content.
protected void	addIndexComment(Element the member being documented member, Content the content to which the comment will be added content) Add the index comment.
protected void	addIndexComment(Element the member being documented member, List<? extends DocTree> the first sentence tags for the member to be documented firstSentenceTags, Content the content to which the comment will be added tdSummaryContent) Add the index comment.
public void	addInheritedMemberSummary(AbstractMemberWriter the writer for the member being documented mw, TypeElement the class being documented typeElement, Element the member being documented member, boolean true if it is the first link being documented isFirst, Content the content to which the summary will be added linksContent) Add the inherited member summary.
public void	addInheritedSummaryHeader(AbstractMemberWriter the writer for the member being documented mw, TypeElement the te to be documented typeElement, Content the content to which the inherited summary header will be added inheritedContent) Add the inherited summary header.
public void	addSummary(HtmlStyle the CSS class for the section style, HtmlId the id for the section htmlId, Content the list of summary sections to which the summary will be added target, Content the content representing the summary source) Adds a section for a summary with the given CSS `class` and `id` attribute.
public void	addSummaryHeader(AbstractMemberWriter the writer for the member being documented mw, Content the content to which the summary header will be added memberContent) Add the summary header.
public void	addSummaryLinkComment(Element the member to be documented member, Content the content to which the link will be added content) Add the summary link for the member.
public void	addSummaryLinkComment(Element the member being documented member, List<? extends DocTree> the first sentence tags for the member to be documented firstSentenceTags, Content the content to which the comment will be added tdSummaryContent) Add the summary link comment.
public Content	Returns: the document content header getContentHeader() Returns the document content header.
public Content	Returns: a list to be used for the list of details for members of a given kind getDetailsList() Returns a list to be used for the list of details for members of a given kind.
public Content	Returns: an item for the list of details for members of a given kind getDetailsListItem(Content content for the item content) Returns an item for the list of details for members of a given kind.
public Content	Returns: the member content getMember(Content the content used to generate the complete member content) Returns the member content.
public Content	Returns: the member content getMember(HtmlId the id to be used for the content id, HtmlStyle the style class to be added to the content style, Content the content used to generate the complete member content source) Get the member content
public Content	getMemberInherited()
public Content	Returns: a list to add member items to getMemberList() Returns a list to add member items to.
public Content	Returns: a member item getMemberListItem(Content the member to represent as an item member) Returns a member item.
public Content	Returns: the member summary content getMemberSummary(Content the content used to generate the member summary memberContent) Returns the member summary content.
public PropertyUtils.PropertyHelper	getPropertyHelper()
public Content	Returns: a list to be used for the list of summaries for members of a given kind getSummariesList() Returns a list to be used for the list of summaries for members of a given kind.
public Content	Returns: an item for the list of summaries for members of a given kind getSummariesListItem(Content content for the item content) Returns an item for the list of summaries for members of a given kind.

Inherited from jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter:: addInlineComment addInlineComment addInlineDeprecatedComment addPreQualifiedClassLink addPreQualifiedClassLink addPreQualifiedStrongClassLink addPreviewComment addPreviewInfo addPreviewSummary addRestrictedInfo addRestrictedSummary addSrcLink addSummaryComment addSummaryComment addSummaryDeprecatedComment addTagsInfo buildPage commentTagsToContent commentTagsToContent commentTagsToContent createTableOfContents getAnnotationInfo getAnnotationInfo getAnnotations getBlockTagOutput getBlockTagOutput getBody getBodyStyle getCrossClassLink getCrossModuleLink getCrossPackageLink getCurrentTypeElement getDeprecatedPhrase getDescription getDocLink getDocLink getDocLink getDocLink getDocLink getEnclosingPackageName getFileTitle getFooter getGenerator getHeader getHeader getLink getLocalizedPackageName getLocalStylesheets getModuleLink getModuleLink getNavBar getNavLinkToOverviewTree getPackageLabel getPackageLink getPackageLink getPackageTableHeader getPreQualifiedClassLink getQualifiedClassLink getTagletWriterInstance getTagletWriterInstance getTypeParameterLinks getWindowTitle hasSerializationOverviewTags ignoreNonInlineTag invalidTagOutput isIndexable pathString pathString printHtmlDocument printHtmlDocument printHtmlDocument replaceDocRootDir resolveExternalSpecURI writeGenerating

bodyContents	back to summary
protected BodyContents bodyContents The HTML builder for the body contents.

SubWriterHolderWriter	back to summary
public SubWriterHolderWriter(HtmlConfiguration configuration, DocPath filename)

SubWriterHolderWriter	back to summary
public SubWriterHolderWriter(HtmlConfiguration configuration, DocPath filename, boolean generating)

Method Detail

addClassContent	back to summary
public void addClassContent(Content classContent) Add the class content. Parameters classContent:Content class content which will be added to the documentation

addClassContent

back to summary

public void addClassContent(Content classContent)

Add the class content.

Parameters

classContent:Content: class content which will be added to the documentation

addIndexComment	back to summary
protected void addIndexComment(Element member, Content content) Add the index comment. Parameters member:Element the member being documented content:Content the content to which the comment will be added

addIndexComment

back to summary

protected void addIndexComment(Element member, Content content)

Add the index comment.

Parameters

member:Element: the member being documented
content:Content: the content to which the comment will be added

addIndexComment	back to summary
protected void addIndexComment(Element member, List<? extends DocTree> firstSentenceTags, Content tdSummaryContent) Add the index comment. Parameters member:Element the member being documented firstSentenceTags:List<? extends DocTree> the first sentence tags for the member to be documented tdSummaryContent:Content the content to which the comment will be added

addIndexComment

back to summary

protected void addIndexComment(Element member, List<? extends DocTree> firstSentenceTags, Content tdSummaryContent)

Add the index comment.

Parameters

member:Element: the member being documented
firstSentenceTags:List<? extends DocTree>: the first sentence tags for the member to be documented
tdSummaryContent:Content: the content to which the comment will be added

addInheritedMemberSummary	back to summary
public void addInheritedMemberSummary(AbstractMemberWriter mw, TypeElement typeElement, Element member, boolean isFirst, Content linksContent) Add the inherited member summary. Parameters mw:AbstractMemberWriter the writer for the member being documented typeElement:TypeElement the class being documented member:Element the member being documented isFirst:boolean true if it is the first link being documented linksContent:Content the content to which the summary will be added

addInheritedMemberSummary

back to summary

public void addInheritedMemberSummary(AbstractMemberWriter mw, TypeElement typeElement, Element member, boolean isFirst, Content linksContent)

Add the inherited member summary.

Parameters

mw:AbstractMemberWriter: the writer for the member being documented
typeElement:TypeElement: the class being documented
member:Element: the member being documented
isFirst:boolean: true if it is the first link being documented
linksContent:Content: the content to which the summary will be added

addInheritedSummaryHeader	back to summary
public void addInheritedSummaryHeader(AbstractMemberWriter mw, TypeElement typeElement, Content inheritedContent) Add the inherited summary header. Parameters mw:AbstractMemberWriter the writer for the member being documented typeElement:TypeElement the te to be documented inheritedContent:Content the content to which the inherited summary header will be added

addInheritedSummaryHeader

back to summary

public void addInheritedSummaryHeader(AbstractMemberWriter mw, TypeElement typeElement, Content inheritedContent)

Add the inherited summary header.

Parameters

mw:AbstractMemberWriter: the writer for the member being documented
typeElement:TypeElement: the te to be documented
inheritedContent:Content: the content to which the inherited summary header will be added

addSummary back to summary

addSummary	back to summary
public void addSummary(HtmlStyle style, HtmlId htmlId, Content target, Content source) Adds a section for a summary with the given CSS `class` and `id` attribute. Parameters style:HtmlStyle the CSS class for the section htmlId:HtmlId the id for the section target:Content the list of summary sections to which the summary will be added source:Content the content representing the summary

public void addSummary(HtmlStyle style, HtmlId htmlId, Content target, Content source)

Adds a section for a summary with the given CSS class and id attribute.

Parameters

style:HtmlStyle: the CSS class for the section
htmlId:HtmlId: the id for the section
target:Content: the list of summary sections to which the summary will be added
source:Content: the content representing the summary

addSummaryHeader	back to summary
public void addSummaryHeader(AbstractMemberWriter mw, Content memberContent) Add the summary header. Parameters mw:AbstractMemberWriter the writer for the member being documented memberContent:Content the content to which the summary header will be added

addSummaryHeader

back to summary

public void addSummaryHeader(AbstractMemberWriter mw, Content memberContent)

Add the summary header.

Parameters

mw:AbstractMemberWriter: the writer for the member being documented
memberContent:Content: the content to which the summary header will be added

addSummaryLinkComment	back to summary
public void addSummaryLinkComment(Element member, Content content) Add the summary link for the member. Parameters member:Element the member to be documented content:Content the content to which the link will be added

addSummaryLinkComment

back to summary

public void addSummaryLinkComment(Element member, Content content)

Add the summary link for the member.

Parameters

member:Element: the member to be documented
content:Content: the content to which the link will be added

addSummaryLinkComment	back to summary
public void addSummaryLinkComment(Element member, List<? extends DocTree> firstSentenceTags, Content tdSummaryContent) Add the summary link comment. Parameters member:Element the member being documented firstSentenceTags:List<? extends DocTree> the first sentence tags for the member to be documented tdSummaryContent:Content the content to which the comment will be added

addSummaryLinkComment

back to summary

public void addSummaryLinkComment(Element member, List<? extends DocTree> firstSentenceTags, Content tdSummaryContent)

Add the summary link comment.

Parameters

member:Element: the member being documented
firstSentenceTags:List<? extends DocTree>: the first sentence tags for the member to be documented
tdSummaryContent:Content: the content to which the comment will be added

getContentHeader	back to summary
public Content getContentHeader() Returns the document content header. Returns:Content the document content header

getContentHeader

back to summary

public Content getContentHeader()

Returns the document content header.

Returns:Content: the document content header

getDetailsList	back to summary
public Content getDetailsList() Returns a list to be used for the list of details for members of a given kind. Returns:Content a list to be used for the list of details for members of a given kind

getDetailsList

back to summary

public Content getDetailsList()

Returns a list to be used for the list of details for members of a given kind.

Returns:Content: a list to be used for the list of details for members of a given kind

getDetailsListItem	back to summary
public Content getDetailsListItem(Content content) Returns an item for the list of details for members of a given kind. Parameters content:Content content for the item Returns:Content an item for the list of details for members of a given kind

getDetailsListItem

back to summary

public Content getDetailsListItem(Content content)

Returns an item for the list of details for members of a given kind.

Parameters

content:Content: content for the item

Returns:Content

an item for the list of details for members of a given kind

getMember	back to summary
public Content getMember(Content content) Returns the member content. Parameters content:Content the content used to generate the complete member Returns:Content the member content

getMember

back to summary

public Content getMember(Content content)

Returns the member content.

Parameters

content:Content: the content used to generate the complete member

Returns:Content

the member content

getMember	back to summary
public Content getMember(HtmlId id, HtmlStyle style, Content source) Get the member content Parameters id:HtmlId the id to be used for the content style:HtmlStyle the style class to be added to the content source:Content the content used to generate the complete member content Returns:Content the member content

getMember

back to summary

public Content getMember(HtmlId id, HtmlStyle style, Content source)

Get the member content

Parameters

id:HtmlId: the id to be used for the content
style:HtmlStyle: the style class to be added to the content
source:Content: the content used to generate the complete member content

Returns:Content

the member content

getMemberInherited	back to summary
public Content getMemberInherited()

getMemberList	back to summary
public Content getMemberList() Returns a list to add member items to. Returns:Content a list to add member items to

getMemberList

back to summary

public Content getMemberList()

Returns a list to add member items to.

Returns:Content: a list to add member items to

getMemberListItem	back to summary
public Content getMemberListItem(Content member) Returns a member item. Parameters member:Content the member to represent as an item Returns:Content a member item

getMemberListItem

back to summary

public Content getMemberListItem(Content member)

Returns a member item.

Parameters

member:Content: the member to represent as an item

Returns:Content

a member item

getMemberSummary	back to summary
public Content getMemberSummary(Content memberContent) Returns the member summary content. Parameters memberContent:Content the content used to generate the member summary Returns:Content the member summary content

getMemberSummary

back to summary

public Content getMemberSummary(Content memberContent)

Returns the member summary content.

Parameters

memberContent:Content: the content used to generate the member summary

Returns:Content

the member summary content

getPropertyHelper	back to summary
public PropertyUtils.PropertyHelper getPropertyHelper()

getSummariesList	back to summary
public Content getSummariesList() Returns a list to be used for the list of summaries for members of a given kind. Returns:Content a list to be used for the list of summaries for members of a given kind

getSummariesList

back to summary

public Content getSummariesList()

Returns a list to be used for the list of summaries for members of a given kind.

Returns:Content: a list to be used for the list of summaries for members of a given kind

getSummariesListItem	back to summary
public Content getSummariesListItem(Content content) Returns an item for the list of summaries for members of a given kind. Parameters content:Content content for the item Returns:Content an item for the list of summaries for members of a given kind

getSummariesListItem

back to summary

public Content getSummariesListItem(Content content)

Returns an item for the list of summaries for members of a given kind.

Parameters

content:Content: content for the item

Returns:Content

an item for the list of summaries for members of a given kind

public abstract Class SubWriterHolderWriter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail