jdk8-mips64-public/langtools: comparison src/share/classes/com/sun/tools/doclets/internal/toolkit/builders/FieldBuilder.java

-:bcbc86cc5b31
+:90af8d87741f
 * 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 documentation for a field.
 *
 * 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 FieldBuilder extends AbstractMemberBuilder {
 /**
 * The class whose fields are being documented.
 */
 private ClassDoc classDoc;
 /**
 * The visible fields for the given class.
 */
 private VisibleMemberMap visibleMemberMap;
 /**
 * The writer to output the field documentation.
 */
 private FieldWriter writer;
 /**
 * The list of fields being documented.
 */
 private List<ProgramElementDoc> fields;
 /**
 * The index of the current field that is being documented at this point
 * in time.
 */
 private int currentFieldIndex;
 /**
 * Construct a new FieldBuilder.
 *
 * @param configuration the current configuration of the
 *                      doclet.
 */
 private FieldBuilder(Configuration configuration) {
 super(configuration);
 }
 /**
 * Construct a new FieldBuilder.
 *
 * @param configuration the current configuration of the doclet.
 * @param classDoc the class whoses members are being documented.
 * @param writer the doclet specific writer.
 */
 public static FieldBuilder getInstance(
 Configuration configuration,
 ClassDoc classDoc,
 FieldWriter writer) {
 FieldBuilder builder = new FieldBuilder(configuration);
 builder.classDoc = classDoc;
 builder.writer = writer;
 builder.visibleMemberMap =
 new VisibleMemberMap(
 classDoc,
 VisibleMemberMap.FIELDS,
 configuration.nodeprecated);
 builder.fields =
 new ArrayList<ProgramElementDoc>(builder.visibleMemberMap.getLeafClassMembers(
 configuration));
 if (configuration.getMemberComparator() != null) {
 Collections.sort(
 builder.fields,
 configuration.getMemberComparator());
 }
 return builder;
 }
 /**
 * {@inheritDoc}
 */
 public String getName() {
 return "FieldDetails";
 }
 /**
 * Returns a list of fields 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.
 * @return a list of fields that will be documented.
 */
 public List<ProgramElementDoc> members(ClassDoc classDoc) {
 return visibleMemberMap.getMembersFor(classDoc);
 }
 /**
 * Returns the visible member map for the fields of this class.
 *
 * @return the visible member map for the fields of this class.
 */
 public VisibleMemberMap getVisibleMemberMap() {
 return visibleMemberMap;
 }
 /**
 * summaryOrder.size()
 */
 public boolean hasMembersToDocument() {
 return fields.size() > 0;
 }
 /**
 * Build the field documentation.
 *
-* @param elements the XML elements that specify how to construct this
+* @param node the XML element that specifies which components to document
-*                documentation.
+* @param memberDetailsTree the content tree to which the documentation will be added
 */
-public void buildFieldDoc(XMLNode node) {
+public void buildFieldDoc(XMLNode node, Content memberDetailsTree) {
 if (writer == null) {
 return;
 }
-for (currentFieldIndex = 0;
+int size = fields.size();
-currentFieldIndex < fields.size();
+if (size > 0) {
-currentFieldIndex++) {
+Content fieldDetailsTree = writer.getFieldDetailsTreeHeader(
-buildChildren(node);
+classDoc, memberDetailsTree);
-}
+for (currentFieldIndex = 0; currentFieldIndex < size;
-}
+currentFieldIndex++) {
+Content fieldDocTree = writer.getFieldDocTreeHeader(
-/**
-* Build the overall header.
-*/
-public void buildHeader(XMLNode node) {
-writer.writeHeader(
-classDoc,
-configuration.getText("doclet.Field_Detail"));
-}
-/**
-* Build the header for the individual field.
-*/
-public void buildFieldHeader(XMLNode node) {
-writer.writeFieldHeader(
 (FieldDoc) fields.get(currentFieldIndex),
-currentFieldIndex == 0);
+fieldDetailsTree);
-}
+buildChildren(node, fieldDocTree);
+fieldDetailsTree.addContent(writer.getFieldDoc(
-/**
+fieldDocTree, (currentFieldIndex == size - 1)));
-* Build the signature.
+}
-*/
+memberDetailsTree.addContent(
-public void buildSignature(XMLNode node) {
+writer.getFieldDetails(fieldDetailsTree));
-writer.writeSignature((FieldDoc) fields.get(currentFieldIndex));
+}
 }
 /**
-* Build the deprecation information.
+* Build the signature.
-*/
+*
-public void buildDeprecationInfo(XMLNode node) {
+* @param node the XML element that specifies which components to document
-writer.writeDeprecated((FieldDoc) fields.get(currentFieldIndex));
+* @param fieldDocTree the content tree to which the documentation will be added
-}
+*/
+public void buildSignature(XMLNode node, Content fieldDocTree) {
-/**
+fieldDocTree.addContent(
-* Build the comments for the field.  Do nothing if
+writer.getSignature((FieldDoc) fields.get(currentFieldIndex)));
-* {@link Configuration#nocomment} is set to true.
+}
-*/
-public void buildFieldComments(XMLNode node) {
+/**
-if (!configuration.nocomment) {
+* Build the deprecation information.
-writer.writeComments((FieldDoc) fields.get(currentFieldIndex));
+*
-}
+* @param node the XML element that specifies which components to document
-}
+* @param fieldDocTree the content tree to which the documentation will be added
+*/
-/**
+public void buildDeprecationInfo(XMLNode node, Content fieldDocTree) {
-* Build the tag information.
+writer.addDeprecated(
-*/
+(FieldDoc) fields.get(currentFieldIndex), fieldDocTree);
-public void buildTagInfo(XMLNode node) {
+}
-writer.writeTags((FieldDoc) fields.get(currentFieldIndex));
-}
+/**
+* Build the comments for the field.  Do nothing if
-/**
+* {@link Configuration#nocomment} is set to true.
-* Build the footer for the individual field.
+*
-*/
+* @param node the XML element that specifies which components to document
-public void buildFieldFooter(XMLNode node) {
+* @param fieldDocTree the content tree to which the documentation will be added
-writer.writeFieldFooter();
+*/
-}
+public void buildFieldComments(XMLNode node, Content fieldDocTree) {
+if (!configuration.nocomment) {
-/**
+writer.addComments((FieldDoc) fields.get(currentFieldIndex), fieldDocTree);
-* Build the overall footer.
+}
-*/
+}
-public void buildFooter(XMLNode node) {
-writer.writeFooter(classDoc);
+/**
-}
+* Build the tag information.
+*
-/**
+* @param node the XML element that specifies which components to document
-* Return the field writer for this builder.
+* @param fieldDocTree the content tree to which the documentation will be added
-*
+*/
-* @return the field writer for this builder.
+public void buildTagInfo(XMLNode node, Content fieldDocTree) {
-*/
+writer.addTags((FieldDoc) fields.get(currentFieldIndex), fieldDocTree);
-public FieldWriter getWriter() {
+}
-return writer;
-}
+/**
+* Return the field writer for this builder.
+*
+* @return the field writer for this builder.
+*/
+public FieldWriter getWriter() {
+return writer;
+}
 }

Mercurial > jdk8-mips64-public > langtools / file comparison

comparison: src/share/classes/com/sun/tools/doclets/internal/toolkit/builders/FieldBuilder.java

src/share/classes/com/sun/tools/doclets/internal/toolkit/builders/FieldBuilder.java