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

public Class FieldWriter

extends AbstractMemberWriter
Class Inheritance
Known Direct Subclasses
jdk.javadoc.internal.doclets.formats.html.SerialFieldWriter
Imports
javax.lang.model.element.Element, .TypeElement, .VariableElement, jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyles, jdk.javadoc.internal.doclets.toolkit.BaseOptions, jdk.javadoc.internal.doclets.toolkit.util.VisibleMemberTable, jdk.javadoc.internal.html.Content, .ContentBuilder, .Entity, .HtmlId, .HtmlTree, .Text
Writes field documentation in HTML format.

Field Summary

Modifier and TypeField and Description
private VariableElement
currentElement

The index of the current field 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
FieldWriter(ClassWriter writer)

public
FieldWriter(SubWriterHolderWriter writer, TypeElement typeElement)

public
FieldWriter(SubWriterHolderWriter writer)

Method Summary

Modifier and TypeMethod and Description
protected void
addComments(VariableElement field, Content fieldContent)

protected void
addDeprecated(VariableElement field, Content fieldContent)

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(VariableElement field, 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(VariableElement field, Content fieldContent)

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

Build the comments for the field.

protected void
buildFieldDoc(Content
the content to which the documentation will be added
target)

Build the field documentation.

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

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 Content
getFieldDetails(Content memberDetailsHeaderContent, Content memberContent)

protected Content
getFieldDetailsHeader(Content content)

protected Content
getFieldHeaderContent(VariableElement field)

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
getSignature(VariableElement field)

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

currentElementback to summary
private VariableElement currentElement

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

Constructor Detail

FieldWriterback to summary
public FieldWriter(ClassWriter writer)
FieldWriterback to summary
public FieldWriter(SubWriterHolderWriter writer, TypeElement typeElement)
FieldWriterback to summary
public FieldWriter(SubWriterHolderWriter writer)

Method Detail

addCommentsback to summary
protected void addComments(VariableElement field, Content fieldContent)
addDeprecatedback to summary
protected void addDeprecated(VariableElement field, Content fieldContent)
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(VariableElement field, 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(VariableElement field, Content fieldContent)
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
buildFieldCommentsback to summary
protected void buildFieldComments(Content fieldContent)

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

Parameters
fieldContent:Content

the content to which the documentation will be added

buildFieldDocback to summary
protected void buildFieldDoc(Content target)

Build the field documentation.

Parameters
target:Content

the content to which the documentation will be added

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
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 fieldContent)

Build the tag information.

Parameters
fieldContent: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
getFieldDetailsback to summary
protected Content getFieldDetails(Content memberDetailsHeaderContent, Content memberContent)
getFieldDetailsHeaderback to summary
protected Content getFieldDetailsHeader(Content content)
getFieldHeaderContentback to summary
protected Content getFieldHeaderContent(VariableElement field)
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
getSignatureback to summary
protected Content getSignature(VariableElement field)
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