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

    • Field Detail

      • NAME

        public static final java.lang.String NAME
        Deprecated.
        The XML root for this builder.
        See Also:
        Constant Field Values

      • visibleMemberMaps

        private final VisibleMemberMap[] visibleMemberMaps
        Deprecated.
        The visible members for the given class.

      • memberSummaryWriters

        private MemberSummaryWriter[] memberSummaryWriters
        Deprecated.
        The member summary writers for the given class.

      • classDoc

        private final ClassDoc classDoc
        Deprecated.
        The type being documented.

    • Constructor Detail

      • MemberSummaryBuilder

        private MemberSummaryBuilder​(AbstractBuilder.Context context,
                             ClassDoc classDoc)
        Deprecated.
        Construct a new MemberSummaryBuilder.
        Parameters:
        classWriter - the writer for the class whose members are being summarized.
        context - the build context.

    • Method Detail

      • getInstance

        public static MemberSummaryBuilder getInstance​(ClassWriter classWriter,
                                               AbstractBuilder.Context context)
                                        throws java.lang.Exception
        Deprecated.
        Construct a new MemberSummaryBuilder.
        Parameters:
        classWriter - the writer for the class whose members are being summarized.
        context - the build context.
        Throws:
        java.lang.Exception

      • getInstance

        public static MemberSummaryBuilder getInstance​(AnnotationTypeWriter annotationTypeWriter,
                                               AbstractBuilder.Context context)
                                        throws java.lang.Exception
        Deprecated.
        Construct a new MemberSummaryBuilder.
        Parameters:
        annotationTypeWriter - the writer for the class whose members are being summarized.
        configuration - the current configuration of the doclet.
        Throws:
        java.lang.Exception

      • 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.

      • 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:
        java.lang.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:
        java.lang.ArrayIndexOutOfBoundsException - when the type is invalid.
        See Also:
        VisibleMemberMap

      • members

        public java.util.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

      • buildSummary

        private void buildSummary​(MemberSummaryWriter writer,
                          VisibleMemberMap visibleMemberMap,
                          java.util.LinkedList<Content> summaryTreeList)
        Deprecated.
        Build the member summary for the given members.
        Parameters:
        writer - the summary writer to write the output.
        visibleMemberMap - the given members to summarize.
        summaryTreeList - list of content trees to which the documentation will be added

      • processProperty

        private void processProperty​(VisibleMemberMap visibleMemberMap,
                             ProgramElementDoc member,
                             ProgramElementDoc propertyDoc)
        Deprecated.
        Process the property method, property setter and/or property getter comment text so that it contains the documentation from the property field. The method adds the leading sentence, copied documentation including the defaultValue tag and the see tags if the appropriate property getter and setter are available.
        Parameters:
        visibleMemberMap - the members information.
        member - the member which is to be augmented.
        propertyDoc - the original property documentation.

      • isGetter

        private boolean isGetter​(ProgramElementDoc ped)
        Deprecated.
        Test whether the method is a getter.
        Parameters:
        ped - property method documentation. Needs to be either property method, property getter, or property setter.
        Returns:
        true if the given documentation belongs to a getter.

      • isSetter

        private boolean isSetter​(ProgramElementDoc ped)
        Deprecated.
        Test whether the method is a setter.
        Parameters:
        ped - property method documentation. Needs to be either property method, property getter, or property setter.
        Returns:
        true if the given documentation belongs to a setter.

      • buildInheritedSummary

        private void buildInheritedSummary​(MemberSummaryWriter writer,
                                   VisibleMemberMap visibleMemberMap,
                                   java.util.LinkedList<Content> summaryTreeList)
        Deprecated.
        Build the inherited member summary for the given methods.
        Parameters:
        writer - the writer for this member summary.
        visibleMemberMap - the map for the members to document.
        summaryTreeList - list of content trees to which the documentation will be added

      • addSummary

        private void addSummary​(MemberSummaryWriter writer,
                        VisibleMemberMap visibleMemberMap,
                        boolean showInheritedSummary,
                        Content memberSummaryTree)
        Deprecated.
        Add the summary for the documentation.
        Parameters:
        writer - the writer for this member summary.
        visibleMemberMap - the map for the members to document.
        showInheritedSummary - true if inherited summary should be documented
        memberSummaryTree - the content tree to which the documentation will be added