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

public Class AnnotationTypeMemberWriter

extends AbstractMemberWriter
Class Inheritance
Imports
javax.lang.model.SourceVersion, javax.lang.model.element.AnnotationValue, .Element, .ExecutableElement, .TypeElement, javax.lang.model.type.TypeMirror, 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.Comment, .Content, .ContentBuilder, .HtmlTree, .Text
Writes annotation interface member documentation in HTML format.

Field Summary

Modifier and TypeField and Description
protected Element
currentMember

The index of the current member 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
AnnotationTypeMemberWriter(ClassWriter
the writer that will write the output.
writer, VisibleMemberTable.Kind
the kind of annotation interface members to handle.
kind)

Constructs a new AnnotationTypeMemberWriterImpl for a specific kind of member.

Method Summary

Modifier and TypeMethod and Description
protected void
addAnnotationDetailsMarker(Content memberDetails)

protected void
addComments(Element member, Content annotationContent)

protected void
addDefaultValueInfo(Element member, Content annotationContent)

protected void
addDeprecated(Element member, Content target)

protected void
addPreview(Element member, 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(Element member, Content annotationContent)

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

Build the member documentation.

protected void
buildAnnotationTypeMemberChildren(Content annotationContent)

protected void
buildDefaultValueInfo(Content
the content to which the documentation will be added
annotationContent)

Build the default value for this optional 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
buildMemberComments(Content
the content to which the documentation will be added
annotationContent)

Build the comments for the member.

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

Build the tag information.

protected Table<Element>
createSummaryTable()

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

Creates the summary table for this element.

protected Content
getAnnotationDetails(Content annotationDetailsHeader, Content annotationDetails)

protected Content
getAnnotationDetailsHeader()

protected Content
getAnnotationHeaderContent(Element member)

protected Content

Returns:

the caption
getCaption()

Get the caption for the summary table.

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(Element member)

public TableHeader
getSummaryTableHeader(Element member)

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

Returns the summary table header for the member.

private TypeMirror
getType(Element member)

protected Comment
selectComment(Comment c1, Comment c2)

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

Field Detail

currentMemberback to summary
protected Element currentMember

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

Constructor Detail

AnnotationTypeMemberWriterback to summary
public AnnotationTypeMemberWriter(ClassWriter writer, VisibleMemberTable.Kind kind)

Constructs a new AnnotationTypeMemberWriterImpl for a specific kind of member. We generate separate summaries for required and optional annotation interface members, so we need dedicated writer instances for each kind. For the details section, a single shared list is generated

Parameters
writer:ClassWriter

the writer that will write the output.

kind:VisibleMemberTable.Kind

the kind of annotation interface members to handle.

Method Detail

addAnnotationDetailsMarkerback to summary
protected void addAnnotationDetailsMarker(Content memberDetails)
addCommentsback to summary
protected void addComments(Element member, Content annotationContent)
addDefaultValueInfoback to summary
protected void addDefaultValueInfo(Element member, Content annotationContent)
addDeprecatedback to summary
protected void addDeprecated(Element member, Content target)
addPreviewback to summary
protected void addPreview(Element member, 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(Element member, Content annotationContent)
buildAnnotationTypeMemberback to summary
protected void buildAnnotationTypeMember(Content target)

Build the member documentation.

Parameters
target:Content

the content to which the documentation will be added

buildAnnotationTypeMemberChildrenback to summary
protected void buildAnnotationTypeMemberChildren(Content annotationContent)
buildDefaultValueInfoback to summary
protected void buildDefaultValueInfo(Content annotationContent)

Build the default value for this optional member.

Parameters
annotationContent:Content

the content to which the documentation will be added

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
buildMemberCommentsback to summary
protected void buildMemberComments(Content annotationContent)

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

Parameters
annotationContent: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 annotationContent)

Build the tag information.

Parameters
annotationContent:Content

the content to which the documentation will be added

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
getAnnotationDetailsback to summary
protected Content getAnnotationDetails(Content annotationDetailsHeader, Content annotationDetails)
getAnnotationDetailsHeaderback to summary
protected Content getAnnotationDetailsHeader()
getAnnotationHeaderContentback to summary
protected Content getAnnotationHeaderContent(Element member)
getCaptionback to summary
protected Content getCaption()

Get the caption for the summary table.

Returns:Content

the caption

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(Element member)
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
getTypeback to summary
private TypeMirror getType(Element member)
selectCommentback to summary
protected Comment selectComment(Comment c1, Comment c2)