jdk8-mips64-public/langtools: src/share/classes/com/sun/tools/doclets/internal/toolkit/builders/AnnotationTypeRequiredMemberBuilder.java@b980e8e6aabf

     1 /*

     2  * Copyright (c) 2003, 2012, Oracle and/or its affiliates. All rights reserved.

     3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

     4  *

     5  * This code is free software; you can redistribute it and/or modify it

     6  * under the terms of the GNU General Public License version 2 only, as

     7  * published by the Free Software Foundation.  Oracle designates this

     8  * particular file as subject to the "Classpath" exception as provided

     9  * by Oracle in the LICENSE file that accompanied this code.

    10  *

    11  * This code is distributed in the hope that it will be useful, but WITHOUT

    12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

    13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

    14  * version 2 for more details (a copy is included in the LICENSE file that

    15  * accompanied this code).

    16  *

    17  * You should have received a copy of the GNU General Public License version

    18  * 2 along with this work; if not, write to the Free Software Foundation,

    19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

    20  *

    21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

    22  * or visit www.oracle.com if you need additional information or have any

    23  * questions.

    24  */

    26 package com.sun.tools.doclets.internal.toolkit.builders;

    28 import java.util.*;

    30 import com.sun.javadoc.*;

    31 import com.sun.tools.doclets.internal.toolkit.*;

    32 import com.sun.tools.doclets.internal.toolkit.util.*;

    34 /**

    35  * Builds documentation for required annotation type members.

    36  *

    37  *  <p><b>This is NOT part of any supported API.

    38  *  If you write code that depends on this, you do so at your own risk.

    39  *  This code and its internal interfaces are subject to change or

    40  *  deletion without notice.</b>

    41  *

    42  * @author Jamie Ho

    43  * @author Bhavesh Patel (Modified)

    44  * @since 1.5

    45  */

    46 public class AnnotationTypeRequiredMemberBuilder extends AbstractMemberBuilder {

    48     /**

    49      * The annotation type whose members are being documented.

    50      */

    51     protected ClassDoc classDoc;

    53     /**

    54      * The visible members for the given class.

    55      */

    56     protected VisibleMemberMap visibleMemberMap;

    58     /**

    59      * The writer to output the member documentation.

    60      */

    61     protected AnnotationTypeRequiredMemberWriter writer;

    63     /**

    64      * The list of members being documented.

    65      */

    66     protected List<ProgramElementDoc> members;

    68     /**

    69      * The index of the current member that is being documented at this point

    70      * in time.

    71      */

    72     protected int currentMemberIndex;

    74     /**

    75      * Construct a new AnnotationTypeRequiredMemberBuilder.

    76      *

    77      * @param configuration the current configuration of the

    78      *                      doclet.

    79      */

    80     protected AnnotationTypeRequiredMemberBuilder(Configuration configuration) {

    81         super(configuration);

    82     }

    85     /**

    86      * Construct a new AnnotationTypeMemberBuilder.

    87      *

    88      * @param configuration the current configuration of the doclet.

    89      * @param classDoc the class whoses members are being documented.

    90      * @param writer the doclet specific writer.

    91      */

    92     public static AnnotationTypeRequiredMemberBuilder getInstance(

    93             Configuration configuration, ClassDoc classDoc,

    94             AnnotationTypeRequiredMemberWriter writer) {

    95         AnnotationTypeRequiredMemberBuilder builder =

    96             new AnnotationTypeRequiredMemberBuilder(configuration);

    97         builder.classDoc = classDoc;

    98         builder.writer = writer;

    99         builder.visibleMemberMap = new VisibleMemberMap(classDoc,

   100             VisibleMemberMap.ANNOTATION_TYPE_MEMBER_REQUIRED, configuration.nodeprecated);

   101         builder.members = new ArrayList<ProgramElementDoc>(

   102             builder.visibleMemberMap.getMembersFor(classDoc));

   103         if (configuration.getMemberComparator() != null) {

   104             Collections.sort(builder.members,

   105                 configuration.getMemberComparator());

   106         }

   107         return builder;

   108     }

   110     /**

   111      * {@inheritDoc}

   112      */

   113     public String getName() {

   114         return "AnnotationTypeRequiredMemberDetails";

   115     }

   117     /**

   118      * Returns a list of members that will be documented for the given class.

   119      * This information can be used for doclet specific documentation

   120      * generation.

   121      *

   122      * @param classDoc the {@link ClassDoc} we want to check.

   123      * @return a list of members that will be documented.

   124      */

   125     public List<ProgramElementDoc> members(ClassDoc classDoc) {

   126         return visibleMemberMap.getMembersFor(classDoc);

   127     }

   129     /**

   130      * Returns the visible member map for the members of this class.

   131      *

   132      * @return the visible member map for the members of this class.

   133      */

   134     public VisibleMemberMap getVisibleMemberMap() {

   135         return visibleMemberMap;

   136     }

   138     /**

   139      * summaryOrder.size()

   140      */

   141     public boolean hasMembersToDocument() {

   142         return members.size() > 0;

   143     }

   145     /**

   146      * Build the annotation type required member documentation.

   147      *

   148      * @param node the XML element that specifies which components to document

   149      * @param memberDetailsTree the content tree to which the documentation will be added

   150      */

   151     public void buildAnnotationTypeRequiredMember(XMLNode node, Content memberDetailsTree) {

   152         buildAnnotationTypeMember(node, memberDetailsTree);

   153     }

   155     /**

   156      * Build the member documentation.

   157      *

   158      * @param node the XML element that specifies which components to document

   159      * @param memberDetailsTree the content tree to which the documentation will be added

   160      */

   161     public void buildAnnotationTypeMember(XMLNode node, Content memberDetailsTree) {

   162         if (writer == null) {

   163             return;

   164         }

   165         int size = members.size();

   166         if (size > 0) {

   167             writer.addAnnotationDetailsTreeHeader(

   168                     classDoc, memberDetailsTree);

   169             for (currentMemberIndex = 0; currentMemberIndex < size;

   170             currentMemberIndex++) {

   171                 Content annotationDocTree = writer.getAnnotationDocTreeHeader(

   172                         (MemberDoc) members.get(currentMemberIndex),

   173                         memberDetailsTree);

   174                 buildChildren(node, annotationDocTree);

   175                 memberDetailsTree.addContent(writer.getAnnotationDoc(

   176                         annotationDocTree, (currentMemberIndex == size - 1)));

   177             }

   178         }

   179     }

   181     /**

   182      * Build the signature.

   183      *

   184      * @param node the XML element that specifies which components to document

   185      * @param annotationDocTree the content tree to which the documentation will be added

   186      */

   187     public void buildSignature(XMLNode node, Content annotationDocTree) {

   188         annotationDocTree.addContent(

   189                 writer.getSignature((MemberDoc) members.get(currentMemberIndex)));

   190     }

   192     /**

   193      * Build the deprecation information.

   194      *

   195      * @param node the XML element that specifies which components to document

   196      * @param annotationDocTree the content tree to which the documentation will be added

   197      */

   198     public void buildDeprecationInfo(XMLNode node, Content annotationDocTree) {

   199         writer.addDeprecated((MemberDoc) members.get(currentMemberIndex),

   200                 annotationDocTree);

   201     }

   203     /**

   204      * Build the comments for the member.  Do nothing if

   205      * {@link Configuration#nocomment} is set to true.

   206      *

   207      * @param node the XML element that specifies which components to document

   208      * @param annotationDocTree the content tree to which the documentation will be added

   209      */

   210     public void buildMemberComments(XMLNode node, Content annotationDocTree) {

   211         if(! configuration.nocomment){

   212             writer.addComments((MemberDoc) members.get(currentMemberIndex),

   213                     annotationDocTree);

   214         }

   215     }

   217     /**

   218      * Build the tag information.

   219      *

   220      * @param node the XML element that specifies which components to document

   221      * @param annotationDocTree the content tree to which the documentation will be added

   222      */

   223     public void buildTagInfo(XMLNode node, Content annotationDocTree) {

   224         writer.addTags((MemberDoc) members.get(currentMemberIndex),

   225                 annotationDocTree);

   226     }

   228     /**

   229      * Return the annotation type required member writer for this builder.

   230      *

   231      * @return the annotation type required member constant writer for this

   232      * builder.

   233      */

   234     public AnnotationTypeRequiredMemberWriter getWriter() {

   235         return writer;

   236     }

   237 }

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

src/share/classes/com/sun/tools/doclets/internal/toolkit/builders/AnnotationTypeRequiredMemberBuilder.java@b980e8e6aabf

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