Class SerializedFormBuilder

java.lang.Object
gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.AbstractBuilder
gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.SerializedFormBuilder
@Deprecated public class SerializedFormBuilder extends AbstractBuilder
Deprecated.
Builds the serialized form.

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 Details

    • NAME

      public static final String NAME
      Deprecated.
      The root element of the serialized form XML is "SerializedForm".
      See Also:

    • writer

      private SerializedFormWriter writer
      Deprecated.
      The writer for this builder.

    • fieldWriter

      private SerializedFormWriter.SerialFieldWriter fieldWriter
      Deprecated.
      The writer for serializable fields.

    • methodWriter

      private SerializedFormWriter.SerialMethodWriter methodWriter
      Deprecated.
      The writer for serializable method documentation.

    • SERIAL_VERSION_UID_HEADER

      private static final String SERIAL_VERSION_UID_HEADER
      Deprecated.
      The header for the serial version UID. Save the string here instead of the properties file because we do not want this string to be localized.
      See Also:

    • currentPackage

      private PackageDoc currentPackage
      Deprecated.
      The current package being documented.

    • currentClass

      private ClassDoc currentClass
      Deprecated.
      The current class being documented.

    • currentMember

      protected MemberDoc currentMember
      Deprecated.
      The current member being documented.

    • contentTree

      private Content contentTree
      Deprecated.
      The content that will be added to the serialized form documentation tree.

  • Constructor Details

    • SerializedFormBuilder

      private SerializedFormBuilder(AbstractBuilder.Context context)
      Deprecated.
      Construct a new SerializedFormBuilder.
      Parameters:
      context - the build context.

  • Method Details

    • getInstance

      public static SerializedFormBuilder getInstance(AbstractBuilder.Context context)
      Deprecated.
      Construct a new SerializedFormBuilder.
      Parameters:
      context - the build context.

    • build

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

    • getName

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

    • buildSerializedForm

      public void buildSerializedForm(XMLNode node, Content serializedTree) throws Exception
      Deprecated.
      Build the serialized form.
      Parameters:
      node - the XML element that specifies which components to document
      serializedTree - content tree to which the documentation will be added
      Throws:
      Exception

    • buildSerializedFormSummaries

      public void buildSerializedFormSummaries(XMLNode node, Content serializedTree)
      Deprecated.
      Build the serialized form summaries.
      Parameters:
      node - the XML element that specifies which components to document
      serializedTree - content tree to which the documentation will be added

    • buildPackageSerializedForm

      public void buildPackageSerializedForm(XMLNode node, Content serializedSummariesTree)
      Deprecated.
      Build the package serialized form for the current package being processed.
      Parameters:
      node - the XML element that specifies which components to document
      serializedSummariesTree - content tree to which the documentation will be added

    • buildPackageHeader

      public void buildPackageHeader(XMLNode node, Content packageSerializedTree)
      Deprecated.
      Build the package header.
      Parameters:
      node - the XML element that specifies which components to document
      packageSerializedTree - content tree to which the documentation will be added

    • buildClassSerializedForm

      public void buildClassSerializedForm(XMLNode node, Content packageSerializedTree)
      Deprecated.
      Build the class serialized form.
      Parameters:
      node - the XML element that specifies which components to document
      packageSerializedTree - content tree to which the documentation will be added

    • buildSerialUIDInfo

      public void buildSerialUIDInfo(XMLNode node, Content classTree)
      Deprecated.
      Build the serial UID information for the given class.
      Parameters:
      node - the XML element that specifies which components to document
      classTree - content tree to which the serial UID information will be added

    • buildClassContent

      public void buildClassContent(XMLNode node, Content classTree)
      Deprecated.
      Build the summaries for the methods and fields.
      Parameters:
      node - the XML element that specifies which components to document
      classTree - content tree to which the documentation will be added

    • buildSerializableMethods

      public void buildSerializableMethods(XMLNode node, Content classContentTree)
      Deprecated.
      Build the summaries for the methods that belong to the given class.
      Parameters:
      node - the XML element that specifies which components to document
      classContentTree - content tree to which the documentation will be added

    • buildMethodSubHeader

      public void buildMethodSubHeader(XMLNode node, Content methodsContentTree)
      Deprecated.
      Build the method sub header.
      Parameters:
      node - the XML element that specifies which components to document
      methodsContentTree - content tree to which the documentation will be added

    • buildDeprecatedMethodInfo

      public void buildDeprecatedMethodInfo(XMLNode node, Content methodsContentTree)
      Deprecated.
      Build the deprecated method description.
      Parameters:
      node - the XML element that specifies which components to document
      methodsContentTree - content tree to which the documentation will be added

    • buildMethodInfo

      public void buildMethodInfo(XMLNode node, Content methodsContentTree)
      Deprecated.
      Build the information for the method.
      Parameters:
      node - the XML element that specifies which components to document
      methodsContentTree - content tree to which the documentation will be added

    • buildMethodDescription

      public void buildMethodDescription(XMLNode node, Content methodsContentTree)
      Deprecated.
      Build method description.
      Parameters:
      node - the XML element that specifies which components to document
      methodsContentTree - content tree to which the documentation will be added

    • buildMethodTags

      public void buildMethodTags(XMLNode node, Content methodsContentTree)
      Deprecated.
      Build the method tags.
      Parameters:
      node - the XML element that specifies which components to document
      methodsContentTree - content tree to which the documentation will be added

    • buildFieldHeader

      public void buildFieldHeader(XMLNode node, Content classContentTree)
      Deprecated.
      Build the field header.
      Parameters:
      node - the XML element that specifies which components to document
      classContentTree - content tree to which the documentation will be added

    • buildFieldSerializationOverview

      public void buildFieldSerializationOverview(ClassDoc classDoc, Content classContentTree)
      Deprecated.
      Build the serialization overview for the given class.
      Parameters:
      classDoc - the class to print the overview for.
      classContentTree - content tree to which the documentation will be added

    • buildSerializableFields

      public void buildSerializableFields(XMLNode node, Content classContentTree)
      Deprecated.
      Build the summaries for the fields that belong to the given class.
      Parameters:
      node - the XML element that specifies which components to document
      classContentTree - content tree to which the documentation will be added

    • buildFieldSubHeader

      public void buildFieldSubHeader(XMLNode node, Content fieldsContentTree)
      Deprecated.
      Build the field sub header.
      Parameters:
      node - the XML element that specifies which components to document
      fieldsContentTree - content tree to which the documentation will be added

    • buildFieldDeprecationInfo

      public void buildFieldDeprecationInfo(XMLNode node, Content fieldsContentTree)
      Deprecated.
      Build the field deprecation information.
      Parameters:
      node - the XML element that specifies which components to document
      fieldsContentTree - content tree to which the documentation will be added

    • buildSerialFieldTagsInfo

      public void buildSerialFieldTagsInfo(Content serializableFieldsTree)
      Deprecated.
      Build the serial field tags information.
      Parameters:
      serializableFieldsTree - content tree to which the documentation will be added

    • buildFieldInfo

      public void buildFieldInfo(XMLNode node, Content fieldsContentTree)
      Deprecated.
      Build the field information.
      Parameters:
      node - the XML element that specifies which components to document
      fieldsContentTree - content tree to which the documentation will be added

    • serialInclude

      public static boolean serialInclude(Doc doc)
      Deprecated.
      Return true if the given Doc should be included in the serialized form.
      Parameters:
      doc - the Doc object to check for serializability.

    • serialClassInclude

      private static boolean serialClassInclude(ClassDoc cd)
      Deprecated.
      Return true if the given ClassDoc should be included in the serialized form.
      Parameters:
      cd - the ClassDoc object to check for serializability.

    • serialDocInclude

      private static boolean serialDocInclude(Doc doc)
      Deprecated.
      Return true if the given Doc should be included in the serialized form.
      Parameters:
      doc - the Doc object to check for serializability.

    • serialClassFoundToDocument

      private boolean serialClassFoundToDocument(ClassDoc[] classes)
      Deprecated.
      Return true if any of the given classes have a @serialinclude tag.
      Parameters:
      classes - the classes to check.
      Returns:
      true if any of the given classes have a @serialinclude tag.