Interface ConstantsSummaryWriter

  • All Known Implementing Classes:
    ConstantsSummaryWriterImpl

    @Deprecated
    public interface ConstantsSummaryWriter
    Deprecated.
    The interface for writing constants summary output.

    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
    Author:
    Jamie Ho, Bhavesh Patel (Modified)
    • Method Detail

      • getHeader

        Content getHeader()
        Deprecated.
        Get the header for the constant summary documentation.
        Returns:
        header that needs to be added to the documentation
      • getContentsHeader

        Content getContentsHeader()
        Deprecated.
        Get the header for the constant content list.
        Returns:
        content header that needs to be added to the documentation
      • addLinkToPackageContent

        void addLinkToPackageContent​(PackageDoc pkg,
                                     String parsedPackageName,
                                     Set<String> WriteedPackageHeaders,
                                     Content contentListTree)
        Deprecated.
        Adds the given package name link to the constant content list tree.
        Parameters:
        pkg - the PackageDoc to index.
        parsedPackageName - the parsed package name. We only Write the first 2 directory levels of the package name. For example, java.lang.ref would be indexed as java.lang.*.
        WriteedPackageHeaders - the set of package headers that have already been indexed. We don't want to index something more than once.
        contentListTree - the content tree to which the link will be added
      • addContentsList

        void addContentsList​(Content contentTree,
                             Content contentListTree)
        Deprecated.
        Add the content list to the documentation tree.
        Parameters:
        contentTree - the tree to which the contents list will be added
        contentListTree - the content that will be added to the list
      • getConstantSummaries

        Content getConstantSummaries()
        Deprecated.
        Get the constant summaries for the document.
        Returns:
        constant summaries header to be added to the documentation tree
      • addPackageName

        void addPackageName​(String parsedPackageName,
                            Content summariesTree,
                            boolean first)
        Deprecated.
        Adds the given package name.
        Parameters:
        parsedPackageName - the parsed package name. We only Write the first 2 directory levels of the package name. For example, java.lang.ref would be indexed as java.lang.*.
        summariesTree - the summaries documentation tree
        first - true if the first package is listed be written
      • getClassConstantHeader

        Content getClassConstantHeader()
        Deprecated.
        Get the class summary header for the constants summary.
        Returns:
        the header content for the class constants summary
      • addClassConstant

        void addClassConstant​(Content summariesTree,
                              Content classConstantTree)
        Deprecated.
        Add the content list to the documentation summaries tree.
        Parameters:
        summariesTree - the tree to which the class constants list will be added
        classConstantTree - the class constant tree that will be added to the list
      • addConstantMembers

        void addConstantMembers​(ClassDoc cd,
                                List<FieldDoc> fields,
                                Content classConstantTree)
        Deprecated.
        Adds the constant member table to the documentation tree.
        Parameters:
        cd - the class whose constants are being documented.
        fields - the constants being documented.
        classConstantTree - the documentation tree to which theconstant member table content will be added
      • addConstantSummaries

        void addConstantSummaries​(Content contentTree,
                                  Content summariesTree)
        Deprecated.
        Add the summaries list to the content tree.
        Parameters:
        contentTree - the tree to which the summaries list will be added
        summariesTree - the summaries content tree that will be added to the list
      • addFooter

        void addFooter​(Content contentTree)
        Deprecated.
        Adds the footer for the summary documentation.
        Parameters:
        contentTree - content tree to which the footer will be added
      • printDocument

        void printDocument​(Content contentTree)
                    throws IOException
        Deprecated.
        Print the constants summary document.
        Parameters:
        contentTree - content tree which should be printed
        Throws:
        IOException