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

Class ClassBuilder

java.lang.Object
gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.AbstractBuilder
gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.ClassBuilder
@Deprecated public class ClassBuilder extends AbstractBuilder
Deprecated.
Builds the summary for a given class.

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

  • Field Details

    • ROOT

      public static final String ROOT
      Deprecated.
      The root element of the class XML is "ClassDoc".
      See Also:

    • classDoc

      private final ClassDoc classDoc
      Deprecated.
      The class being documented.

    • writer

      private final ClassWriter writer
      Deprecated.
      The doclet specific writer.

    • isInterface

      private final boolean isInterface
      Deprecated.
      Keep track of whether or not this classdoc is an interface.

    • isEnum

      private final boolean isEnum
      Deprecated.
      Keep track of whether or not this classdoc is an enum.

    • contentTree

      private Content contentTree
      Deprecated.
      The content tree for the class documentation.

  • Constructor Details

    • ClassBuilder

      private ClassBuilder(AbstractBuilder.Context context, ClassDoc classDoc, ClassWriter writer)
      Deprecated.
      Construct a new ClassBuilder.
      Parameters:
      context - the build context
      classDoc - the class being documented.
      writer - the doclet specific writer.

  • Method Details

    • getInstance

      public static ClassBuilder getInstance(AbstractBuilder.Context context, ClassDoc classDoc, ClassWriter writer)
      Deprecated.
      Construct a new ClassBuilder.
      Parameters:
      context - the build context
      classDoc - the class being documented.
      writer - the doclet specific writer.

    • build

      public void build() throws IOException
      Deprecated.
      Build the documentation.
      Specified by:
      build in class AbstractBuilder
      Throws:
      IOException - if there is a problem writing the output

    • getName

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

    • buildClassDoc

      public void buildClassDoc(XMLNode node, Content contentTree) throws Exception
      Deprecated.
      Handles the <ClassDoc> tag.
      Parameters:
      node - the XML element that specifies which components to document
      contentTree - the content tree to which the documentation will be added
      Throws:
      Exception

    • buildClassTree

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

    • buildClassInfo

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

    • buildTypeParamInfo

      public void buildTypeParamInfo(XMLNode node, Content classInfoTree)
      Deprecated.
      Build the typeparameters of this class.
      Parameters:
      node - the XML element that specifies which components to document
      classInfoTree - the content tree to which the documentation will be added

    • buildSuperInterfacesInfo

      public void buildSuperInterfacesInfo(XMLNode node, Content classInfoTree)
      Deprecated.
      If this is an interface, list all super interfaces.
      Parameters:
      node - the XML element that specifies which components to document
      classInfoTree - the content tree to which the documentation will be added

    • buildImplementedInterfacesInfo

      public void buildImplementedInterfacesInfo(XMLNode node, Content classInfoTree)
      Deprecated.
      If this is a class, list all interfaces implemented by this class.
      Parameters:
      node - the XML element that specifies which components to document
      classInfoTree - the content tree to which the documentation will be added

    • buildSubClassInfo

      public void buildSubClassInfo(XMLNode node, Content classInfoTree)
      Deprecated.
      List all the classes extend this one.
      Parameters:
      node - the XML element that specifies which components to document
      classInfoTree - the content tree to which the documentation will be added

    • buildSubInterfacesInfo

      public void buildSubInterfacesInfo(XMLNode node, Content classInfoTree)
      Deprecated.
      List all the interfaces that extend this one.
      Parameters:
      node - the XML element that specifies which components to document
      classInfoTree - the content tree to which the documentation will be added

    • buildInterfaceUsageInfo

      public void buildInterfaceUsageInfo(XMLNode node, Content classInfoTree)
      Deprecated.
      If this is an interface, list all classes that implement this interface.
      Parameters:
      node - the XML element that specifies which components to document
      classInfoTree - the content tree to which the documentation will be added

    • buildFunctionalInterfaceInfo

      public void buildFunctionalInterfaceInfo(XMLNode node, Content classInfoTree)
      Deprecated.
      If this is an functional interface, display appropriate message.
      Parameters:
      node - the XML element that specifies which components to document
      classInfoTree - the content tree to which the documentation will be added

    • buildDeprecationInfo

      public void buildDeprecationInfo(XMLNode node, Content classInfoTree)
      Deprecated.
      If this class is deprecated, build the appropriate information.
      Parameters:
      node - the XML element that specifies which components to document
      classInfoTree - the content tree to which the documentation will be added

    • buildNestedClassInfo

      public void buildNestedClassInfo(XMLNode node, Content classInfoTree)
      Deprecated.
      If this is an inner class or interface, list the enclosing class or interface.
      Parameters:
      node - the XML element that specifies which components to document
      classInfoTree - the content tree to which the documentation will be added

    • copyDocFiles

      private void copyDocFiles()
      Deprecated.
      Copy the doc files for the current ClassDoc if necessary.

    • buildClassSignature

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

    • buildClassDescription

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

    • buildClassTagInfo

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

    • buildMemberSummary

      public void buildMemberSummary(XMLNode node, Content classContentTree) throws Exception
      Deprecated.
      Build the member summary contents of the page.
      Parameters:
      node - the XML element that specifies which components to document
      classContentTree - the content tree to which the documentation will be added
      Throws:
      Exception

    • buildMemberDetails

      public void buildMemberDetails(XMLNode node, Content classContentTree)
      Deprecated.
      Build the member details contents of the page.
      Parameters:
      node - the XML element that specifies which components to document
      classContentTree - the content tree to which the documentation will be added

    • buildEnumConstantsDetails

      public void buildEnumConstantsDetails(XMLNode node, Content memberDetailsTree) throws Exception
      Deprecated.
      Build the enum constants documentation.
      Parameters:
      node - the XML element that specifies which components to document
      memberDetailsTree - the content tree to which the documentation will be added
      Throws:
      Exception

    • buildFieldDetails

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

    • buildPropertyDetails

      public void buildPropertyDetails(XMLNode node, Content memberDetailsTree) throws Exception
      Deprecated.
      Build the property documentation.
      Parameters:
      elements - the XML elements that specify how a field is documented.
      Throws:
      Exception

    • buildConstructorDetails

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

    • buildMethodDetails

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