Modifier and Type	Class and Description
private class	ConstantsSummaryWriter.ConstantFieldBuilder Builder for the table of fields with constant values.

Field Summary

Modifier and Type	Field and Description
private final BodyContents	bodyContents
private final TableHeader	constantsTableHeader
private TypeElement	currentClass
private PackageElement	currentPackage
private TypeElement	currentTypeElement The current class being documented.
private boolean	hasConstants
private static final int	MAX_CONSTANT_VALUE_INDEX_LENGTH The maximum number of package directories shown in the headings of the constant values contents list and headings.
protected final Set<String>	packageGroupHeadings The set of package-group headings.
private HtmlTree	summarySection The HTML tree for constant values summary currently being written.
protected final Set<TypeElement>	typeElementsWithConstFields The set of type elements that have constant fields.

Inherited from jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter:: comparators configuration contents docPaths htmlIds indexAnchorTable links mainBodyScript messages options path pathToRoot resources tableOfContents utils winTitle

Constructor Summary

Access	Constructor and Description
public	ConstantsSummaryWriter(HtmlConfiguration the configuration used in this run of the standard doclet. configuration) Construct a ConstantsSummaryWriter.

Method Summary

Modifier and Type	Method and Description
pack-priv void	addClassConstant(Content fromClassConstant)
pack-priv void	addConstantMembers(TypeElement typeElement, Collection<VariableElement> fields, Content target)
pack-priv void	addConstantSummaries(Content content)
pack-priv void	addFooter()
pack-priv void	addLinkToTableOfContents(String abbrevPackageName)
pack-priv void	addPackageGroup(String abbrevPackageName, Content toContent)
protected void	buildClassConstantSummary() Builds the summary for the current class.
protected void	buildConstantMembers(Content the content to which the table of constant members will be added target) Builds the summary of constant members in the class.
protected void	buildConstantSummaries() Builds the summary for each documented package.
protected void	buildConstantSummary() Builds the constant summary page.
protected void	buildContents() Builds the list of contents for the groups of packages appearing in the constants summary page.
protected void	buildPackageHeader(Content the content to which the package header will be added target) Builds the header for the given package.
public void	buildPage() Implements abstract jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter.buildPage. The top-level method to generate and write the page represented by this writer.
public String	Returns: the abbreviated name for a package, containing the leading segments of the name getAbbrevPackageName(PackageElement the package pkg) Returns the abbreviated name for a package, containing the leading segments of the name.
pack-priv Content	getClassConstantHeader()
pack-priv Content	getContentsHeader()
pack-priv Content	getHeader()
private Content	Returns: the name column of the constant table row getNameColumn(VariableElement the field to be documented. member) Get the name column for the constant summary table row.
private Content	Returns: the type column of the constant table row getTypeColumn(VariableElement the field to be documented. member) Get the type column for the constant summary table row.
private Content	Returns: the value column of the constant table row getValue(VariableElement the field to be documented. member) Get the value column for the constant summary table row.
private boolean	Returns: true if the given package has constant fields to document hasConstantField(PackageElement the package to be checked pkg) Returns true if the given package has constant fields to document.
private boolean	Returns: true if the given class has constant fields to document hasConstantField(TypeElement the class to be checked typeElement) Returns true if the given class has constant fields to document.
pack-priv void	printDocument(Content content)

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

Field Detail

bodyContents	back to summary
private final BodyContents bodyContents

constantsTableHeader	back to summary
private final TableHeader constantsTableHeader

currentClass	back to summary
private TypeElement currentClass

currentPackage	back to summary
private PackageElement currentPackage

currentTypeElement	back to summary
private TypeElement currentTypeElement The current class being documented.

hasConstants	back to summary
private boolean hasConstants

MAX_CONSTANT_VALUE_INDEX_LENGTH	back to summary
private static final int MAX_CONSTANT_VALUE_INDEX_LENGTH The maximum number of package directories shown in the headings of the constant values contents list and headings.

packageGroupHeadings	back to summary
protected final Set<String> packageGroupHeadings The set of package-group headings.

summarySection	back to summary
private HtmlTree summarySection The HTML tree for constant values summary currently being written.

typeElementsWithConstFields	back to summary
protected final Set<TypeElement> typeElementsWithConstFields The set of type elements that have constant fields.

Constructor Detail

ConstantsSummaryWriter	back to summary
public ConstantsSummaryWriter(HtmlConfiguration configuration) Construct a ConstantsSummaryWriter. Parameters configuration:HtmlConfiguration the configuration used in this run of the standard doclet.

ConstantsSummaryWriter

back to summary

public ConstantsSummaryWriter(HtmlConfiguration configuration)

Construct a ConstantsSummaryWriter.

Parameters

configuration:HtmlConfiguration: the configuration used in this run of the standard doclet.

Method Detail

addClassConstant	back to summary
pack-priv void addClassConstant(Content fromClassConstant)

addConstantMembers	back to summary
pack-priv void addConstantMembers(TypeElement typeElement, Collection<VariableElement> fields, Content target)

addConstantSummaries	back to summary
pack-priv void addConstantSummaries(Content content)

addFooter	back to summary
pack-priv void addFooter()

addLinkToTableOfContents	back to summary
pack-priv void addLinkToTableOfContents(String abbrevPackageName)

addPackageGroup	back to summary
pack-priv void addPackageGroup(String abbrevPackageName, Content toContent)

buildClassConstantSummary	back to summary
protected void buildClassConstantSummary() Builds the summary for the current class.

buildConstantMembers	back to summary
protected void buildConstantMembers(Content target) Builds the summary of constant members in the class. Parameters target:Content the content to which the table of constant members will be added

buildConstantMembers

back to summary

protected void buildConstantMembers(Content target)

Builds the summary of constant members in the class.

Parameters

target:Content: the content to which the table of constant members will be added

buildConstantSummaries	back to summary
protected void buildConstantSummaries() Builds the summary for each documented package.

buildConstantSummary	back to summary
protected void buildConstantSummary() throws DocletException Builds the constant summary page. Exceptions DocletException: if there is a problem while building the documentation

buildConstantSummary

back to summary

protected void buildConstantSummary() throws DocletException

Builds the constant summary page.

Exceptions

DocletException:: if there is a problem while building the documentation

buildContents	back to summary
protected void buildContents() Builds the list of contents for the groups of packages appearing in the constants summary page.

buildPackageHeader	back to summary
protected void buildPackageHeader(Content target) Builds the header for the given package. Parameters target:Content the content to which the package header will be added

buildPackageHeader

back to summary

protected void buildPackageHeader(Content target)

Builds the header for the given package.

Parameters

target:Content: the content to which the package header will be added

buildPage	back to summary
public void buildPage() throws DocletException Implements abstract jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter.buildPage. Doc from jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter.buildPage. The top-level method to generate and write the page represented by this writer. Annotations @Override Exceptions DocletException: if a problem occurs while building or writing the page

buildPage

back to summary

public void buildPage() throws DocletException

Implements abstract jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter.buildPage.

Doc from jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter.buildPage.

The top-level method to generate and write the page represented by this writer.

Annotations

@Override

Exceptions

DocletException:: if a problem occurs while building or writing the page

getAbbrevPackageName	back to summary
public String getAbbrevPackageName(PackageElement pkg) Returns the abbreviated name for a package, containing the leading segments of the name. Parameters pkg:PackageElement the package Returns:String the abbreviated name for a package, containing the leading segments of the name

getAbbrevPackageName

back to summary

public String getAbbrevPackageName(PackageElement pkg)

Returns the abbreviated name for a package, containing the leading segments of the name.

Parameters

pkg:PackageElement: the package

Returns:String

the abbreviated name for a package, containing the leading segments of the name

getClassConstantHeader	back to summary
pack-priv Content getClassConstantHeader()

getContentsHeader	back to summary
pack-priv Content getContentsHeader()

getHeader	back to summary
pack-priv Content getHeader()

getNameColumn	back to summary
private Content getNameColumn(VariableElement member) Get the name column for the constant summary table row. Parameters member:VariableElement the field to be documented. Returns:Content the name column of the constant table row

getNameColumn

back to summary

private Content getNameColumn(VariableElement member)

Get the name column for the constant summary table row.

Parameters

member:VariableElement: the field to be documented.

Returns:Content

the name column of the constant table row

getTypeColumn	back to summary
private Content getTypeColumn(VariableElement member) Get the type column for the constant summary table row. Parameters member:VariableElement the field to be documented. Returns:Content the type column of the constant table row

getTypeColumn

back to summary

private Content getTypeColumn(VariableElement member)

Get the type column for the constant summary table row.

Parameters

member:VariableElement: the field to be documented.

Returns:Content

the type column of the constant table row

getValue	back to summary
private Content getValue(VariableElement member) Get the value column for the constant summary table row. Parameters member:VariableElement the field to be documented. Returns:Content the value column of the constant table row

getValue

back to summary

private Content getValue(VariableElement member)

Get the value column for the constant summary table row.

Parameters

member:VariableElement: the field to be documented.

Returns:Content

the value column of the constant table row

hasConstantField	back to summary
private boolean hasConstantField(PackageElement pkg) Returns true if the given package has constant fields to document. Parameters pkg:PackageElement the package to be checked Returns:boolean true if the given package has constant fields to document

hasConstantField

back to summary

private boolean hasConstantField(PackageElement pkg)

Returns true if the given package has constant fields to document.

Parameters

pkg:PackageElement: the package to be checked

Returns:boolean

true if the given package has constant fields to document

hasConstantField	back to summary
private boolean hasConstantField(TypeElement typeElement) Returns true if the given class has constant fields to document. Parameters typeElement:TypeElement the class to be checked Returns:boolean true if the given class has constant fields to document

hasConstantField

back to summary

private boolean hasConstantField(TypeElement typeElement)

Returns true if the given class has constant fields to document.

Parameters

typeElement:TypeElement: the class to be checked

Returns:boolean

true if the given class has constant fields to document

printDocument	back to summary
pack-priv void printDocument(Content content) throws DocFileIOException

jdk.javadoc.internal.doclets.formats.html back to summary

private Class ConstantsSummaryWriter.ConstantFieldBuilder

Class Inheritance

extends Object

java.lang.Object
jdk.javadoc.internal.doclets.formats.html.ConstantsSummaryWriter.ConstantFieldBuilder

Builder for the table of fields with constant values.

Field Summary

Modifier and Type	Field and Description
protected TypeElement	typeElement The type element that we are examining constants for.

Constructor Summary

Access	Constructor and Description
public	ConstantFieldBuilder(TypeElement the type element that we are examining constants for typeElement) Constructs a `ConstantFieldBuilder`.

Method Summary

Modifier and Type	Method and Description
protected void	buildMembersSummary(Content the content to which the table of class constants will be added target) Builds the table of constants for a given class.
protected SortedSet<VariableElement>	Returns: a set of visible constant fields for the given type members() Returns a set of visible constant fields for the given type.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

typeElement	back to summary
protected TypeElement typeElement The type element that we are examining constants for.

Constructor Detail

ConstantFieldBuilder back to summary

ConstantFieldBuilder	back to summary
public ConstantFieldBuilder(TypeElement typeElement) Constructs a `ConstantFieldBuilder`. Parameters typeElement:TypeElement the type element that we are examining constants for

public ConstantFieldBuilder(TypeElement typeElement)

Constructs a ConstantFieldBuilder.

Parameters

typeElement:TypeElement: the type element that we are examining constants for

Method Detail

buildMembersSummary	back to summary
protected void buildMembersSummary(Content target) Builds the table of constants for a given class. Parameters target:Content the content to which the table of class constants will be added

buildMembersSummary

back to summary

protected void buildMembersSummary(Content target)

Builds the table of constants for a given class.

Parameters

target:Content: the content to which the table of class constants will be added

members	back to summary
protected SortedSet<VariableElement> members() Returns a set of visible constant fields for the given type. Returns:SortedSet<VariableElement> a set of visible constant fields for the given type

members

back to summary

protected SortedSet<VariableElement> members()

Returns a set of visible constant fields for the given type.

Returns:SortedSet<VariableElement>: a set of visible constant fields for the given type

public Class ConstantsSummaryWriter

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class ConstantsSummaryWriter.ConstantFieldBuilder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail