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

public Class PropertyWriter

extends AbstractMemberWriter
Class Inheritance
Imports
java.util.ArrayList, java.util.stream.Collectors, javax.lang.model.element.Element, .ExecutableElement, .TypeElement, com.sun.source.doctree.DocCommentTree, .DocTree, jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyles, jdk.javadoc.internal.doclets.toolkit.BaseOptions, .CommentUtils, jdk.javadoc.internal.doclets.toolkit.util.VisibleMemberTable, jdk.javadoc.internal.html.Content, .ContentBuilder, .Entity, .HtmlId, .HtmlTree, .Text
Writes property documentation in HTML format.

Field Summary

Modifier and TypeField and Description
private ExecutableElement
currentProperty

The index of the current property that is being documented at this point in time.

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

Constructor Summary

AccessConstructor and Description
public
PropertyWriter(ClassWriter writer)

Method Summary

Modifier and TypeMethod and Description
protected void
addComments(ExecutableElement property, Content propertyContent)

protected void
addDeprecated(ExecutableElement property, Content propertyContent)

public void
addInheritedSummaryLabel(TypeElement typeElement, Content content)

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

Adds inherited summary label for the member.

protected void
addPreview(ExecutableElement property, Content content)

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
addTags(ExecutableElement property, Content propertyContent)

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
buildPropertyComments(Content
the content to which the documentation will be added
propertyContent)

Build the comments for the property.

protected void
buildPropertyDoc(Content
the content to which the documentation will be added
detailsList)

Build the property documentation.

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 void
buildTagInfo(Content
the content to which the documentation will be added
propertyContent)

Build the tag information.

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.

protected Content
getPropertyDetails(Content memberDetailsHeader, Content memberDetails)

protected Content
getPropertyDetailsHeader(Content memberDetails)

protected Content
getPropertyHeaderContent(ExecutableElement property)

protected Content
getSignature(ExecutableElement property)

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:
addCommentaddDeprecatedInfoaddInheritedMemberSummaryaddMemberSummaryaddModifiersAndTypeaddPreviewInfoaddRestrictedInfoaddSummaryLinkaddUseInfobuildSummarygetInheritedSummaryHeadergetInheritedSummaryLinksgetMembergetMemberListgetMemberListItemgetMemberSummaryLinkOrFQNgetSummaryTablegetVisibleMembersnameserialWarning

Field Detail

currentPropertyback to summary
private ExecutableElement currentProperty

The index of the current property that is being documented at this point in time.

Constructor Detail

PropertyWriterback to summary
public PropertyWriter(ClassWriter writer)

Method Detail

addCommentsback to summary
protected void addComments(ExecutableElement property, Content propertyContent)
addDeprecatedback to summary
protected void addDeprecated(ExecutableElement property, Content propertyContent)
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
addPreviewback to summary
protected void addPreview(ExecutableElement property, Content content)
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
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
addTagsback to summary
protected void addTags(ExecutableElement property, Content propertyContent)
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.

Annotations
@Override
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.

Annotations
@Override
buildPropertyCommentsback to summary
protected void buildPropertyComments(Content propertyContent)

Build the comments for the property. Do nothing if BaseOptions#noComment() is set to true.

Parameters
propertyContent:Content

the content to which the documentation will be added

buildPropertyDocback to summary
protected void buildPropertyDoc(Content detailsList)

Build the property documentation.

Parameters
detailsList:Content

the content to which the documentation will be added

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.

Annotations
@Override
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
buildTagInfoback to summary
protected void buildTagInfo(Content propertyContent)

Build the tag information.

Parameters
propertyContent:Content

the content to which the documentation will be added

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
getPropertyDetailsback to summary
protected Content getPropertyDetails(Content memberDetailsHeader, Content memberDetails)
getPropertyDetailsHeaderback to summary
protected Content getPropertyDetailsHeader(Content memberDetails)
getPropertyHeaderContentback to summary
protected Content getPropertyHeaderContent(ExecutableElement property)
getSignatureback to summary
protected Content getSignature(ExecutableElement property)
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