Package org.jdrupes.mdoclet.internal.doclets.toolkit.builders

Klasse SerializedFormBuilder

java.lang.Object
org.jdrupes.mdoclet.internal.doclets.toolkit.builders.AbstractBuilder
org.jdrupes.mdoclet.internal.doclets.toolkit.builders.SerializedFormBuilder
public class SerializedFormBuilder extends AbstractBuilder
Builds the serialized form.

  • Felddetails

  • Methodendetails

    • getInstance

      public static SerializedFormBuilder getInstance(AbstractBuilder.Context context)
      Construct a new SerializedFormBuilder.
      Parameter:
      context - the build context.
      Gibt zurück:
      the new SerializedFormBuilder

    • build

      public void build() throws DocletException
      Build the serialized form.
      Angegeben von:
      build in Klasse AbstractBuilder
      Löst aus:
      DocletException - if there is a problem while building the documentation

    • buildSerializedForm

      protected void buildSerializedForm() throws DocletException
      Build the serialized form.
      Löst aus:
      DocletException - if there is a problem while building the documentation

    • buildSerializedFormSummaries

      protected void buildSerializedFormSummaries() throws DocletException
      Build the serialized form summaries.
      Löst aus:
      DocletException - if there is a problem while building the documentation

    • buildPackageSerializedForm

      protected void buildPackageSerializedForm(Content target) throws DocletException
      Build the package serialized form for the current package being processed.
      Parameter:
      target - the content to which the documentation will be added
      Löst aus:
      DocletException - if there is a problem while building the documentation

    • buildPackageHeader

      protected void buildPackageHeader(Content target)
      Build the package header.
      Parameter:
      target - the content to which the documentation will be added

    • buildClassSerializedForm

      protected void buildClassSerializedForm(Content target) throws DocletException
      Build the class serialized form.
      Parameter:
      target - the content to which the documentation will be added
      Löst aus:
      DocletException - if there is a problem while building the documentation

    • buildSerialUIDInfo

      protected void buildSerialUIDInfo(Content target)
      Build the serial UID information for the given class.
      Parameter:
      target - the content to which the serial UID information will be added

    • buildClassContent

      protected void buildClassContent(Content target) throws DocletException
      Build the summaries for the methods and fields.
      Parameter:
      target - the content to which the documentation will be added
      Löst aus:
      DocletException - if there is a problem while building the documentation

    • buildSerializableMethods

      protected void buildSerializableMethods(Content target) throws DocletException
      Build the summaries for the methods that belong to the given class.
      Parameter:
      target - the content to which the documentation will be added
      Löst aus:
      DocletException - if there is a problem while building the documentation

    • buildMethodSubHeader

      protected void buildMethodSubHeader(Content methodsContent)
      Build the method sub header.
      Parameter:
      methodsContent - the content to which the documentation will be added

    • buildDeprecatedMethodInfo

      protected void buildDeprecatedMethodInfo(Content methodsContent)
      Build the deprecated method description.
      Parameter:
      methodsContent - the content to which the documentation will be added

    • buildMethodInfo

      protected void buildMethodInfo(Content methodsContent) throws DocletException
      Build the information for the method.
      Parameter:
      methodsContent - the content to which the documentation will be added
      Löst aus:
      DocletException - if there is a problem while building the documentation

    • buildMethodDescription

      protected void buildMethodDescription(Content methodsContent)
      Build method description.
      Parameter:
      methodsContent - the content to which the documentation will be added

    • buildMethodTags

      protected void buildMethodTags(Content methodsContent)
      Build the method tags.
      Parameter:
      methodsContent - the content to which the documentation will be added

    • buildFieldHeader

      protected void buildFieldHeader(Content classContent)
      Build the field header.
      Parameter:
      classContent - the content to which the documentation will be added

    • buildFieldSerializationOverview

      public void buildFieldSerializationOverview(TypeElement typeElement, Content classContent)
      Build the serialization overview for the given class.
      Parameter:
      typeElement - the class to print the overview for.
      classContent - the content to which the documentation will be added

    • buildSerializableFields

      protected void buildSerializableFields(Content target) throws DocletException
      Build the summaries for the fields that belong to the given class.
      Parameter:
      target - the content to which the documentation will be added
      Löst aus:
      DocletException - if there is a problem while building the documentation

    • buildFieldSubHeader

      protected void buildFieldSubHeader(Content fieldsContent)
      Build the field sub header.
      Parameter:
      fieldsContent - the content to which the documentation will be added

    • buildFieldDeprecationInfo

      protected void buildFieldDeprecationInfo(Content fieldsContent)
      Build the field deprecation information.
      Parameter:
      fieldsContent - the content to which the documentation will be added

    • buildSerialFieldTagsInfo

      protected void buildSerialFieldTagsInfo(Content target)
      Build the serial field tags information.
      Parameter:
      target - the content to which the documentation will be added

    • buildFieldInfo

      protected void buildFieldInfo(Content fieldsContent)
      Build the field information.
      Parameter:
      fieldsContent - the content to which the documentation will be added

    • serialInclude

      public static boolean serialInclude(Utils utils, Element element)
      Returns true if the given Element should be included in the serialized form.
      Parameter:
      utils - the utils object
      element - the Element object to check for serializability
      Gibt zurück:
      true if the element should be included in the serial form