Class PackageSummaryBuilder
java.lang.Object
gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.AbstractBuilder
gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.PackageSummaryBuilder
Deprecated.
Builds the summary for a given package.
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 classes/interfaces inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.AbstractBuilder
AbstractBuilder.Context
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate Content
Deprecated.The content that will be added to the package summary documentation tree.private final PackageDoc
Deprecated.The package being documented.private final PackageSummaryWriter
Deprecated.The doclet specific writer that will output the result.static final String
Deprecated.The root element of the package summary XML is "PackageDoc".Fields inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.AbstractBuilder
configuration, containingPackagesSeen, DEBUG, layoutParser, utils
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
PackageSummaryBuilder
(AbstractBuilder.Context context, PackageDoc pkg, PackageSummaryWriter packageWriter) Deprecated.Construct a new PackageSummaryBuilder. -
Method Summary
Modifier and TypeMethodDescriptionvoid
build()
Deprecated.Build the package summary.void
buildAnnotationTypeSummary
(XMLNode node, Content summaryContentTree) Deprecated.Build the summary for the annotation type in this package.void
buildClassSummary
(XMLNode node, Content summaryContentTree) Deprecated.Build the summary for the classes in this package.void
buildContent
(XMLNode node, Content contentTree) Deprecated.Build the content for the package doc.void
buildEnumSummary
(XMLNode node, Content summaryContentTree) Deprecated.Build the summary for the enums in this package.void
buildErrorSummary
(XMLNode node, Content summaryContentTree) Deprecated.Build the summary for the errors in this package.void
buildExceptionSummary
(XMLNode node, Content summaryContentTree) Deprecated.Build the summary for the exceptions in this package.void
buildInterfaceSummary
(XMLNode node, Content summaryContentTree) Deprecated.Build the summary for the interfaces in this package.void
buildPackageDescription
(XMLNode node, Content packageContentTree) Deprecated.Build the description of the summary.void
buildPackageDoc
(XMLNode node, Content contentTree) Deprecated.Build the package documentation.void
buildPackageTags
(XMLNode node, Content packageContentTree) Deprecated.Build the tags of the summary.void
buildSummary
(XMLNode node, Content packageContentTree) Deprecated.Build the package summary.static PackageSummaryBuilder
getInstance
(AbstractBuilder.Context context, PackageDoc pkg, PackageSummaryWriter packageWriter) Deprecated.Construct a new PackageSummaryBuilder.getName()
Deprecated.Return the name of this builder.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 package summary XML is "PackageDoc".- See Also:
-
packageDoc
Deprecated.The package being documented. -
packageWriter
Deprecated.The doclet specific writer that will output the result. -
contentTree
Deprecated.The content that will be added to the package summary documentation tree.
-
-
Constructor Details
-
PackageSummaryBuilder
private PackageSummaryBuilder(AbstractBuilder.Context context, PackageDoc pkg, PackageSummaryWriter packageWriter) Deprecated.Construct a new PackageSummaryBuilder.- Parameters:
context
- the build context.pkg
- the package being documented.packageWriter
- the doclet specific writer that will output the result.
-
-
Method Details
-
getInstance
public static PackageSummaryBuilder getInstance(AbstractBuilder.Context context, PackageDoc pkg, PackageSummaryWriter packageWriter) Deprecated.Construct a new PackageSummaryBuilder.- Parameters:
context
- the build context.pkg
- the package being documented.packageWriter
- the doclet specific writer that will output the result.- Returns:
- an instance of a PackageSummaryBuilder.
-
build
Deprecated.Build the package summary.- 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.
-
buildPackageDoc
Deprecated.Build the package documentation.- Parameters:
node
- the XML element that specifies which components to documentcontentTree
- the content tree to which the documentation will be added- Throws:
Exception
-
buildContent
Deprecated.Build the content for the package doc.- Parameters:
node
- the XML element that specifies which components to documentcontentTree
- the content tree to which the package contents will be added
-
buildSummary
Deprecated.Build the package summary.- Parameters:
node
- the XML element that specifies which components to documentpackageContentTree
- the package content tree to which the summaries will be added
-
buildInterfaceSummary
Deprecated.Build the summary for the interfaces in this package.- Parameters:
node
- the XML element that specifies which components to documentsummaryContentTree
- the summary tree to which the interface summary will be added
-
buildClassSummary
Deprecated.Build the summary for the classes in this package.- Parameters:
node
- the XML element that specifies which components to documentsummaryContentTree
- the summary tree to which the class summary will be added
-
buildEnumSummary
Deprecated.Build the summary for the enums in this package.- Parameters:
node
- the XML element that specifies which components to documentsummaryContentTree
- the summary tree to which the enum summary will be added
-
buildExceptionSummary
Deprecated.Build the summary for the exceptions in this package.- Parameters:
node
- the XML element that specifies which components to documentsummaryContentTree
- the summary tree to which the exception summary will be added
-
buildErrorSummary
Deprecated.Build the summary for the errors in this package.- Parameters:
node
- the XML element that specifies which components to documentsummaryContentTree
- the summary tree to which the error summary will be added
-
buildAnnotationTypeSummary
Deprecated.Build the summary for the annotation type in this package.- Parameters:
node
- the XML element that specifies which components to documentsummaryContentTree
- the summary tree to which the annotation type summary will be added
-
buildPackageDescription
Deprecated.Build the description of the summary.- Parameters:
node
- the XML element that specifies which components to documentpackageContentTree
- the tree to which the package description will be added
-
buildPackageTags
Deprecated.Build the tags of the summary.- Parameters:
node
- the XML element that specifies which components to documentpackageContentTree
- the tree to which the package tags will be added
-