jdk8-mips64-public/langtools: src/share/classes/com/sun/tools/doclets/internal/toolkit/builders/AnnotationTypeBuilder.java@4177f5bdd189 (annotated)

src/share/classes/com/sun/tools/doclets/internal/toolkit/builders/AnnotationTypeBuilder.java@4177f5bdd189 (annotated)

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

Fri, 18 Jun 2010 21:13:56 -0700

author: jjg
date: Fri, 18 Jun 2010 21:13:56 -0700
changeset 589: 4177f5bdd189
parent 554: 9d9f26857129
child 766: 90af8d87741f
permissions: -rw-r--r--

6961178: Allow doclet.xml to contain XML attributes
Reviewed-by: bpatel

 /*
  * 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 com.sun.tools.doclets.internal.toolkit.util.*;
 import com.sun.tools.doclets.internal.toolkit.*;
 import com.sun.javadoc.*;
 import java.io.*;
 import java.util.*;
 /**
  * Builds the summary for a given annotation type.
  *
  * 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
  * @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;
     /**
      * 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));
     }
     /**
      * {@inheritDoc}
      */
     public String getName() {
         return ROOT;
     }
      /**
       * Handles the &lt;AnnotationTypeDoc> tag.
       *
       * @param elements the XML elements that specify how to document a class.
       */
      public void buildAnnotationTypeDoc(XMLNode node) throws Exception {
         buildChildren(node);
         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,
                 Util.getPackageSourcePath(configuration,
                     annotationTypeDoc.containingPackage()) +
                 DirectoryManager.getDirectoryPath(
                     annotationTypeDoc.containingPackage())
                     + File.separator, DocletConstants.DOC_FILES_DIR_NAME, true);
             containingPackagesSeen.add(containingPackage.name());
         }
      }
     /**
      * Build the header of the page.
      */
     public void buildAnnotationTypeHeader(XMLNode node) {
         writer.writeHeader(configuration.getText("doclet.AnnotationType") +
             " " + annotationTypeDoc.name());
     }
     /**
      * If this class is deprecated, print the appropriate information.
      */
     public void buildDeprecationInfo (XMLNode node) {
         writer.writeAnnotationTypeDeprecationInfo();
     }
     /**
      * Build the signature of the current annotation type.
      */
     public void buildAnnotationTypeSignature(XMLNode node) {
         StringBuffer modifiers = new StringBuffer(
             annotationTypeDoc.modifiers() + " ");
         writer.writeAnnotationTypeSignature(
             Util.replaceText(
                 modifiers.toString(), "interface", "@interface"));
     }
     /**
      * Build the class description.
      */
     public void buildAnnotationTypeDescription(XMLNode node) {
        writer.writeAnnotationTypeDescription();
     }
     /**
      * Build the tag information for the current class.
      */
     public void buildAnnotationTypeTagInfo(XMLNode node) {
        writer.writeAnnotationTypeTagInfo();
     }
     /**
      * Build the contents of the page.
      *
      * @param elements the XML elements that specify how a member summary is
      *                 documented.
      */
     public void buildMemberSummary(XMLNode node) throws Exception {
         configuration.getBuilderFactory().
             getMemberSummaryBuilder(writer).buildChildren(node);
         writer.completeMemberSummaryBuild();
     }
     /**
      * Build the annotation type optional member documentation.
      *
      * @param elements the XML elements that specify how a annotation type
      *                 members are documented.
      */
     public void buildAnnotationTypeOptionalMemberDetails(XMLNode node)
     throws Exception {
         configuration.getBuilderFactory().
             getAnnotationTypeOptionalMemberBuilder(writer).buildChildren(node);
     }
     /**
      * Build the annotation type required member documentation.
      *
      * @param elements the XML elements that specify how a annotation type
      *                 members are documented.
      */
     public void buildAnnotationTypeRequiredMemberDetails(XMLNode node)
     throws Exception {
         configuration.getBuilderFactory().
             getAnnotationTypeRequiredMemberBuilder(writer).buildChildren(node);
     }
     /**
      * Build the footer of the page.
      */
     public void buildAnnotationTypeFooter(XMLNode node) {
         writer.writeFooter();
     }
 }

Mercurial > jdk8-mips64-public > langtools / annotate

src/share/classes/com/sun/tools/doclets/internal/toolkit/builders/AnnotationTypeBuilder.java@4177f5bdd189 (annotated)

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