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

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

src/share/classes/com/sun/tools/doclets/internal/toolkit/builders/ClassBuilder.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 class.
  *
  * 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 ClassBuilder extends AbstractBuilder {
     /**
      * The root element of the class XML is {@value}.
      */
     public static final String ROOT = "ClassDoc";
     /**
      * The class being documented.
      */
     private ClassDoc classDoc;
     /**
      * The doclet specific writer.
      */
     private ClassWriter writer;
     /**
      * Keep track of whether or not this classdoc is an interface.
      */
     private boolean isInterface = false;
     /**
      * Keep track of whether or not this classdoc is an enum.
      */
     private boolean isEnum = false;
     /**
      * Construct a new ClassBuilder.
      *
      * @param configuration the current configuration of the
      *                      doclet.
      */
     private ClassBuilder(Configuration configuration) {
         super(configuration);
     }
     /**
      * Construct a new ClassBuilder.
      *
      * @param configuration the current configuration of the doclet.
      * @param classDoc the class being documented.
      * @param writer the doclet specific writer.
      */
     public static ClassBuilder getInstance(Configuration configuration,
         ClassDoc classDoc, ClassWriter writer)
     throws Exception {
         ClassBuilder builder = new ClassBuilder(configuration);
         builder.configuration = configuration;
         builder.classDoc = classDoc;
         builder.writer = writer;
         if (classDoc.isInterface()) {
             builder.isInterface = true;
         } else if (classDoc.isEnum()) {
             builder.isEnum = true;
             Util.setEnumDocumentation(configuration, classDoc);
         }
         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;ClassDoc> tag.
       *
       * @param elements the XML elements that specify how to document a class.
       */
      public void buildClassDoc(XMLNode node) throws Exception {
         buildChildren(node);
         writer.close();
         copyDocFiles();
      }
      /**
       * Copy the doc files for the current ClassDoc if necessary.
       */
      private void copyDocFiles() {
         PackageDoc containingPackage = classDoc.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,
                     classDoc.containingPackage()) +
                 DirectoryManager.getDirectoryPath(classDoc.containingPackage())
                     + File.separator, DocletConstants.DOC_FILES_DIR_NAME, true);
             containingPackagesSeen.add(containingPackage.name());
         }
      }
     /**
      * Build the header of the page.
      */
     public void buildClassHeader(XMLNode node) {
         String key;
         if (isInterface) {
             key =  "doclet.Interface";
         } else if (isEnum) {
             key = "doclet.Enum";
         } else {
             key =  "doclet.Class";
         }
         writer.writeHeader(configuration.getText(key) + " " + classDoc.name());
     }
     /**
      * Build the class tree documentation.
      */
     public void buildClassTree(XMLNode node) {
         writer.writeClassTree();
     }
     /**
      * If this is a class, list all interfaces
      * implemented by this class.
      */
     public void buildImplementedInterfacesInfo(XMLNode node) {
         writer.writeImplementedInterfacesInfo();
     }
     /**
      * If this is an interface, list all super interfaces.
      */
     public void buildSuperInterfacesInfo(XMLNode node) {
         writer.writeSuperInterfacesInfo();
     }
     /**
      * List the parameters of this class.
      */
     public void buildTypeParamInfo(XMLNode node) {
         writer.writeTypeParamInfo();
     }
     /**
      * List all the classes extend this one.
      */
     public void buildSubClassInfo(XMLNode node) {
         writer.writeSubClassInfo();
     }
     /**
      * List all the interfaces that extend this one.
      */
     public void buildSubInterfacesInfo(XMLNode node) {
         writer.writeSubInterfacesInfo();
     }
     /**
      * If this is an interface, list all classes that implement this interface.
      */
     public void buildInterfaceUsageInfo (XMLNode node) {
         writer.writeInterfaceUsageInfo();
     }
     /**
      * If this is an inner class or interface, list the enclosing class or
      * interface.
      */
     public void buildNestedClassInfo (XMLNode node) {
         writer.writeNestedClassInfo();
     }
     /**
      * If this class is deprecated, print the appropriate information.
      */
     public void buildDeprecationInfo (XMLNode node) {
         writer.writeClassDeprecationInfo();
     }
     /**
      * Build the signature of the current class.
      */
     public void buildClassSignature(XMLNode node) {
         StringBuffer modifiers = new StringBuffer(classDoc.modifiers() + " ");
         if (isEnum) {
             modifiers.append("enum ");
             int index;
             if ((index = modifiers.indexOf("abstract")) >= 0) {
                 modifiers.delete(index, index + (new String("abstract")).length());
                 modifiers = new StringBuffer(
                     Util.replaceText(modifiers.toString(), "  ", " "));
             }
             if ((index = modifiers.indexOf("final")) >= 0) {
                 modifiers.delete(index, index + (new String("final")).length());
                 modifiers = new StringBuffer(
                     Util.replaceText(modifiers.toString(), "  ", " "));
             }
         //} else if (classDoc.isAnnotationType()) {
             //modifiers.append("@interface ");
         } else if (! isInterface) {
             modifiers.append("class ");
         }
         writer.writeClassSignature(modifiers.toString());
     }
     /**
      * Build the class description.
      */
     public void buildClassDescription(XMLNode node) {
        writer.writeClassDescription();
     }
     /**
      * Build the tag information for the current class.
      */
     public void buildClassTagInfo(XMLNode node) {
        writer.writeClassTagInfo();
     }
     /**
      * 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 enum constants documentation.
      *
      * @param elements the XML elements that specify how a enum constants are
      *                 documented.
      */
     public void buildEnumConstantsDetails(XMLNode node) throws Exception {
         configuration.getBuilderFactory().
             getEnumConstantsBuilder(writer).buildChildren(node);
     }
     /**
      * Build the field documentation.
      *
      * @param elements the XML elements that specify how a field is documented.
      */
     public void buildFieldDetails(XMLNode node) throws Exception {
         configuration.getBuilderFactory().
             getFieldBuilder(writer).buildChildren(node);
     }
     /**
      * Build the constructor documentation.
      *
      * @param elements the XML elements that specify how to document a
      * constructor.
      */
     public void buildConstructorDetails(XMLNode node) throws Exception {
         configuration.getBuilderFactory().
             getConstructorBuilder(writer).buildChildren(node);
     }
     /**
      * Build the method documentation.
      *
      * @param elements the XML elements that specify how a method is documented.
      */
     public void buildMethodDetails(XMLNode node) throws Exception {
         configuration.getBuilderFactory().
                 getMethodBuilder(writer).buildChildren(node);
     }
     /**
      * Build the footer of the page.
      */
     public void buildClassFooter(XMLNode node) {
         writer.writeFooter();
     }
 }

Mercurial > jdk8-mips64-public > langtools / annotate

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

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