Class ConstantsSummaryBuilder
java.lang.Object
gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.AbstractBuilder
gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.ConstantsSummaryBuilder
Deprecated.
Builds the Constants Summary Page.
This is NOT part of any supported API. If you write code that depends on this, you do so at your own risk. This code and its internal interfaces are subject to change or deletion without notice.
- Since:
- 1.5
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate class
Deprecated.Print the table of constants.Nested classes/interfaces inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.AbstractBuilder
AbstractBuilder.Context
-
Field Summary
FieldsModifier and TypeFieldDescriptionDeprecated.The set of ClassDocs that have constant fields.private Content
Deprecated.The content tree for the constant summary documentation.private ClassDoc
Deprecated.The current class being documented.private PackageDoc
Deprecated.The current package being documented.private boolean
Deprecated.True if first package is listed.static final int
Deprecated.The maximum number of package directories shown in the constant value index.Deprecated.The set of printed package headers.static final String
Deprecated.The root element of the constant summary XML is "ConstantSummary".protected final ConstantsSummaryWriter
Deprecated.The writer used to write the results.Fields inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.AbstractBuilder
configuration, containingPackagesSeen, DEBUG, layoutParser, utils
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
ConstantsSummaryBuilder
(AbstractBuilder.Context context, ConstantsSummaryWriter writer) Deprecated.Construct a new ConstantsSummaryBuilder. -
Method Summary
Modifier and TypeMethodDescriptionvoid
build()
Deprecated.Build the documentation.void
buildClassConstantSummary
(XMLNode node, Content summariesTree) Deprecated.Build the summary for the current class.void
buildConstantMembers
(XMLNode node, Content classConstantTree) Deprecated.Build the summary of constant members in the class.void
buildConstantSummaries
(XMLNode node, Content contentTree) Deprecated.Build the summary for each documented package.void
buildConstantSummary
(XMLNode node, Content contentTree) Deprecated.Build the constant summary.void
buildContents
(XMLNode node, Content contentTree) Deprecated.Build the list of packages.void
buildPackageHeader
(XMLNode node, Content summariesTree) Deprecated.Build the header for the given package.static ConstantsSummaryBuilder
getInstance
(AbstractBuilder.Context context, ConstantsSummaryWriter writer) Deprecated.Construct a ConstantsSummaryBuilder.getName()
Deprecated.Return the name of this builder.private boolean
hasConstantField
(ClassDoc classDoc) Deprecated.Return true if the given class has constant fields to document.private boolean
Deprecated.Return true if the given package has constant fields to document.private boolean
hasPrintedPackageIndex
(String pkgname) Deprecated.Return true if the given package name has been printed.private String
parsePackageName
(String pkgname) Deprecated.Parse the package name.Methods inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.AbstractBuilder
build, buildChildren, invokeMethod
-
Field Details
-
ROOT
Deprecated.The root element of the constant summary XML is "ConstantSummary".- See Also:
-
MAX_CONSTANT_VALUE_INDEX_LENGTH
public static final int MAX_CONSTANT_VALUE_INDEX_LENGTHDeprecated.The maximum number of package directories shown in the constant value index.- See Also:
-
writer
Deprecated.The writer used to write the results. -
classDocsWithConstFields
Deprecated.The set of ClassDocs that have constant fields. -
printedPackageHeaders
Deprecated.The set of printed package headers. -
currentPackage
Deprecated.The current package being documented. -
currentClass
Deprecated.The current class being documented. -
contentTree
Deprecated.The content tree for the constant summary documentation. -
first
private boolean firstDeprecated.True if first package is listed.
-
-
Constructor Details
-
ConstantsSummaryBuilder
Deprecated.Construct a new ConstantsSummaryBuilder.- Parameters:
context
- the build context.writer
- the writer for the summary.
-
-
Method Details
-
getInstance
public static ConstantsSummaryBuilder getInstance(AbstractBuilder.Context context, ConstantsSummaryWriter writer) Deprecated.Construct a ConstantsSummaryBuilder.- Parameters:
context
- the build context.writer
- the writer for the summary.
-
build
Deprecated.Build the documentation.- Specified by:
build
in classAbstractBuilder
- Throws:
IOException
- if there is a problem writing the output
-
getName
Deprecated.Return the name of this builder.- Specified by:
getName
in classAbstractBuilder
- Returns:
- the name of the builder.
-
buildConstantSummary
Deprecated.Build the constant summary.- Parameters:
node
- the XML element that specifies which components to documentcontentTree
- the content tree to which the documentation will be added- Throws:
Exception
-
buildContents
Deprecated.Build the list of packages.- Parameters:
node
- the XML element that specifies which components to documentcontentTree
- the content tree to which the content list will be added
-
buildConstantSummaries
Deprecated.Build the summary for each documented package.- Parameters:
node
- the XML element that specifies which components to documentcontentTree
- the tree to which the summaries will be added
-
buildPackageHeader
Deprecated.Build the header for the given package.- Parameters:
node
- the XML element that specifies which components to documentsummariesTree
- the tree to which the package header will be added
-
buildClassConstantSummary
Deprecated.Build the summary for the current class.- Parameters:
node
- the XML element that specifies which components to documentsummariesTree
- the tree to which the class constant summary will be added
-
buildConstantMembers
Deprecated.Build the summary of constant members in the class.- Parameters:
node
- the XML element that specifies which components to documentclassConstantTree
- the tree to which the constant members table will be added
-
hasConstantField
Deprecated.Return true if the given package has constant fields to document.- Parameters:
pkg
- the package being checked.- Returns:
- true if the given package has constant fields to document.
-
hasConstantField
Deprecated.Return true if the given class has constant fields to document.- Parameters:
classDoc
- the class being checked.- Returns:
- true if the given package has constant fields to document.
-
hasPrintedPackageIndex
Deprecated.Return true if the given package name has been printed. Also return true if the root of this package has been printed.- Parameters:
pkgname
- the name of the package to check.
-
parsePackageName
Deprecated.Parse the package name. We only want to display package name up to 2 levels.
-