Package gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders

Class PackageSummaryBuilder

  • @Deprecated
public class PackageSummaryBuilder
extends AbstractBuilder
    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

    • Field Detail

      • ROOT

        public static final java.lang.String ROOT
        Deprecated.
        The root element of the package summary XML is "PackageDoc".
        See Also:
        Constant Field Values

      • packageDoc

        private final PackageDoc packageDoc
        Deprecated.
        The package being documented.

      • packageWriter

        private final PackageSummaryWriter packageWriter
        Deprecated.
        The doclet specific writer that will output the result.

      • contentTree

        private Content contentTree
        Deprecated.
        The content that will be added to the package summary documentation tree.

    • Constructor Detail

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

      • 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

        public void build()
           throws java.io.IOException
        Deprecated.
        Build the package summary.
        Specified by:
        build in class AbstractBuilder
        Throws:
        java.io.IOException - if there is a problem writing the output

      • getName

        public java.lang.String getName()
        Deprecated.
        Return the name of this builder.
        Specified by:
        getName in class AbstractBuilder
        Returns:
        the name of the builder.

      • buildPackageDoc

        public void buildPackageDoc​(XMLNode node,
                            Content contentTree)
                     throws java.lang.Exception
        Deprecated.
        Build the package documentation.
        Parameters:
        node - the XML element that specifies which components to document
        contentTree - the content tree to which the documentation will be added
        Throws:
        java.lang.Exception

      • buildContent

        public void buildContent​(XMLNode node,
                         Content contentTree)
        Deprecated.
        Build the content for the package doc.
        Parameters:
        node - the XML element that specifies which components to document
        contentTree - the content tree to which the package contents will be added

      • buildSummary

        public void buildSummary​(XMLNode node,
                         Content packageContentTree)
        Deprecated.
        Build the package summary.
        Parameters:
        node - the XML element that specifies which components to document
        packageContentTree - the package content tree to which the summaries will be added

      • buildInterfaceSummary

        public void buildInterfaceSummary​(XMLNode node,
                                  Content summaryContentTree)
        Deprecated.
        Build the summary for the interfaces in this package.
        Parameters:
        node - the XML element that specifies which components to document
        summaryContentTree - the summary tree to which the interface summary will be added

      • buildClassSummary

        public void buildClassSummary​(XMLNode node,
                              Content summaryContentTree)
        Deprecated.
        Build the summary for the classes in this package.
        Parameters:
        node - the XML element that specifies which components to document
        summaryContentTree - the summary tree to which the class summary will be added

      • buildEnumSummary

        public void buildEnumSummary​(XMLNode node,
                             Content summaryContentTree)
        Deprecated.
        Build the summary for the enums in this package.
        Parameters:
        node - the XML element that specifies which components to document
        summaryContentTree - the summary tree to which the enum summary will be added

      • buildExceptionSummary

        public void buildExceptionSummary​(XMLNode node,
                                  Content summaryContentTree)
        Deprecated.
        Build the summary for the exceptions in this package.
        Parameters:
        node - the XML element that specifies which components to document
        summaryContentTree - the summary tree to which the exception summary will be added

      • buildErrorSummary

        public void buildErrorSummary​(XMLNode node,
                              Content summaryContentTree)
        Deprecated.
        Build the summary for the errors in this package.
        Parameters:
        node - the XML element that specifies which components to document
        summaryContentTree - the summary tree to which the error summary will be added

      • buildAnnotationTypeSummary

        public void buildAnnotationTypeSummary​(XMLNode node,
                                       Content summaryContentTree)
        Deprecated.
        Build the summary for the annotation type in this package.
        Parameters:
        node - the XML element that specifies which components to document
        summaryContentTree - the summary tree to which the annotation type summary will be added

      • buildPackageDescription

        public void buildPackageDescription​(XMLNode node,
                                    Content packageContentTree)
        Deprecated.
        Build the description of the summary.
        Parameters:
        node - the XML element that specifies which components to document
        packageContentTree - the tree to which the package description will be added

      • buildPackageTags

        public void buildPackageTags​(XMLNode node,
                             Content packageContentTree)
        Deprecated.
        Build the tags of the summary.
        Parameters:
        node - the XML element that specifies which components to document
        packageContentTree - the tree to which the package tags will be added