jdk8-mips64-public/langtools: src/share/classes/com/sun/tools/doclets/internal/toolkit/builders/AnnotationTypeRequiredMemberBuilder.java@90af8d87741f (annotated)

src/share/classes/com/sun/tools/doclets/internal/toolkit/builders/AnnotationTypeRequiredMemberBuilder.java@90af8d87741f (annotated)

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

Wed, 01 Dec 2010 11:02:38 -0800

author: bpatel
date: Wed, 01 Dec 2010 11:02:38 -0800
changeset 766: 90af8d87741f
parent 589: 4177f5bdd189
child 798: 4868a36f6fd8
permissions: -rw-r--r--

6851834: Javadoc doclet needs a structured approach to generate the output HTML.
Reviewed-by: jjg

 /*
  * Copyright (c) 2003, 2008, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
  * under the terms of the GNU General Public License version 2 only, as
  * published by the Free Software Foundation.  Oracle designates this
  * particular file as subject to the "Classpath" exception as provided
  * by Oracle in the LICENSE file that accompanied this code.
  *
  * This code is distributed in the hope that it will be useful, but WITHOUT
  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  * version 2 for more details (a copy is included in the LICENSE file that
  * accompanied this code).
  *
  * You should have received a copy of the GNU General Public License version
  * 2 along with this work; if not, write to the Free Software Foundation,
  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  *
  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  * or visit www.oracle.com if you need additional information or have any
  * 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.*;
 /**
  * Builds documentation for required annotation type members.
  *
  * 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 AnnotationTypeRequiredMemberBuilder extends AbstractMemberBuilder {
     /**
      * The annotation type whose members are being documented.
      */
     protected ClassDoc classDoc;
     /**
      * The visible members for the given class.
      */
     protected VisibleMemberMap visibleMemberMap;
     /**
      * The writer to output the member documentation.
      */
     protected AnnotationTypeRequiredMemberWriter writer;
     /**
      * The list of members being documented.
      */
     protected List<ProgramElementDoc> members;
     /**
      * The index of the current member that is being documented at this point
      * in time.
      */
     protected int currentMemberIndex;
     /**
      * Construct a new AnnotationTypeRequiredMemberBuilder.
      *
      * @param configuration the current configuration of the
      *                      doclet.
      */
     protected AnnotationTypeRequiredMemberBuilder(Configuration configuration) {
         super(configuration);
     }
     /**
      * Construct a new AnnotationTypeMemberBuilder.
      *
      * @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 AnnotationTypeRequiredMemberBuilder getInstance(
             Configuration configuration, ClassDoc classDoc,
             AnnotationTypeRequiredMemberWriter writer) {
         AnnotationTypeRequiredMemberBuilder builder =
             new AnnotationTypeRequiredMemberBuilder(configuration);
         builder.classDoc = classDoc;
         builder.writer = writer;
         builder.visibleMemberMap = new VisibleMemberMap(classDoc,
             VisibleMemberMap.ANNOTATION_TYPE_MEMBER_REQUIRED, configuration.nodeprecated);
         builder.members = new ArrayList<ProgramElementDoc>(
             builder.visibleMemberMap.getMembersFor(classDoc));
         if (configuration.getMemberComparator() != null) {
             Collections.sort(builder.members,
                 configuration.getMemberComparator());
         }
         return builder;
     }
     /**
      * {@inheritDoc}
      */
     public String getName() {
         return "AnnotationTypeRequiredMemberDetails";
     }
     /**
      * Returns a list of members 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 members that will be documented.
      */
     public List<ProgramElementDoc> members(ClassDoc classDoc) {
         return visibleMemberMap.getMembersFor(classDoc);
     }
     /**
      * Returns the visible member map for the members of this class.
      *
      * @return the visible member map for the members of this class.
      */
     public VisibleMemberMap getVisibleMemberMap() {
         return visibleMemberMap;
     }
     /**
      * summaryOrder.size()
      */
     public boolean hasMembersToDocument() {
         return members.size() > 0;
     }
     /**
      * Build the annotation type required member documentation.
      *
      * @param node the XML element that specifies which components to document
      * @param memberDetailsTree the content tree to which the documentation will be added
      */
     public void buildAnnotationTypeRequiredMember(XMLNode node, Content memberDetailsTree) {
         buildAnnotationTypeMember(node, memberDetailsTree);
     }
     /**
      * Build the member documentation.
      *
      * @param node the XML element that specifies which components to document
      * @param memberDetailsTree the content tree to which the documentation will be added
      */
     public void buildAnnotationTypeMember(XMLNode node, Content memberDetailsTree) {
         if (writer == null) {
             return;
         }
         int size = members.size();
         if (size > 0) {
             writer.addAnnotationDetailsTreeHeader(
                     classDoc, memberDetailsTree);
             for (currentMemberIndex = 0; currentMemberIndex < size;
             currentMemberIndex++) {
                 Content annotationDocTree = writer.getAnnotationDocTreeHeader(
                         (MemberDoc) members.get(currentMemberIndex),
                         memberDetailsTree);
                 buildChildren(node, annotationDocTree);
                 memberDetailsTree.addContent(writer.getAnnotationDoc(
                         annotationDocTree, (currentMemberIndex == size - 1)));
             }
         }
     }
     /**
      * Build the signature.
      *
      * @param node the XML element that specifies which components to document
      * @param annotationDocTree the content tree to which the documentation will be added
      */
     public void buildSignature(XMLNode node, Content annotationDocTree) {
         annotationDocTree.addContent(
                 writer.getSignature((MemberDoc) members.get(currentMemberIndex)));
     }
     /**
      * Build the deprecation information.
      *
      * @param node the XML element that specifies which components to document
      * @param annotationDocTree the content tree to which the documentation will be added
      */
     public void buildDeprecationInfo(XMLNode node, Content annotationDocTree) {
         writer.addDeprecated((MemberDoc) members.get(currentMemberIndex),
                 annotationDocTree);
     }
     /**
      * Build the comments for the member.  Do nothing if
      * {@link Configuration#nocomment} is set to true.
      *
      * @param node the XML element that specifies which components to document
      * @param annotationDocTree the content tree to which the documentation will be added
      */
     public void buildMemberComments(XMLNode node, Content annotationDocTree) {
         if(! configuration.nocomment){
             writer.addComments((MemberDoc) members.get(currentMemberIndex),
                     annotationDocTree);
         }
     }
     /**
      * Build the tag information.
      *
      * @param node the XML element that specifies which components to document
      * @param annotationDocTree the content tree to which the documentation will be added
      */
     public void buildTagInfo(XMLNode node, Content annotationDocTree) {
         writer.addTags((MemberDoc) members.get(currentMemberIndex),
                 annotationDocTree);
     }
     /**
      * Return the annotation type required member writer for this builder.
      *
      * @return the annotation type required member constant writer for this
      * builder.
      */
     public AnnotationTypeRequiredMemberWriter getWriter() {
         return writer;
     }
 }

Mercurial > jdk8-mips64-public > langtools / annotate

src/share/classes/com/sun/tools/doclets/internal/toolkit/builders/AnnotationTypeRequiredMemberBuilder.java@90af8d87741f (annotated)

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