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

 /*

  * Copyright (c) 2003, 2012, 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.io.*;

 import java.util.*;

 import com.sun.javadoc.*;

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

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

 /**

  * Builds the summary for a given annotation type.

  *

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

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

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

  *  deletion without notice.</b>

  *

  * @author Jamie Ho

  * @author Bhavesh Patel (Modified)

  * @since 1.5

  */

 public class AnnotationTypeBuilder extends AbstractBuilder {

     /**

      * The root element of the annotation type XML is {@value}.

      */

     public static final String ROOT = "AnnotationTypeDoc";

     /**

      * The annotation type being documented.

      */

     private AnnotationTypeDoc annotationTypeDoc;

     /**

      * The doclet specific writer.

      */

     private AnnotationTypeWriter writer;

     /**

      * The content tree for the annotation documentation.

      */

     private Content contentTree;

     /**

      * Construct a new ClassBuilder.

      *

      * @param configuration the current configuration of the

      *                      doclet.

      */

     private AnnotationTypeBuilder(Configuration configuration) {

         super(configuration);

     }

     /**

      * Construct a new ClassBuilder.

      *

      * @param configuration     the current configuration of the doclet.

      * @param annotationTypeDoc the class being documented.

      * @param writer            the doclet specific writer.

      */

     public static AnnotationTypeBuilder getInstance(Configuration configuration,

         AnnotationTypeDoc annotationTypeDoc, AnnotationTypeWriter writer)

     throws Exception {

         AnnotationTypeBuilder builder = new AnnotationTypeBuilder(configuration);

         builder.configuration = configuration;

         builder.annotationTypeDoc = annotationTypeDoc;

         builder.writer = writer;

         if(containingPackagesSeen == null) {

             containingPackagesSeen = new HashSet<String>();

         }

         return builder;

     }

     /**

      * {@inheritDoc}

      */

     public void build() throws IOException {

         build(LayoutParser.getInstance(configuration).parseXML(ROOT), contentTree);

     }

     /**

      * {@inheritDoc}

      */

     public String getName() {

         return ROOT;

     }

     /**

       * Build the annotation type documentation.

       *

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

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

       */

      public void buildAnnotationTypeDoc(XMLNode node, Content contentTree) throws Exception {

         contentTree = writer.getHeader(configuration.getText("doclet.AnnotationType") +

                 " " + annotationTypeDoc.name());

         Content annotationContentTree = writer.getAnnotationContentHeader();

          buildChildren(node, annotationContentTree);

          contentTree.addContent(annotationContentTree);

          writer.addFooter(contentTree);

          writer.printDocument(contentTree);

          writer.close();

          copyDocFiles();

      }

      /**

       * Copy the doc files for the current ClassDoc if necessary.

       */

      private void copyDocFiles() {

         PackageDoc containingPackage = annotationTypeDoc.containingPackage();

         if((configuration.packages == null ||

                 Arrays.binarySearch(configuration.packages,

                                     containingPackage) < 0) &&

            ! containingPackagesSeen.contains(containingPackage.name())){

             //Only copy doc files dir if the containing package is not

             //documented AND if we have not documented a class from the same

             //package already. Otherwise, we are making duplicate copies.

             Util.copyDocFiles(configuration,

                 new File(Util.getPackageSourcePath(configuration, containingPackage),

                     DocPath.forPackage(annotationTypeDoc).getPath()),

                 DocPaths.DOC_FILES, true);

             containingPackagesSeen.add(containingPackage.name());

         }

      }

     /**

      * Build the annotation information tree documentation.

      *

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

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

      */

     public void buildAnnotationTypeInfo(XMLNode node, Content annotationContentTree) {

         Content annotationInfoTree = writer.getAnnotationInfoTreeHeader();

         buildChildren(node, annotationInfoTree);

         annotationContentTree.addContent(writer.getAnnotationInfo(annotationInfoTree));

     }

     /**

      * If this annotation is deprecated, build the appropriate information.

      *

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

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

      */

     public void buildDeprecationInfo (XMLNode node, Content annotationInfoTree) {

         writer.addAnnotationTypeDeprecationInfo(annotationInfoTree);

     }

     /**

      * Build the signature of the current annotation type.

      *

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

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

      */

     public void buildAnnotationTypeSignature(XMLNode node, Content annotationInfoTree) {

         StringBuilder modifiers = new StringBuilder(

                 annotationTypeDoc.modifiers() + " ");

         writer.addAnnotationTypeSignature(Util.replaceText(

                 modifiers.toString(), "interface", "@interface"), annotationInfoTree);

     }

     /**

      * Build the annotation type description.

      *

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

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

      */

     public void buildAnnotationTypeDescription(XMLNode node, Content annotationInfoTree) {

         writer.addAnnotationTypeDescription(annotationInfoTree);

     }

     /**

      * Build the tag information for the current annotation type.

      *

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

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

      */

     public void buildAnnotationTypeTagInfo(XMLNode node, Content annotationInfoTree) {

         writer.addAnnotationTypeTagInfo(annotationInfoTree);

     }

     /**

      * Build the member summary contents of the page.

      *

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

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

      */

     public void buildMemberSummary(XMLNode node, Content annotationContentTree)

             throws Exception {

         Content memberSummaryTree = writer.getMemberTreeHeader();

         configuration.getBuilderFactory().

                 getMemberSummaryBuilder(writer).buildChildren(node, memberSummaryTree);

         annotationContentTree.addContent(writer.getMemberSummaryTree(memberSummaryTree));

     }

     /**

      * Build the member details contents of the page.

      *

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

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

      */

     public void buildAnnotationTypeMemberDetails(XMLNode node, Content annotationContentTree) {

         Content memberDetailsTree = writer.getMemberTreeHeader();

         buildChildren(node, memberDetailsTree);

         if (memberDetailsTree.isValid()) {

             Content memberDetails = writer.getMemberTreeHeader();

             writer.addAnnotationDetailsMarker(memberDetails);

             memberDetails.addContent(writer.getMemberTree(memberDetailsTree));

             annotationContentTree.addContent(writer.getMemberDetailsTree(memberDetails));

         }

     }

     /**

      * Build the annotation type optional 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 buildAnnotationTypeOptionalMemberDetails(XMLNode node, Content memberDetailsTree)

             throws Exception {

         configuration.getBuilderFactory().

                 getAnnotationTypeOptionalMemberBuilder(writer).buildChildren(node, memberDetailsTree);

     }

     /**

      * 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 buildAnnotationTypeRequiredMemberDetails(XMLNode node, Content memberDetailsTree)

             throws Exception {

         configuration.getBuilderFactory().

                 getAnnotationTypeRequiredMemberBuilder(writer).buildChildren(node, memberDetailsTree);

     }

 }