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

Schnittstelle SerializedFormWriter.SerialMethodWriter

Alle bekannten Implementierungsklassen:
HtmlSerialMethodWriter
Umschließende Schnittstelle:
SerializedFormWriter
public static interface SerializedFormWriter.SerialMethodWriter
Write the serialized form for a given field.

  • Methodendetails

    • getSerializableMethodsHeader

      Content getSerializableMethodsHeader()
      Gibt the header for serializable methods section zurück.
      Gibt zurück:
      the header for serializable methods section

    • getMethodsContentHeader

      Content getMethodsContentHeader(boolean isLastContent)
      Gibt the header for serializable methods content section zurück.
      Parameter:
      isLastContent - true if the content being documented is the last content
      Gibt zurück:
      the header for serializable methods content section

    • getSerializableMethods

      Content getSerializableMethods(String heading, Content source)
      Gets the given heading.
      Parameter:
      heading - the heading to write
      source - the content which will be added
      Gibt zurück:
      a serializable methods content

    • getNoCustomizationMsg

      Content getNoCustomizationMsg(String msg)
      Gets a warning that no serializable methods exist.
      Parameter:
      msg - the warning to print
      Gibt zurück:
      a no customization message

    • addMemberHeader

      void addMemberHeader(ExecutableElement member, Content methodsContent)
      Adds the header.
      Parameter:
      member - the member to write the header for
      methodsContent - the content to which the header will be added

    • addDeprecatedMemberInfo

      void addDeprecatedMemberInfo(ExecutableElement member, Content methodsContent)
      Adds the deprecated information for this member.
      Parameter:
      member - the member to write the deprecated information for
      methodsContent - the content to which the deprecated information will be added

    • addMemberDescription

      void addMemberDescription(ExecutableElement member, Content methodsContent)
      Adds the description for this member.
      Parameter:
      member - the member to write the information for
      methodsContent - the content to which the member information will be added

    • addMemberTags

      void addMemberTags(ExecutableElement member, Content methodsContent)
      Adds the tag information for this member.
      Parameter:
      member - the member to write the tags information for
      methodsContent - the content to which the tags information will be added