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 required annotation type members.
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 AnnotationTypeRequiredMemberBuilder extends AbstractMemberBuilder {
duke@1: 
duke@1:     /**
duke@1:      * The annotation type whose members are being documented.
duke@1:      */
duke@1:     protected ClassDoc classDoc;
duke@1: 
duke@1:     /**
duke@1:      * The visible members for the given class.
duke@1:      */
duke@1:     protected VisibleMemberMap visibleMemberMap;
duke@1: 
duke@1:     /**
duke@1:      * The writer to output the member documentation.
duke@1:      */
duke@1:     protected AnnotationTypeRequiredMemberWriter writer;
duke@1: 
duke@1:     /**
duke@1:      * The list of members being documented.
duke@1:      */
jjg@74:     protected List<ProgramElementDoc> members;
duke@1: 
duke@1:     /**
duke@1:      * The index of the current member that is being documented at this point
duke@1:      * in time.
duke@1:      */
duke@1:     protected int currentMemberIndex;
duke@1: 
duke@1:     /**
duke@1:      * Construct a new AnnotationTypeRequiredMemberBuilder.
duke@1:      *
jjg@1410:      * @param context  the build context.
jjg@1410:      * @param classDoc the class whose members are being documented.
jjg@1410:      * @param writer the doclet specific writer.
duke@1:      */
jjg@1410:     protected AnnotationTypeRequiredMemberBuilder(Context context,
jjg@1410:             ClassDoc classDoc,
jjg@1410:             AnnotationTypeRequiredMemberWriter writer,
jjg@1410:             int memberType) {
jjg@1410:         super(context);
jjg@1410:         this.classDoc = classDoc;
jjg@1410:         this.writer = writer;
jjg@1410:         this.visibleMemberMap = new VisibleMemberMap(classDoc, memberType,
jjg@1410:             configuration.nodeprecated);
jjg@1410:         this.members = new ArrayList<ProgramElementDoc>(
jjg@1410:             this.visibleMemberMap.getMembersFor(classDoc));
jjg@1410:         if (configuration.getMemberComparator() != null) {
jjg@1410:             Collections.sort(this.members, configuration.getMemberComparator());
jjg@1410:         }
duke@1:     }
duke@1: 
duke@1: 
duke@1:     /**
duke@1:      * Construct a new AnnotationTypeMemberBuilder.
duke@1:      *
jjg@1410:      * @param context  the build context.
jjg@1410:      * @param classDoc the class whose members are being documented.
duke@1:      * @param writer the doclet specific writer.
duke@1:      */
duke@1:     public static AnnotationTypeRequiredMemberBuilder getInstance(
jjg@1410:             Context context, ClassDoc classDoc,
duke@1:             AnnotationTypeRequiredMemberWriter writer) {
jjg@1410:         return new AnnotationTypeRequiredMemberBuilder(context, classDoc,
jjg@1410:                     writer,
jjg@1410:                     VisibleMemberMap.ANNOTATION_TYPE_MEMBER_REQUIRED);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * {@inheritDoc}
duke@1:      */
duke@1:     public String getName() {
duke@1:         return "AnnotationTypeRequiredMemberDetails";
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Returns a list of members that will be documented for the given class.
duke@1:      * This information can be used for doclet specific documentation
duke@1:      * generation.
duke@1:      *
duke@1:      * @param classDoc the {@link ClassDoc} we want to check.
duke@1:      * @return a list of members that will be documented.
duke@1:      */
mcimadamore@184:     public List<ProgramElementDoc> members(ClassDoc classDoc) {
duke@1:         return visibleMemberMap.getMembersFor(classDoc);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Returns the visible member map for the members of this class.
duke@1:      *
duke@1:      * @return the visible member map for the members of this class.
duke@1:      */
duke@1:     public VisibleMemberMap getVisibleMemberMap() {
duke@1:         return visibleMemberMap;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * summaryOrder.size()
duke@1:      */
duke@1:     public boolean hasMembersToDocument() {
duke@1:         return members.size() > 0;
duke@1:     }
duke@1: 
duke@1:     /**
bpatel@766:      * Build the annotation type required member 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 buildAnnotationTypeRequiredMember(XMLNode node, Content memberDetailsTree) {
bpatel@766:         buildAnnotationTypeMember(node, memberDetailsTree);
bpatel@766:     }
bpatel@766: 
bpatel@766:     /**
duke@1:      * Build the member documentation.
duke@1:      *
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
duke@1:      */
bpatel@766:     public void buildAnnotationTypeMember(XMLNode node, Content memberDetailsTree) {
duke@1:         if (writer == null) {
duke@1:             return;
duke@1:         }
bpatel@766:         int size = members.size();
bpatel@766:         if (size > 0) {
bpatel@766:             writer.addAnnotationDetailsTreeHeader(
bpatel@766:                     classDoc, memberDetailsTree);
bpatel@766:             for (currentMemberIndex = 0; currentMemberIndex < size;
duke@1:             currentMemberIndex++) {
bpatel@766:                 Content annotationDocTree = writer.getAnnotationDocTreeHeader(
bpatel@766:                         (MemberDoc) members.get(currentMemberIndex),
bpatel@766:                         memberDetailsTree);
bpatel@766:                 buildChildren(node, annotationDocTree);
bpatel@766:                 memberDetailsTree.addContent(writer.getAnnotationDoc(
bpatel@766:                         annotationDocTree, (currentMemberIndex == size - 1)));
bpatel@766:             }
duke@1:         }
duke@1:     }
duke@1: 
duke@1:     /**
bpatel@766:      * Build the signature.
bpatel@766:      *
bpatel@766:      * @param node the XML element that specifies which components to document
bpatel@766:      * @param annotationDocTree the content tree to which the documentation will be added
duke@1:      */
bpatel@766:     public void buildSignature(XMLNode node, Content annotationDocTree) {
bpatel@766:         annotationDocTree.addContent(
bpatel@766:                 writer.getSignature((MemberDoc) members.get(currentMemberIndex)));
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Build the deprecation information.
bpatel@766:      *
bpatel@766:      * @param node the XML element that specifies which components to document
bpatel@766:      * @param annotationDocTree the content tree to which the documentation will be added
duke@1:      */
bpatel@766:     public void buildDeprecationInfo(XMLNode node, Content annotationDocTree) {
bpatel@766:         writer.addDeprecated((MemberDoc) members.get(currentMemberIndex),
bpatel@766:                 annotationDocTree);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Build the comments for the member.  Do nothing if
duke@1:      * {@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 annotationDocTree the content tree to which the documentation will be added
duke@1:      */
bpatel@766:     public void buildMemberComments(XMLNode node, Content annotationDocTree) {
duke@1:         if(! configuration.nocomment){
bpatel@766:             writer.addComments((MemberDoc) members.get(currentMemberIndex),
bpatel@766:                     annotationDocTree);
duke@1:         }
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Build the tag information.
bpatel@766:      *
bpatel@766:      * @param node the XML element that specifies which components to document
bpatel@766:      * @param annotationDocTree the content tree to which the documentation will be added
duke@1:      */
bpatel@766:     public void buildTagInfo(XMLNode node, Content annotationDocTree) {
bpatel@766:         writer.addTags((MemberDoc) members.get(currentMemberIndex),
bpatel@766:                 annotationDocTree);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Return the annotation type required member writer for this builder.
duke@1:      *
duke@1:      * @return the annotation type required member constant writer for this
duke@1:      * builder.
duke@1:      */
duke@1:     public AnnotationTypeRequiredMemberWriter getWriter() {
duke@1:         return writer;
duke@1:     }
duke@1: }