Class AnnotationTypeOptionalMemberBuilder


@Deprecated public class AnnotationTypeOptionalMemberBuilder extends AnnotationTypeRequiredMemberBuilder
Deprecated.
Builds documentation for optional annotation type members.

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
  • Constructor Details

    • AnnotationTypeOptionalMemberBuilder

      private AnnotationTypeOptionalMemberBuilder(AbstractBuilder.Context context, ClassDoc classDoc, AnnotationTypeOptionalMemberWriter writer)
      Deprecated.
      Construct a new AnnotationTypeMemberBuilder.
      Parameters:
      context - the build context.
      classDoc - the class whose members are being documented.
      writer - the doclet specific writer.
  • Method Details

    • getInstance

      Deprecated.
      Construct a new AnnotationTypeMemberBuilder.
      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.
      Overrides:
      getName in class AnnotationTypeRequiredMemberBuilder
      Returns:
      the name of the builder.
    • buildAnnotationTypeOptionalMember

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

      public void buildDefaultValueInfo(XMLNode node, Content annotationDocTree)
      Deprecated.
      Build the default value for this optional member.
      Parameters:
      node - the XML element that specifies which components to document
      annotationDocTree - the content tree to which the documentation will be added
    • getWriter

      Deprecated.
      Return the annotation type required member writer for this builder.
      Overrides:
      getWriter in class AnnotationTypeRequiredMemberBuilder
      Returns:
      the annotation type required member constant writer for this builder.