Package gw.gosudoc.com.sun.tools.doclets.formats.html

Class SerializedFormWriterImpl

  • All Implemented Interfaces:
    SerializedFormWriter
    @Deprecated
public class SerializedFormWriterImpl
extends SubWriterHolderWriter
implements SerializedFormWriter
    Deprecated.
    Generate the Serialized Form Information 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.

    • Field Detail

      • visibleClasses

        java.util.List<ClassDoc> visibleClasses
        Deprecated.

      • mainTree

        private HtmlTree mainTree
        Deprecated.
        HTML tree for main tag.

    • Constructor Detail

      • SerializedFormWriterImpl

        public SerializedFormWriterImpl​(ConfigurationImpl configuration)
                         throws java.io.IOException
        Deprecated.
        Parameters:
        configuration - the configuration data for the doclet
        Throws:
        java.io.IOException
        DocletAbortException

    • Method Detail

      • getHeader

        public Content getHeader​(java.lang.String header)
        Deprecated.
        Get the given header.
        Specified by:
        getHeader in interface SerializedFormWriter
        Parameters:
        header - the header to write
        Returns:
        the body content tree

      • getPackageHeader

        public Content getPackageHeader​(java.lang.String packageName)
        Deprecated.
        Get the given package header.
        Specified by:
        getPackageHeader in interface SerializedFormWriter
        Parameters:
        packageName - the package header to write
        Returns:
        a content tree for the package header

      • isVisibleClass

        public boolean isVisibleClass​(ClassDoc classDoc)
        Deprecated.
        Checks if a class is generated and is visible.
        Parameters:
        classDoc - the class being processed.
        Returns:
        true if the class, that is being processed, is generated and is visible.

      • getClassHeader

        public Content getClassHeader​(ClassDoc classDoc)
        Deprecated.
        Get the serializable class heading.
        Specified by:
        getClassHeader in interface SerializedFormWriter
        Parameters:
        classDoc - the class being processed
        Returns:
        a content tree for the class header

      • addSerialUIDInfo

        public void addSerialUIDInfo​(java.lang.String header,
                             java.lang.String serialUID,
                             Content serialUidTree)
        Deprecated.
        Adds the serial UID info.
        Specified by:
        addSerialUIDInfo in interface SerializedFormWriter
        Parameters:
        header - the header that will show up before the UID.
        serialUID - the serial UID to print.
        serialUidTree - the serial UID content tree to which the serial UID content will be added

      • getClassContentHeader

        public Content getClassContentHeader()
        Deprecated.
        Get the class serialize content header.
        Specified by:
        getClassContentHeader in interface SerializedFormWriter
        Returns:
        a content tree for the class serialize content header

      • getSerializedContent

        public Content getSerializedContent​(Content serializedTreeContent)
        Deprecated.
        Get the serialized content tree section.
        Specified by:
        getSerializedContent in interface SerializedFormWriter
        Parameters:
        serializedTreeContent - the serialized content tree to be added
        Returns:
        a div content tree

      • addPackageSerializedTree

        public void addPackageSerializedTree​(Content serializedSummariesTree,
                                     Content packageSerializedTree)
        Deprecated.
        Add the serialized tree per package to the serialized summaries tree.
        Specified by:
        addPackageSerializedTree in interface SerializedFormWriter
        Parameters:
        serializedSummariesTree - the serialized tree to which the package serialized tree will be added
        packageSerializedTree - the serialized tree per package that needs to be added

      • addFooter

        public void addFooter​(Content serializedTree)
        Deprecated.
        Add the footer.
        Specified by:
        addFooter in interface SerializedFormWriter
        Parameters:
        serializedTree - the serialized tree to be added

      • printDocument

        public void printDocument​(Content serializedTree)
                   throws java.io.IOException
        Deprecated.
        Print the serialized form document.
        Specified by:
        printDocument in interface SerializedFormWriter
        Parameters:
        serializedTree - the content tree that will be printed
        Throws:
        java.io.IOException