jdk-sandbox: comparison langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/builders/MemberSummaryBuilder.java

equal deleted inserted replaced

-:3fd30668e9b5
+:cfadc977ca75
 * questions.
 */
 package com.sun.tools.doclets.internal.toolkit.builders;
+import java.util.*;
 import com.sun.tools.doclets.internal.toolkit.util.*;
 import com.sun.tools.doclets.internal.toolkit.*;
 import com.sun.javadoc.*;
-import java.util.*;
 /**
 * Builds the member summary.
 *
 * This code is not part of an API.
 * It is implementation that is subject to change.
 * Do not use it as an API
 *
 * @author Jamie Ho
+* @author Bhavesh Patel (Modified)
 * @since 1.5
 */
 public class MemberSummaryBuilder extends AbstractMemberBuilder {
 /**
 * The XML root for this builder.
 */
 public static final String NAME = "MemberSummary";
 /**
 * The visible members for the given class.
 */
 private VisibleMemberMap[] visibleMemberMaps;
 /**
 * The member summary writers for the given class.
 */
 private MemberSummaryWriter[] memberSummaryWriters;
 /**
 * The type being documented.
 */
 private ClassDoc classDoc;
 private MemberSummaryBuilder(Configuration configuration) {
 super(configuration);
 }
 /**
 * Construct a new MemberSummaryBuilder.
 *
 * @param classWriter   the writer for the class whose members are being
 *                      summarized.
 * @param configuration the current configuration of the doclet.
 */
 public static MemberSummaryBuilder getInstance(
 ClassWriter classWriter, Configuration configuration)
 throws Exception {
 MemberSummaryBuilder builder = new MemberSummaryBuilder(configuration);
 builder.classDoc = classWriter.getClassDoc();
 builder.init(classWriter);
 return builder;
 }
 /**
 * Construct a new MemberSummaryBuilder.
 *
 * @param annotationTypeWriter the writer for the class whose members are
 *                             being summarized.
 * @param configuration the current configuration of the doclet.
 */
 public static MemberSummaryBuilder getInstance(
 AnnotationTypeWriter annotationTypeWriter, Configuration configuration)
 throws Exception {
 MemberSummaryBuilder builder = new MemberSummaryBuilder(configuration);
 builder.classDoc = annotationTypeWriter.getAnnotationTypeDoc();
 builder.init(annotationTypeWriter);
 return builder;
 }
 private void init(Object writer) throws Exception {
 visibleMemberMaps =
 new VisibleMemberMap[VisibleMemberMap.NUM_MEMBER_TYPES];
 for (int i = 0; i < VisibleMemberMap.NUM_MEMBER_TYPES; i++) {
 visibleMemberMaps[i] =
 new VisibleMemberMap(
 classDoc,
 i,
 configuration.nodeprecated);
 }
 memberSummaryWriters =
 new MemberSummaryWriter[VisibleMemberMap.NUM_MEMBER_TYPES];
 for (int i = 0; i < VisibleMemberMap.NUM_MEMBER_TYPES; i++) {
 if (classDoc.isAnnotationType()) {
 memberSummaryWriters[i] =
 visibleMemberMaps[i].noVisibleMembers()?
 null :
 configuration.getWriterFactory().getMemberSummaryWriter(
 (AnnotationTypeWriter) writer, i);
 } else {
 memberSummaryWriters[i] =
 visibleMemberMaps[i].noVisibleMembers()?
 null :
 configuration.getWriterFactory().getMemberSummaryWriter(
 (ClassWriter) writer, i);
 }
 }
 }
 /**
 * {@inheritDoc}
 */
 public String getName() {
 return NAME;
 }
 /**
 * Return the specified visible member map.
 *
 * @param type the type of visible member map to return.
 * @return the specified visible member map.
 * @throws ArrayIndexOutOfBoundsException when the type is invalid.
 * @see VisibleMemberMap
 */
 public VisibleMemberMap getVisibleMemberMap(int type) {
 return visibleMemberMaps[type];
 }
 /**
 * Return the specified member summary writer.
 *
 * @param type the type of member summary writer to return.
 * @return the specified member summary writer.
 * @throws ArrayIndexOutOfBoundsException when the type is invalid.
 * @see VisibleMemberMap
 */
 public MemberSummaryWriter getMemberSummaryWriter(int type) {
 return memberSummaryWriters[type];
 }
 /**
 * Returns a list of methods that will be documented for the given class.
 * This information can be used for doclet specific documentation
 * generation.
 *
 * @param classDoc the {@link ClassDoc} we want to check.
 * @param type the type of members to return.
 * @return a list of methods that will be documented.
 * @see VisibleMemberMap
 */
 public List<ProgramElementDoc> members(int type) {
 return visibleMemberMaps[type].getLeafClassMembers(configuration);
 }
 /**
 * Return true it there are any members to summarize.
 *
 * @return true if there are any members to summarize.
 */
 public boolean hasMembersToDocument() {
 if (classDoc instanceof AnnotationTypeDoc) {
 return ((AnnotationTypeDoc) classDoc).elements().length > 0;
 }
 for (int i = 0; i < VisibleMemberMap.NUM_MEMBER_TYPES; i++) {
 VisibleMemberMap members = visibleMemberMaps[i];
 if (!members.noVisibleMembers()) {
 return true;
 }
 }
 return false;
 }
 /**
 * Build the summary for the enum constants.
-*/
+*
-public void buildEnumConstantsSummary(XMLNode node) {
+* @param node the XML element that specifies which components to document
-buildSummary(
+* @param memberSummaryTree the content tree to which the documentation will be added
-memberSummaryWriters[VisibleMemberMap.ENUM_CONSTANTS],
+*/
-visibleMemberMaps[VisibleMemberMap.ENUM_CONSTANTS]);
+public void buildEnumConstantsSummary(XMLNode node, Content memberSummaryTree) {
-}
+MemberSummaryWriter writer =
+memberSummaryWriters[VisibleMemberMap.ENUM_CONSTANTS];
+VisibleMemberMap visibleMemberMap =
+visibleMemberMaps[VisibleMemberMap.ENUM_CONSTANTS];
+addSummary(writer, visibleMemberMap, false, memberSummaryTree);
+}
 /**
 * Build the summary for the optional members.
-*/
+*
-public void buildAnnotationTypeOptionalMemberSummary(XMLNode node) {
+* @param node the XML element that specifies which components to document
-buildSummary(
+* @param memberSummaryTree the content tree to which the documentation will be added
-memberSummaryWriters[VisibleMemberMap.ANNOTATION_TYPE_MEMBER_OPTIONAL],
+*/
-visibleMemberMaps[VisibleMemberMap.ANNOTATION_TYPE_MEMBER_OPTIONAL]);
+public void buildAnnotationTypeOptionalMemberSummary(XMLNode node, Content memberSummaryTree) {
+MemberSummaryWriter writer =
+memberSummaryWriters[VisibleMemberMap.ANNOTATION_TYPE_MEMBER_OPTIONAL];
+VisibleMemberMap visibleMemberMap =
+visibleMemberMaps[VisibleMemberMap.ANNOTATION_TYPE_MEMBER_OPTIONAL];
+addSummary(writer, visibleMemberMap, false, memberSummaryTree);
 }
 /**
 * Build the summary for the optional members.
-*/
+*
-public void buildAnnotationTypeRequiredMemberSummary(XMLNode node) {
+* @param node the XML element that specifies which components to document
-buildSummary(
+* @param memberSummaryTree the content tree to which the documentation will be added
-memberSummaryWriters[VisibleMemberMap.ANNOTATION_TYPE_MEMBER_REQUIRED],
+*/
-visibleMemberMaps[VisibleMemberMap.ANNOTATION_TYPE_MEMBER_REQUIRED]);
+public void buildAnnotationTypeRequiredMemberSummary(XMLNode node, Content memberSummaryTree) {
-}
+MemberSummaryWriter writer =
+memberSummaryWriters[VisibleMemberMap.ANNOTATION_TYPE_MEMBER_REQUIRED];
-/**
+VisibleMemberMap visibleMemberMap =
-* Build the summary for the fields.
+visibleMemberMaps[VisibleMemberMap.ANNOTATION_TYPE_MEMBER_REQUIRED];
-*/
+addSummary(writer, visibleMemberMap, false, memberSummaryTree);
-public void buildFieldsSummary(XMLNode node) {
+}
-buildSummary(
-memberSummaryWriters[VisibleMemberMap.FIELDS],
+/**
-visibleMemberMaps[VisibleMemberMap.FIELDS]);
+* Build the summary for the fields.
-}
+*
+* @param node the XML element that specifies which components to document
-/**
+* @param memberSummaryTree the content tree to which the documentation will be added
-* Build the inherited summary for the fields.
+*/
-*/
+public void buildFieldsSummary(XMLNode node, Content memberSummaryTree) {
-public void buildFieldsInheritedSummary(XMLNode node) {
+MemberSummaryWriter writer =
-buildInheritedSummary(
+memberSummaryWriters[VisibleMemberMap.FIELDS];
-memberSummaryWriters[VisibleMemberMap.FIELDS],
+VisibleMemberMap visibleMemberMap =
-visibleMemberMaps[VisibleMemberMap.FIELDS]);
+visibleMemberMaps[VisibleMemberMap.FIELDS];
-}
+addSummary(writer, visibleMemberMap, true, memberSummaryTree);
+}
-/**
-* Build the summary for the nested classes.
+/**
-*/
+* Build the summary for the nested classes.
-public void buildNestedClassesSummary(XMLNode node) {
+*
-buildSummary(
+* @param node the XML element that specifies which components to document
-memberSummaryWriters[VisibleMemberMap.INNERCLASSES],
+* @param memberSummaryTree the content tree to which the documentation will be added
-visibleMemberMaps[VisibleMemberMap.INNERCLASSES]);
+*/
-}
+public void buildNestedClassesSummary(XMLNode node, Content memberSummaryTree) {
+MemberSummaryWriter writer =
-/**
+memberSummaryWriters[VisibleMemberMap.INNERCLASSES];
-* Build the inherited summary for the nested classes.
+VisibleMemberMap visibleMemberMap =
-*/
+visibleMemberMaps[VisibleMemberMap.INNERCLASSES];
-public void buildNestedClassesInheritedSummary(XMLNode node) {
+addSummary(writer, visibleMemberMap, true, memberSummaryTree);
-buildInheritedSummary(
+}
-memberSummaryWriters[VisibleMemberMap.INNERCLASSES],
-visibleMemberMaps[VisibleMemberMap.INNERCLASSES]);
+/**
-}
+* Build the method summary.
+*
-/**
+* @param node the XML element that specifies which components to document
-* Build the method summary.
+* @param memberSummaryTree the content tree to which the documentation will be added
 */
-public void buildMethodsSummary(XMLNode node) {
+public void buildMethodsSummary(XMLNode node, Content memberSummaryTree) {
-buildSummary(
+MemberSummaryWriter writer =
-memberSummaryWriters[VisibleMemberMap.METHODS],
+memberSummaryWriters[VisibleMemberMap.METHODS];
-visibleMemberMaps[VisibleMemberMap.METHODS]);
+VisibleMemberMap visibleMemberMap =
-}
+visibleMemberMaps[VisibleMemberMap.METHODS];
+addSummary(writer, visibleMemberMap, true, memberSummaryTree);
-/**
+}
-* Build the inherited method summary.
-*/
+/**
-public void buildMethodsInheritedSummary(XMLNode node) {
+* Build the constructor summary.
-buildInheritedSummary(
+*
-memberSummaryWriters[VisibleMemberMap.METHODS],
+* @param node the XML element that specifies which components to document
-visibleMemberMaps[VisibleMemberMap.METHODS]);
+* @param memberSummaryTree the content tree to which the documentation will be added
-}
+*/
+public void buildConstructorsSummary(XMLNode node, Content memberSummaryTree) {
-/**
+MemberSummaryWriter writer =
-* Build the constructor summary.
+memberSummaryWriters[VisibleMemberMap.CONSTRUCTORS];
-*/
+VisibleMemberMap visibleMemberMap =
-public void buildConstructorsSummary(XMLNode node) {
+visibleMemberMaps[VisibleMemberMap.CONSTRUCTORS];
-buildSummary(
+addSummary(writer, visibleMemberMap, false, memberSummaryTree);
-memberSummaryWriters[VisibleMemberMap.CONSTRUCTORS],
+}
-visibleMemberMaps[VisibleMemberMap.CONSTRUCTORS]);
-}
+/**
+* Build the member summary for the given members.
-/**
+*
-* Build the member summary for the given members.
+* @param writer the summary writer to write the output.
-*
+* @param visibleMemberMap the given members to summarize.
-* @param writer           the summary writer to write the output.
+* @param summaryTreeList list of content trees to which the documentation will be added
-* @param visibleMemberMap the given members to summarize.
+*/
-*/
+private void buildSummary(MemberSummaryWriter writer,
-private void buildSummary(MemberSummaryWriter writer,
+VisibleMemberMap visibleMemberMap, LinkedList<Content> summaryTreeList) {
-VisibleMemberMap visibleMemberMap) {
 List<ProgramElementDoc> members = new ArrayList<ProgramElementDoc>(visibleMemberMap.getLeafClassMembers(
 configuration));
 if (members.size() > 0) {
 Collections.sort(members);
-writer.writeMemberSummaryHeader(classDoc);
+Content tableTree = writer.getSummaryTableTree(classDoc);
 for (int i = 0; i < members.size(); i++) {
 ProgramElementDoc member = members.get(i);
 Tag[] firstSentenceTags = member.firstSentenceTags();
 if (member instanceof MethodDoc && firstSentenceTags.length == 0) {
 //Inherit comments from overriden or implemented method if
 //necessary.
 DocFinder.Output inheritedDoc =
 DocFinder.search(new DocFinder.Input((MethodDoc) member));
 if (inheritedDoc.holder != null &&
 inheritedDoc.holder.firstSentenceTags().length > 0) {
 firstSentenceTags = inheritedDoc.holder.firstSentenceTags();
 }
 }
-writer.writeMemberSummary(classDoc, member, firstSentenceTags,
+writer.addMemberSummary(classDoc, member, firstSentenceTags, tableTree, i);
-i == 0, i == members.size() - 1);
+}
-}
+summaryTreeList.add(tableTree);
-writer.writeMemberSummaryFooter(classDoc);
+}
 }
-}
 /**
 * Build the inherited member summary for the given methods.
 *
-* @param writer           the writer for this member summary.
+* @param writer the writer for this member summary.
 * @param visibleMemberMap the map for the members to document.
-*/
+* @param summaryTreeList list of content trees to which the documentation will be added
-private void buildInheritedSummary(MemberSummaryWriter writer,
+*/
-VisibleMemberMap visibleMemberMap) {
+private void buildInheritedSummary(MemberSummaryWriter writer,
+VisibleMemberMap visibleMemberMap, LinkedList<Content> summaryTreeList) {
 for (Iterator<ClassDoc> iter = visibleMemberMap.getVisibleClassesList().iterator();
 iter.hasNext();) {
 ClassDoc inhclass = iter.next();
 if (! (inhclass.isPublic() ||
 Util.isLinkable(inhclass, configuration))) {
 continue;
 }
 if (inhclass == classDoc) {
 continue;
 }
 List<ProgramElementDoc> inhmembers = visibleMemberMap.getMembersFor(inhclass);
 if (inhmembers.size() > 0) {
 Collections.sort(inhmembers);
-writer.writeInheritedMemberSummaryHeader(inhclass);
+Content inheritedTree = writer.getInheritedSummaryHeader(inhclass);
+Content linksTree = writer.getInheritedSummaryLinksTree();
 for (int j = 0; j < inhmembers.size(); ++j) {
-writer.writeInheritedMemberSummary(
+writer.addInheritedMemberSummary(
 inhclass.isPackagePrivate() &&
 ! Util.isLinkable(inhclass, configuration) ?
 classDoc : inhclass,
 inhmembers.get(j),
 j == 0,
-j == inhmembers.size() - 1);
+j == inhmembers.size() - 1, linksTree);
 }
-writer.writeInheritedMemberSummaryFooter(inhclass);
+inheritedTree.addContent(linksTree);
-}
+summaryTreeList.add(writer.getMemberTree(inheritedTree));
+}
+}
+}
+/**
+* Add the summary for the documentation.
+*
+* @param writer the writer for this member summary.
+* @param visibleMemberMap the map for the members to document.
+* @param showInheritedSummary true if inherited summary should be documented
+* @param memberSummaryTree the content tree to which the documentation will be added
+*/
+private void addSummary(MemberSummaryWriter writer,
+VisibleMemberMap visibleMemberMap, boolean showInheritedSummary,
+Content memberSummaryTree) {
+LinkedList<Content> summaryTreeList = new LinkedList<Content>();
+buildSummary(writer, visibleMemberMap, summaryTreeList);
+if (showInheritedSummary)
+buildInheritedSummary(writer, visibleMemberMap, summaryTreeList);
+if (!summaryTreeList.isEmpty()) {
+Content memberTree = writer.getMemberSummaryHeader(
+classDoc, memberSummaryTree);
+for (int i = 0; i < summaryTreeList.size(); i++) {
+memberTree.addContent(summaryTreeList.get(i));
+}
+memberSummaryTree.addContent(writer.getMemberTree(memberTree));
 }
 }
 }

changeset 7614	cfadc977ca75
parent 5855	00d9c252e60c
child 7681	1f0819a3341f