duke@1: /*
jjg@1357:  * Copyright (c) 2003, 2012, Oracle and/or its affiliates. All rights reserved.
duke@1:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1:  *
duke@1:  * This code is free software; you can redistribute it and/or modify it
duke@1:  * under the terms of the GNU General Public License version 2 only, as
ohair@554:  * published by the Free Software Foundation.  Oracle designates this
duke@1:  * particular file as subject to the "Classpath" exception as provided
ohair@554:  * by Oracle in the LICENSE file that accompanied this code.
duke@1:  *
duke@1:  * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
duke@1:  * version 2 for more details (a copy is included in the LICENSE file that
duke@1:  * accompanied this code).
duke@1:  *
duke@1:  * You should have received a copy of the GNU General Public License version
duke@1:  * 2 along with this work; if not, write to the Free Software Foundation,
duke@1:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1:  *
ohair@554:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@554:  * or visit www.oracle.com if you need additional information or have any
ohair@554:  * questions.
duke@1:  */
duke@1: 
duke@1: package com.sun.tools.doclets.internal.toolkit.builders;
duke@1: 
bpatel@766: import java.util.*;
jjg@1357: 
jjg@1357: import com.sun.javadoc.*;
jjg@1357: import com.sun.tools.doclets.internal.toolkit.*;
duke@1: import com.sun.tools.doclets.internal.toolkit.util.*;
duke@1: 
duke@1: /**
duke@1:  * Builds documentation for a field.
duke@1:  *
jjg@1359:  *  <p><b>This is NOT part of any supported API.
jjg@1359:  *  If you write code that depends on this, you do so at your own risk.
jjg@1359:  *  This code and its internal interfaces are subject to change or
jjg@1359:  *  deletion without notice.</b>
duke@1:  *
duke@1:  * @author Jamie Ho
bpatel@766:  * @author Bhavesh Patel (Modified)
duke@1:  * @since 1.5
duke@1:  */
duke@1: public class FieldBuilder extends AbstractMemberBuilder {
duke@1: 
bpatel@766:     /**
bpatel@766:      * The class whose fields are being documented.
bpatel@766:      */
jjg@1410:     private final ClassDoc classDoc;
duke@1: 
bpatel@766:     /**
bpatel@766:      * The visible fields for the given class.
bpatel@766:      */
jjg@1410:     private final VisibleMemberMap visibleMemberMap;
duke@1: 
bpatel@766:     /**
bpatel@766:      * The writer to output the field documentation.
bpatel@766:      */
jjg@1410:     private final FieldWriter writer;
duke@1: 
bpatel@766:     /**
bpatel@766:      * The list of fields being documented.
bpatel@766:      */
jjg@1410:     private final List<ProgramElementDoc> fields;
duke@1: 
bpatel@766:     /**
bpatel@766:      * The index of the current field that is being documented at this point
bpatel@766:      * in time.
bpatel@766:      */
bpatel@766:     private int currentFieldIndex;
duke@1: 
bpatel@766:     /**
bpatel@766:      * Construct a new FieldBuilder.
bpatel@766:      *
jjg@1410:      * @param context  the build context.
jjg@1410:      * @param classDoc the class whoses members are being documented.
jjg@1410:      * @param writer the doclet specific writer.
bpatel@766:      */
jjg@1410:     private FieldBuilder(Context context,
jjg@1410:             ClassDoc classDoc,
jjg@1410:             FieldWriter writer) {
jjg@1410:         super(context);
jjg@1410:         this.classDoc = classDoc;
jjg@1410:         this.writer = writer;
jjg@1410:         visibleMemberMap =
jjg@1410:                 new VisibleMemberMap(
jjg@1410:                 classDoc,
jjg@1410:                 VisibleMemberMap.FIELDS,
jjg@1410:                 configuration.nodeprecated);
jjg@1410:         fields =
jjg@1410:                 new ArrayList<ProgramElementDoc>(visibleMemberMap.getLeafClassMembers(
jjg@1410:                 configuration));
jjg@1410:         if (configuration.getMemberComparator() != null) {
jjg@1410:             Collections.sort(fields, configuration.getMemberComparator());
jjg@1410:         }
bpatel@766:     }
bpatel@766: 
bpatel@766:     /**
bpatel@766:      * Construct a new FieldBuilder.
bpatel@766:      *
jjg@1410:      * @param context  the build context.
bpatel@766:      * @param classDoc the class whoses members are being documented.
bpatel@766:      * @param writer the doclet specific writer.
bpatel@766:      */
jjg@1410:     public static FieldBuilder getInstance(Context context,
bpatel@766:             ClassDoc classDoc,
bpatel@766:             FieldWriter writer) {
jjg@1410:         return new FieldBuilder(context, classDoc, writer);
bpatel@766:     }
duke@1: 
bpatel@766:     /**
bpatel@766:      * {@inheritDoc}
bpatel@766:      */
bpatel@766:     public String getName() {
bpatel@766:         return "FieldDetails";
bpatel@766:     }
bpatel@766: 
bpatel@766:     /**
bpatel@766:      * Returns a list of fields that will be documented for the given class.
bpatel@766:      * This information can be used for doclet specific documentation
bpatel@766:      * generation.
bpatel@766:      *
bpatel@766:      * @param classDoc the {@link ClassDoc} we want to check.
bpatel@766:      * @return a list of fields that will be documented.
bpatel@766:      */
bpatel@766:     public List<ProgramElementDoc> members(ClassDoc classDoc) {
bpatel@766:         return visibleMemberMap.getMembersFor(classDoc);
bpatel@766:     }
bpatel@766: 
bpatel@766:     /**
bpatel@766:      * Returns the visible member map for the fields of this class.
bpatel@766:      *
bpatel@766:      * @return the visible member map for the fields of this class.
bpatel@766:      */
bpatel@766:     public VisibleMemberMap getVisibleMemberMap() {
bpatel@766:         return visibleMemberMap;
bpatel@766:     }
bpatel@766: 
bpatel@766:     /**
bpatel@766:      * summaryOrder.size()
bpatel@766:      */
bpatel@766:     public boolean hasMembersToDocument() {
bpatel@766:         return fields.size() > 0;
bpatel@766:     }
bpatel@766: 
bpatel@766:     /**
bpatel@766:      * Build the field documentation.
bpatel@766:      *
bpatel@766:      * @param node the XML element that specifies which components to document
bpatel@766:      * @param memberDetailsTree the content tree to which the documentation will be added
bpatel@766:      */
bpatel@766:     public void buildFieldDoc(XMLNode node, Content memberDetailsTree) {
bpatel@766:         if (writer == null) {
bpatel@766:             return;
duke@1:         }
bpatel@766:         int size = fields.size();
bpatel@766:         if (size > 0) {
bpatel@766:             Content fieldDetailsTree = writer.getFieldDetailsTreeHeader(
bpatel@766:                     classDoc, memberDetailsTree);
bpatel@766:             for (currentFieldIndex = 0; currentFieldIndex < size;
bpatel@766:                     currentFieldIndex++) {
bpatel@766:                 Content fieldDocTree = writer.getFieldDocTreeHeader(
bpatel@766:                         (FieldDoc) fields.get(currentFieldIndex),
bpatel@766:                         fieldDetailsTree);
bpatel@766:                 buildChildren(node, fieldDocTree);
bpatel@766:                 fieldDetailsTree.addContent(writer.getFieldDoc(
bpatel@766:                         fieldDocTree, (currentFieldIndex == size - 1)));
bpatel@766:             }
bpatel@766:             memberDetailsTree.addContent(
bpatel@766:                     writer.getFieldDetails(fieldDetailsTree));
bpatel@766:         }
bpatel@766:     }
duke@1: 
bpatel@766:     /**
bpatel@766:      * Build the signature.
bpatel@766:      *
bpatel@766:      * @param node the XML element that specifies which components to document
bpatel@766:      * @param fieldDocTree the content tree to which the documentation will be added
bpatel@766:      */
bpatel@766:     public void buildSignature(XMLNode node, Content fieldDocTree) {
bpatel@766:         fieldDocTree.addContent(
bpatel@766:                 writer.getSignature((FieldDoc) fields.get(currentFieldIndex)));
bpatel@766:     }
bpatel@766: 
bpatel@766:     /**
bpatel@766:      * Build the deprecation information.
bpatel@766:      *
bpatel@766:      * @param node the XML element that specifies which components to document
bpatel@766:      * @param fieldDocTree the content tree to which the documentation will be added
bpatel@766:      */
bpatel@766:     public void buildDeprecationInfo(XMLNode node, Content fieldDocTree) {
bpatel@766:         writer.addDeprecated(
bpatel@766:                 (FieldDoc) fields.get(currentFieldIndex), fieldDocTree);
bpatel@766:     }
bpatel@766: 
bpatel@766:     /**
bpatel@766:      * Build the comments for the field.  Do nothing if
bpatel@766:      * {@link Configuration#nocomment} is set to true.
bpatel@766:      *
bpatel@766:      * @param node the XML element that specifies which components to document
bpatel@766:      * @param fieldDocTree the content tree to which the documentation will be added
bpatel@766:      */
bpatel@766:     public void buildFieldComments(XMLNode node, Content fieldDocTree) {
bpatel@766:         if (!configuration.nocomment) {
bpatel@766:             writer.addComments((FieldDoc) fields.get(currentFieldIndex), fieldDocTree);
duke@1:         }
bpatel@766:     }
duke@1: 
bpatel@766:     /**
bpatel@766:      * Build the tag information.
bpatel@766:      *
bpatel@766:      * @param node the XML element that specifies which components to document
bpatel@766:      * @param fieldDocTree the content tree to which the documentation will be added
bpatel@766:      */
bpatel@766:     public void buildTagInfo(XMLNode node, Content fieldDocTree) {
bpatel@766:         writer.addTags((FieldDoc) fields.get(currentFieldIndex), fieldDocTree);
bpatel@766:     }
duke@1: 
bpatel@766:     /**
bpatel@766:      * Return the field writer for this builder.
bpatel@766:      *
bpatel@766:      * @return the field writer for this builder.
bpatel@766:      */
bpatel@766:     public FieldWriter getWriter() {
bpatel@766:         return writer;
bpatel@766:     }
duke@1: }