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

public Class ConstructorWriter

extends AbstractExecutableMemberWriter
Class Inheritance
Imports
java.util.Arrays, .List, javax.lang.model.element.Element, .ExecutableElement, .TypeParameterElement, 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, .HtmlStyle, .HtmlTree, .Text
Writes constructor documentation.

Field Summary

Modifier and TypeField and Description
private ExecutableElement
currentConstructor

The current constructor that is being documented at this point in time.

private boolean
hasTypeParamsConstructor

Whether any constructors have type parameters.

private boolean
showConstructorModifiers

If any constructors are non-public, then we want the modifiers shown in the summary.

Constructor Summary

AccessConstructor and Description
public
ConstructorWriter(ClassWriter
the writer for the class to which the constructors belong
writer)

Construct a new member writer for constructors.

public
ConstructorWriter(SubWriterHolderWriter
The writer for the class that the constructors belong to.
writer)

Construct a new ConstructorWriterImpl.

Method Summary

Modifier and TypeMethod and Description
protected void
addComments(ExecutableElement constructor, Content constructorContent)

protected void
addDeprecated(ExecutableElement constructor, Content constructorContent)

protected void
addPreview(ExecutableElement constructor, 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 constructor, Content constructorContent)

private void
analyzeConstructors(List<? extends Element> constructors)

protected void
buildConstructorComments(Content
the content to which the documentation will be added
constructorContent)

Build the comments for the constructor.

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

Build the constructor documentation.

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

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
getConstructorDetails(Content memberDetailsHeader, Content memberDetails)

protected Content
getConstructorDetailsHeader(Content content)

protected Content
getConstructorHeaderContent(ExecutableElement constructor)

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(ExecutableElement constructor)

public TableHeader
getSummaryTableHeader(Element member)

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

Returns the summary table header for the member.

protected void
setShowConstructorModifiers(boolean showConstructorModifiers)

protected boolean
threeColumnSummary()

Inherited from jdk.javadoc.internal.doclets.formats.html.AbstractExecutableMemberWriter:
addInheritedSummaryLinkaddParamaddParametersaddReceiveraddSummaryLinkaddTypeParametersgetExceptionsgetParametersgetSummaryLinkgetTypeParametersimplementsMethodInIntfacisAnnotatedReceiver

Field Detail

currentConstructorback to summary
private ExecutableElement currentConstructor

The current constructor that is being documented at this point in time.

hasTypeParamsConstructorback to summary
private boolean hasTypeParamsConstructor

Whether any constructors have type parameters. This implies we need a three column summary.

showConstructorModifiersback to summary
private boolean showConstructorModifiers

If any constructors are non-public, then we want the modifiers shown in the summary. This implies we need a three-column summary.

Constructor Detail

ConstructorWriterback to summary
public ConstructorWriter(ClassWriter writer)

Construct a new member writer for constructors.

Parameters
writer:ClassWriter

the writer for the class to which the constructors belong

ConstructorWriterback to summary
public ConstructorWriter(SubWriterHolderWriter writer)

Construct a new ConstructorWriterImpl.

Parameters
writer:SubWriterHolderWriter

The writer for the class that the constructors belong to.

Method Detail

addCommentsback to summary
protected void addComments(ExecutableElement constructor, Content constructorContent)
addDeprecatedback to summary
protected void addDeprecated(ExecutableElement constructor, Content constructorContent)
addPreviewback to summary
protected void addPreview(ExecutableElement constructor, 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
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 constructor, Content constructorContent)
analyzeConstructorsback to summary
private void analyzeConstructors(List<? extends Element> constructors)
buildConstructorCommentsback to summary
protected void buildConstructorComments(Content constructorContent)

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

Parameters
constructorContent:Content

the content to which the documentation will be added

buildConstructorDocback to summary
protected void buildConstructorDoc(Content target)

Build the constructor documentation.

Parameters
target: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
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 constructorContent)

Build the tag information.

Parameters
constructorContent: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
getConstructorDetailsback to summary
protected Content getConstructorDetails(Content memberDetailsHeader, Content memberDetails)
getConstructorDetailsHeaderback to summary
protected Content getConstructorDetailsHeader(Content content)
getConstructorHeaderContentback to summary
protected Content getConstructorHeaderContent(ExecutableElement constructor)
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(ExecutableElement constructor)
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
setShowConstructorModifiersback to summary
protected void setShowConstructorModifiers(boolean showConstructorModifiers)
threeColumnSummaryback to summary
protected boolean threeColumnSummary()