Package gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders

Class AnnotationTypeFieldBuilder

java.lang.Object
gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.AbstractBuilder
gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.AbstractMemberBuilder
gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.AnnotationTypeFieldBuilder
@Deprecated public class AnnotationTypeFieldBuilder extends AbstractMemberBuilder
Deprecated.
Builds documentation for annotation type fields.

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.8

  • Field Details

    • classDoc

      protected ClassDoc classDoc
      Deprecated.
      The annotation type whose members are being documented.

    • visibleMemberMap

      protected VisibleMemberMap visibleMemberMap
      Deprecated.
      The visible members for the given class.

    • writer

      protected AnnotationTypeFieldWriter writer
      Deprecated.
      The writer to output the member documentation.

    • members

      protected List<ProgramElementDoc> members
      Deprecated.
      The list of members being documented.

    • currentMemberIndex

      protected int currentMemberIndex
      Deprecated.
      The index of the current member that is being documented at this point in time.

  • Constructor Details

    • AnnotationTypeFieldBuilder

      protected AnnotationTypeFieldBuilder(AbstractBuilder.Context context, ClassDoc classDoc, AnnotationTypeFieldWriter writer, int memberType)
      Deprecated.
      Construct a new AnnotationTypeFieldsBuilder.
      Parameters:
      context - the build context.
      classDoc - the class whose members are being documented.
      writer - the doclet specific writer.
      memberType - the type of member that is being documented.

  • Method Details

    • getInstance

      public static AnnotationTypeFieldBuilder getInstance(AbstractBuilder.Context context, ClassDoc classDoc, AnnotationTypeFieldWriter writer)
      Deprecated.
      Construct a new AnnotationTypeFieldBuilder.
      Parameters:
      context - the build context.
      classDoc - the class whose members are being documented.
      writer - the doclet specific writer.

    • getName

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

    • members

      public List<ProgramElementDoc> members(ClassDoc classDoc)
      Deprecated.
      Returns a list of members that will be documented for the given class. This information can be used for doclet specific documentation generation.
      Parameters:
      classDoc - the ClassDoc we want to check.
      Returns:
      a list of members that will be documented.

    • getVisibleMemberMap

      public VisibleMemberMap getVisibleMemberMap()
      Deprecated.
      Returns the visible member map for the members of this class.
      Returns:
      the visible member map for the members of this class.

    • hasMembersToDocument

      public boolean hasMembersToDocument()
      Deprecated.
      summaryOrder.size()
      Specified by:
      hasMembersToDocument in class AbstractMemberBuilder
      Returns:
      true if this subbuilder has anything to document.

    • buildAnnotationTypeField

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

    • buildAnnotationTypeMember

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

    • buildSignature

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

    • buildDeprecationInfo

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

    • buildMemberComments

      public void buildMemberComments(XMLNode node, Content annotationDocTree)
      Deprecated.
      Build the comments for the member. Do nothing if Configuration.nocomment is set to true.
      Parameters:
      node - the XML element that specifies which components to document
      annotationDocTree - the content tree to which the documentation will be added

    • buildTagInfo

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

    • getWriter

      public AnnotationTypeFieldWriter getWriter()
      Deprecated.
      Return the annotation type field writer for this builder.
      Returns:
      the annotation type field writer for this builder.