Interface AnnotationTypeWriter

All Known Implementing Classes:
AnnotationTypeWriterImpl
@Deprecated public interface AnnotationTypeWriter
Deprecated.
The interface for writing annotation type 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

  • Method Details

    • getHeader

      Content getHeader(String header)
      Deprecated.
      Get the header of the page.
      Parameters:
      header - the header string to write
      Returns:
      a content tree for the header documentation

    • getAnnotationContentHeader

      Content getAnnotationContentHeader()
      Deprecated.
      Get the annotation content header.
      Returns:
      annotation content header that needs to be added to the documentation

    • getAnnotationInfoTreeHeader

      Content getAnnotationInfoTreeHeader()
      Deprecated.
      Get the annotation information tree header.
      Returns:
      annotation information tree header that needs to be added to the documentation

    • getAnnotationInfo

      Content getAnnotationInfo(Content annotationInfoTree)
      Deprecated.
      Get the annotation information.
      Parameters:
      annotationInfoTree - content tree containing the annotation information
      Returns:
      a content tree for the annotation

    • addAnnotationTypeSignature

      void addAnnotationTypeSignature(String modifiers, Content annotationInfoTree)
      Deprecated.
      Add the signature of the current annotation type.
      Parameters:
      modifiers - the modifiers for the signature
      annotationInfoTree - the annotation content tree to which the signature will be added

    • addAnnotationTypeDescription

      void addAnnotationTypeDescription(Content annotationInfoTree)
      Deprecated.
      Build the annotation type description.
      Parameters:
      annotationInfoTree - content tree to which the description will be added

    • addAnnotationTypeTagInfo

      void addAnnotationTypeTagInfo(Content annotationInfoTree)
      Deprecated.
      Add the tag information for the current annotation type.
      Parameters:
      annotationInfoTree - content tree to which the tag information will be added

    • addAnnotationTypeDeprecationInfo

      void addAnnotationTypeDeprecationInfo(Content annotationInfoTree)
      Deprecated.
      If this annotation is deprecated, add the appropriate information.
      Parameters:
      annotationInfoTree - content tree to which the deprecated information will be added

    • getMemberTreeHeader

      Content getMemberTreeHeader()
      Deprecated.
      Get the member tree header for the annotation type.
      Returns:
      a content tree for the member tree header

    • addAnnotationContentTree

      void addAnnotationContentTree(Content contentTree, Content annotationContentTree)
      Deprecated.
      Add the annotation content tree to the documentation content tree.
      Parameters:
      contentTree - content tree to which the annotation content will be added
      annotationContentTree - annotation content tree which will be added to the content tree

    • getMemberTree

      Content getMemberTree(Content memberTree)
      Deprecated.
      Get the member tree.
      Parameters:
      memberTree - the content tree that will be modified and returned
      Returns:
      a content tree for the member

    • getMemberSummaryTree

      Content getMemberSummaryTree(Content memberTree)
      Deprecated.
      Get the member summary tree.
      Parameters:
      memberTree - the content tree that will be used to build the summary tree
      Returns:
      a content tree for the member summary

    • getMemberDetailsTree

      Content getMemberDetailsTree(Content memberTree)
      Deprecated.
      Get the member details tree.
      Parameters:
      memberTree - the content tree that will be used to build the details tree
      Returns:
      a content tree for the member details

    • addFooter

      void addFooter(Content contentTree)
      Deprecated.
      Add the footer of the page.
      Parameters:
      contentTree - content tree to which the footer will be added

    • printDocument

      void printDocument(Content contentTree) throws IOException
      Deprecated.
      Print the document.
      Parameters:
      contentTree - content tree that will be printed as a document
      Throws:
      IOException

    • close

      void close() throws IOException
      Deprecated.
      Close the writer.
      Throws:
      IOException

    • getAnnotationTypeDoc

      AnnotationTypeDoc getAnnotationTypeDoc()
      Deprecated.
      Return the AnnotationTypeDoc being documented.
      Returns:
      the AnnotationTypeDoc being documented.