Class AbstractMemberBuilder

java.lang.Object
gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.AbstractBuilder
gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.AbstractMemberBuilder
Direct Known Subclasses:
AnnotationTypeFieldBuilder, AnnotationTypeRequiredMemberBuilder, ConstructorBuilder, EnumConstantBuilder, FieldBuilder, MemberSummaryBuilder, MethodBuilder, PropertyBuilder

@Deprecated public abstract class AbstractMemberBuilder extends AbstractBuilder
Deprecated.
The superclass for all member builders. Member builders are only executed within Class Builders. They essentially build sub-components. For example, method documentation is a sub-component of class documentation.

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

    • AbstractMemberBuilder

      public AbstractMemberBuilder(AbstractBuilder.Context context)
      Deprecated.
      Construct a SubBuilder.
      Parameters:
      configuration - the configuration used in this run of the doclet.
  • Method Details

    • build

      public void build() throws DocletAbortException
      Deprecated.
      This method is not supported by sub-builders.
      Specified by:
      build in class AbstractBuilder
      Throws:
      DocletAbortException - this method will always throw a DocletAbortException because it is not supported.
    • build

      public void build(XMLNode node, Content contentTree)
      Deprecated.
      Build the sub component if there is anything to document.
      Overrides:
      build in class AbstractBuilder
      Parameters:
      node - the XML element that specifies which components to document.
      contentTree - content tree to which the documentation will be added
    • hasMembersToDocument

      public abstract boolean hasMembersToDocument()
      Deprecated.
      Return true if this subbuilder has anything to document.
      Returns:
      true if this subbuilder has anything to document.