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

Class MemberSummaryBuilder

  • @Deprecated
public class MemberSummaryBuilder
extends AbstractMemberBuilder
    Deprecated.
    Builds the member summary.

    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
    Author:
    Jamie Ho, Bhavesh Patel (Modified)

    • Method Detail

      • getName

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

      • getVisibleMemberMap

        public VisibleMemberMap getVisibleMemberMap​(int type)
        Deprecated.
        Return the specified visible member map.
        Parameters:
        type - the type of visible member map to return.
        Returns:
        the specified visible member map.
        Throws:
        ArrayIndexOutOfBoundsException - when the type is invalid.
        See Also:
        VisibleMemberMap

      • getMemberSummaryWriter

        public MemberSummaryWriter getMemberSummaryWriter​(int type)
        Deprecated.
        Return the specified member summary writer.
        Parameters:
        type - the type of member summary writer to return.
        Returns:
        the specified member summary writer.
        Throws:
        ArrayIndexOutOfBoundsException - when the type is invalid.
        See Also:
        VisibleMemberMap

      • members

        public List<ProgramElementDoc> members​(int type)
        Deprecated.
        Returns a list of methods that will be documented for the given class. This information can be used for doclet specific documentation generation.
        Parameters:
        type - the type of members to return.
        Returns:
        a list of methods that will be documented.
        See Also:
        VisibleMemberMap

      • hasMembersToDocument

        public boolean hasMembersToDocument()
        Deprecated.
        Return true it there are any members to summarize.
        Specified by:
        hasMembersToDocument in class AbstractMemberBuilder
        Returns:
        true if there are any members to summarize.

      • buildEnumConstantsSummary

        public void buildEnumConstantsSummary​(XMLNode node,
                                      Content memberSummaryTree)
        Deprecated.
        Build the summary for the enum constants.
        Parameters:
        node - the XML element that specifies which components to document
        memberSummaryTree - the content tree to which the documentation will be added

      • buildAnnotationTypeFieldsSummary

        public void buildAnnotationTypeFieldsSummary​(XMLNode node,
                                             Content memberSummaryTree)
        Deprecated.
        Build the summary for fields.
        Parameters:
        node - the XML element that specifies which components to document
        memberSummaryTree - the content tree to which the documentation will be added

      • buildAnnotationTypeOptionalMemberSummary

        public void buildAnnotationTypeOptionalMemberSummary​(XMLNode node,
                                                     Content memberSummaryTree)
        Deprecated.
        Build the summary for the optional members.
        Parameters:
        node - the XML element that specifies which components to document
        memberSummaryTree - the content tree to which the documentation will be added

      • buildAnnotationTypeRequiredMemberSummary

        public void buildAnnotationTypeRequiredMemberSummary​(XMLNode node,
                                                     Content memberSummaryTree)
        Deprecated.
        Build the summary for the optional members.
        Parameters:
        node - the XML element that specifies which components to document
        memberSummaryTree - the content tree to which the documentation will be added

      • buildFieldsSummary

        public void buildFieldsSummary​(XMLNode node,
                               Content memberSummaryTree)
        Deprecated.
        Build the summary for the fields.
        Parameters:
        node - the XML element that specifies which components to document
        memberSummaryTree - the content tree to which the documentation will be added

      • buildPropertiesSummary

        public void buildPropertiesSummary​(XMLNode node,
                                   Content memberSummaryTree)
        Deprecated.
        Build the summary for the fields.

      • buildNestedClassesSummary

        public void buildNestedClassesSummary​(XMLNode node,
                                      Content memberSummaryTree)
        Deprecated.
        Build the summary for the nested classes.
        Parameters:
        node - the XML element that specifies which components to document
        memberSummaryTree - the content tree to which the documentation will be added

      • buildMethodsSummary

        public void buildMethodsSummary​(XMLNode node,
                                Content memberSummaryTree)
        Deprecated.
        Build the method summary.
        Parameters:
        node - the XML element that specifies which components to document
        memberSummaryTree - the content tree to which the documentation will be added

      • buildConstructorsSummary

        public void buildConstructorsSummary​(XMLNode node,
                                     Content memberSummaryTree)
        Deprecated.
        Build the constructor summary.
        Parameters:
        node - the XML element that specifies which components to document
        memberSummaryTree - the content tree to which the documentation will be added