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

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

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

Tue, 28 Dec 2010 15:54:52 -0800

author: ohair
date: Tue, 28 Dec 2010 15:54:52 -0800
changeset 798: 4868a36f6fd8
parent 766: 90af8d87741f
child 1326: 30c36e23f154
permissions: -rw-r--r--

6962318: Update copyright year
Reviewed-by: xdono

 /*
  * Copyright (c) 2003, 2010, 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.tools.doclets.internal.toolkit.util.*;
 import com.sun.tools.doclets.internal.toolkit.*;
 import com.sun.javadoc.*;
 /**
  * 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
  * @author Bhavesh Patel (Modified)
  * @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;
     /**
      * The content tree for the class documentation.
      */
     private Content contentTree;
     /**
      * 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), contentTree);
     }
     /**
      * {@inheritDoc}
      */
     public String getName() {
         return ROOT;
     }
      /**
       * Handles the &lt;ClassDoc> tag.
       *
       * @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 buildClassDoc(XMLNode node, Content contentTree) throws Exception {
          String key;
          if (isInterface) {
              key =  "doclet.Interface";
          } else if (isEnum) {
              key = "doclet.Enum";
          } else {
              key =  "doclet.Class";
          }
          contentTree = writer.getHeader(configuration.getText(key) + " " +
                  classDoc.name());
          Content classContentTree = writer.getClassContentHeader();
          buildChildren(node, classContentTree);
          contentTree.addContent(classContentTree);
          writer.addFooter(contentTree);
          writer.printDocument(contentTree);
          writer.close();
          copyDocFiles();
      }
      /**
       * Build the class tree documentation.
       *
       * @param node the XML element that specifies which components to document
       * @param classContentTree the content tree to which the documentation will be added
       */
     public void buildClassTree(XMLNode node, Content classContentTree) {
         writer.addClassTree(classContentTree);
     }
     /**
      * Build the class information tree documentation.
      *
      * @param node the XML element that specifies which components to document
      * @param classContentTree the content tree to which the documentation will be added
      */
     public void buildClassInfo(XMLNode node, Content classContentTree) {
         Content classInfoTree = writer.getClassInfoTreeHeader();
         buildChildren(node, classInfoTree);
         classContentTree.addContent(writer.getClassInfo(classInfoTree));
     }
     /**
      * Build the typeparameters of this class.
      *
      * @param node the XML element that specifies which components to document
      * @param classInfoTree the content tree to which the documentation will be added
      */
     public void buildTypeParamInfo(XMLNode node, Content classInfoTree) {
         writer.addTypeParamInfo(classInfoTree);
     }
     /**
      * If this is an interface, list all super interfaces.
      *
      * @param node the XML element that specifies which components to document
      * @param classInfoTree the content tree to which the documentation will be added
      */
     public void buildSuperInterfacesInfo(XMLNode node, Content classInfoTree) {
         writer.addSuperInterfacesInfo(classInfoTree);
     }
     /**
      * If this is a class, list all interfaces implemented by this class.
      *
      * @param node the XML element that specifies which components to document
      * @param classInfoTree the content tree to which the documentation will be added
      */
     public void buildImplementedInterfacesInfo(XMLNode node, Content classInfoTree) {
         writer.addImplementedInterfacesInfo(classInfoTree);
     }
     /**
      * List all the classes extend this one.
      *
      * @param node the XML element that specifies which components to document
      * @param classInfoTree the content tree to which the documentation will be added
      */
     public void buildSubClassInfo(XMLNode node, Content classInfoTree) {
         writer.addSubClassInfo(classInfoTree);
     }
     /**
      * List all the interfaces that extend this one.
      *
      * @param node the XML element that specifies which components to document
      * @param classInfoTree the content tree to which the documentation will be added
      */
     public void buildSubInterfacesInfo(XMLNode node, Content classInfoTree) {
         writer.addSubInterfacesInfo(classInfoTree);
     }
     /**
      * If this is an interface, list all classes that implement this interface.
      *
      * @param node the XML element that specifies which components to document
      * @param classInfoTree the content tree to which the documentation will be added
      */
     public void buildInterfaceUsageInfo(XMLNode node, Content classInfoTree) {
         writer.addInterfaceUsageInfo(classInfoTree);
     }
     /**
      * If this class is deprecated, build the appropriate information.
      *
      * @param node the XML element that specifies which components to document
      * @param classInfoTree the content tree to which the documentation will be added
      */
     public void buildDeprecationInfo (XMLNode node, Content classInfoTree) {
         writer.addClassDeprecationInfo(classInfoTree);
     }
     /**
      * If this is an inner class or interface, list the enclosing class or interface.
      *
      * @param node the XML element that specifies which components to document
      * @param classInfoTree the content tree to which the documentation will be added
      */
     public void buildNestedClassInfo (XMLNode node, Content classInfoTree) {
         writer.addNestedClassInfo(classInfoTree);
     }
     /**
      * 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 signature of the current class.
      *
      * @param node the XML element that specifies which components to document
      * @param classInfoTree the content tree to which the documentation will be added
      */
     public void buildClassSignature(XMLNode node, Content classInfoTree) {
         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.addClassSignature(modifiers.toString(), classInfoTree);
     }
     /**
      * Build the class description.
      *
      * @param node the XML element that specifies which components to document
      * @param classInfoTree the content tree to which the documentation will be added
      */
     public void buildClassDescription(XMLNode node, Content classInfoTree) {
        writer.addClassDescription(classInfoTree);
     }
     /**
      * Build the tag information for the current class.
      *
      * @param node the XML element that specifies which components to document
      * @param classInfoTree the content tree to which the documentation will be added
      */
     public void buildClassTagInfo(XMLNode node, Content classInfoTree) {
        writer.addClassTagInfo(classInfoTree);
     }
     /**
      * Build the member summary contents of the page.
      *
      * @param node the XML element that specifies which components to document
      * @param classContentTree the content tree to which the documentation will be added
      */
     public void buildMemberSummary(XMLNode node, Content classContentTree) throws Exception {
         Content memberSummaryTree = writer.getMemberTreeHeader();
         configuration.getBuilderFactory().
                 getMemberSummaryBuilder(writer).buildChildren(node, memberSummaryTree);
         classContentTree.addContent(writer.getMemberSummaryTree(memberSummaryTree));
     }
     /**
      * Build the member details contents of the page.
      *
      * @param node the XML element that specifies which components to document
      * @param classContentTree the content tree to which the documentation will be added
      */
     public void buildMemberDetails(XMLNode node, Content classContentTree) {
         Content memberDetailsTree = writer.getMemberTreeHeader();
         buildChildren(node, memberDetailsTree);
         classContentTree.addContent(writer.getMemberDetailsTree(memberDetailsTree));
     }
     /**
      * Build the enum constants 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 buildEnumConstantsDetails(XMLNode node,
             Content memberDetailsTree) throws Exception {
         configuration.getBuilderFactory().
                 getEnumConstantsBuilder(writer).buildChildren(node, memberDetailsTree);
     }
     /**
      * Build the field 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 buildFieldDetails(XMLNode node,
             Content memberDetailsTree) throws Exception {
         configuration.getBuilderFactory().
                 getFieldBuilder(writer).buildChildren(node, memberDetailsTree);
     }
     /**
      * Build the constructor 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 buildConstructorDetails(XMLNode node,
             Content memberDetailsTree) throws Exception {
         configuration.getBuilderFactory().
                 getConstructorBuilder(writer).buildChildren(node, memberDetailsTree);
     }
     /**
      * Build the method 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 buildMethodDetails(XMLNode node,
             Content memberDetailsTree) throws Exception {
         configuration.getBuilderFactory().
                 getMethodBuilder(writer).buildChildren(node, memberDetailsTree);
     }
 }

Mercurial > jdk8-mips64-public > langtools / annotate

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

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