Interface SerializedFormWriter

  • All Known Implementing Classes:
    SerializedFormWriterImpl

    @Deprecated
    public interface SerializedFormWriter
    Deprecated.
    The interface for writing serialized form 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
    • Method Detail

      • getHeader

        Content getHeader​(String header)
        Deprecated.
        Get the header.
        Parameters:
        header - the header to write.
        Returns:
        the header content tree
      • getSerializedSummariesHeader

        Content getSerializedSummariesHeader()
        Deprecated.
        Get the serialized form summaries header.
        Returns:
        the serialized form summary header tree
      • getPackageSerializedHeader

        Content getPackageSerializedHeader()
        Deprecated.
        Get the package serialized form header.
        Returns:
        the package serialized form header tree
      • addPackageSerializedTree

        void addPackageSerializedTree​(Content serializedSummariesTree,
                                      Content packageSerializedTree)
        Deprecated.
        Add the serialized tree per package to the serialized summaries tree.
        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
      • getPackageHeader

        Content getPackageHeader​(String packageName)
        Deprecated.
        Get the given package header.
        Parameters:
        packageName - the package header to write
        Returns:
        a content tree for the package header
      • getClassSerializedHeader

        Content getClassSerializedHeader()
        Deprecated.
        Get the serialized class header.
        Returns:
        a content tree for the serialized class header
      • getClassHeader

        Content getClassHeader​(ClassDoc classDoc)
        Deprecated.
        Get the heading for the serializable class.
        Parameters:
        classDoc - the class being processed
        Returns:
        a content tree for the class heading
      • getSerialUIDInfoHeader

        Content getSerialUIDInfoHeader()
        Deprecated.
        Get the serial UID info header.
        Returns:
        a content tree for the serial uid info header
      • addSerialUIDInfo

        void addSerialUIDInfo​(String header,
                              String serialUID,
                              Content serialUidTree)
        Deprecated.
        Adds the serial UID info.
        Parameters:
        header - the header that will show up before the UID.
        serialUID - the serial UID to print.
        serialUidTree - the serial UID tree to which the content will be added.
      • getClassContentHeader

        Content getClassContentHeader()
        Deprecated.
        Get the class serialize content header.
        Returns:
        a content tree for the class serialize content header
      • getSerializedContent

        Content getSerializedContent​(Content serializedTreeContent)
        Deprecated.
        Get the serialized content.
        Parameters:
        serializedTreeContent - content for serialized data
        Returns:
        a content tree for serialized information
      • addFooter

        void addFooter​(Content serializedTree)
        Deprecated.
        Add the footer.
        Parameters:
        serializedTree - the serialized tree to be added
      • printDocument

        void printDocument​(Content serializedTree)
                    throws IOException
        Deprecated.
        Print the serialized form document.
        Parameters:
        serializedTree - the content tree that will be printed
        Throws:
        IOException