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

Class EnumConstantBuilder

  • @Deprecated
public class EnumConstantBuilder
extends AbstractMemberBuilder
    Deprecated.
    Builds documentation for a enum constants.

    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 Detail

      • classDoc

        private final ClassDoc classDoc
        Deprecated.
        The class whose enum constants are being documented.

      • visibleMemberMap

        private final VisibleMemberMap visibleMemberMap
        Deprecated.
        The visible enum constantss for the given class.

      • writer

        private final EnumConstantWriter writer
        Deprecated.
        The writer to output the enum constants documentation.

      • enumConstants

        private final java.util.List<ProgramElementDoc> enumConstants
        Deprecated.
        The list of enum constants being documented.

      • currentEnumConstantsIndex

        private int currentEnumConstantsIndex
        Deprecated.
        The index of the current enum constant that is being documented at this point in time.

    • Constructor Detail

      • EnumConstantBuilder

        private EnumConstantBuilder​(AbstractBuilder.Context context,
                            ClassDoc classDoc,
                            EnumConstantWriter writer)
        Deprecated.
        Construct a new EnumConstantsBuilder.
        Parameters:
        context - the build context.
        classDoc - the class whoses members are being documented.
        writer - the doclet specific writer.

    • Method Detail

      • getName

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

      • members

        public java.util.List<ProgramElementDoc> members​(ClassDoc classDoc)
        Deprecated.
        Returns a list of enum constants 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 enum constants that will be documented.

      • getVisibleMemberMap

        public VisibleMemberMap getVisibleMemberMap()
        Deprecated.
        Returns the visible member map for the enum constants of this class.
        Returns:
        the visible member map for the enum constants 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.

      • buildEnumConstant

        public void buildEnumConstant​(XMLNode node,
                              Content memberDetailsTree)
        Deprecated.
        Build the enum constant 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 enumConstantsTree)
        Deprecated.
        Build the signature.
        Parameters:
        node - the XML element that specifies which components to document
        enumConstantsTree - the content tree to which the documentation will be added

      • buildDeprecationInfo

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

      • buildEnumConstantComments

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

      • buildTagInfo

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

      • getWriter

        public EnumConstantWriter getWriter()
        Deprecated.
        Return the enum constant writer for this builder.
        Returns:
        the enum constant writer for this builder.