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

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

src/share/classes/com/sun/tools/doclets/internal/toolkit/builders/EnumConstantBuilder.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.util.*;
 /**
  * Builds documentation for a enum constants.
  *
  * 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 EnumConstantBuilder extends AbstractMemberBuilder {
         /**
          * The class whose enum constants are being documented.
          */
         private ClassDoc classDoc;
         /**
          * The visible enum constantss for the given class.
          */
         private VisibleMemberMap visibleMemberMap;
         /**
          * The writer to output the enum constants documentation.
          */
         private EnumConstantWriter writer;
         /**
          * The list of enum constants being documented.
          */
         private List<ProgramElementDoc> enumConstants;
         /**
          * The index of the current enum constant that is being documented at this point
          * in time.
          */
         private int currentEnumConstantsIndex;
         /**
          * Construct a new EnumConstantsBuilder.
          *
          * @param configuration the current configuration of the
          *                      doclet.
          */
         private EnumConstantBuilder(Configuration configuration) {
                 super(configuration);
         }
         /**
          * Construct a new EnumConstantsBuilder.
          *
          * @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 EnumConstantBuilder getInstance(
                 Configuration configuration,
                 ClassDoc classDoc,
                 EnumConstantWriter writer) {
                 EnumConstantBuilder builder = new EnumConstantBuilder(configuration);
                 builder.classDoc = classDoc;
                 builder.writer = writer;
                 builder.visibleMemberMap =
                         new VisibleMemberMap(
                                 classDoc,
                                 VisibleMemberMap.ENUM_CONSTANTS,
                                 configuration.nodeprecated);
                 builder.enumConstants =
                         new ArrayList<ProgramElementDoc>(builder.visibleMemberMap.getMembersFor(classDoc));
                 if (configuration.getMemberComparator() != null) {
                         Collections.sort(
                                 builder.enumConstants,
                                 configuration.getMemberComparator());
                 }
                 return builder;
         }
         /**
          * {@inheritDoc}
          */
         public String getName() {
                 return "EnumConstantDetails";
         }
         /**
          * Returns a list of enum constants 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 enum constants that will be documented.
          */
         public List<ProgramElementDoc> members(ClassDoc classDoc) {
                 return visibleMemberMap.getMembersFor(classDoc);
         }
         /**
          * Returns the visible member map for the enum constants of this class.
          *
          * @return the visible member map for the enum constants of this class.
          */
         public VisibleMemberMap getVisibleMemberMap() {
                 return visibleMemberMap;
         }
         /**
          * summaryOrder.size()
          */
         public boolean hasMembersToDocument() {
                 return enumConstants.size() > 0;
         }
         /**
          * Build the enum constant documentation.
          *
          * @param elements the XML elements that specify how to construct this
          *                documentation.
          */
         public void buildEnumConstant(XMLNode node) {
                 if (writer == null) {
                         return;
                 }
                 for (currentEnumConstantsIndex = 0;
                         currentEnumConstantsIndex < enumConstants.size();
                         currentEnumConstantsIndex++) {
                         buildChildren(node);
                 }
         }
         /**
          * Build the overall header.
          */
         public void buildHeader(XMLNode node) {
                 writer.writeHeader(
                         classDoc,
                         configuration.getText("doclet.Enum_Constant_Detail"));
         }
         /**
          * Build the header for the individual enum constants.
          */
         public void buildEnumConstantHeader(XMLNode node) {
                 writer.writeEnumConstantHeader(
                         (FieldDoc) enumConstants.get(currentEnumConstantsIndex),
                         currentEnumConstantsIndex == 0);
         }
         /**
          * Build the signature.
          */
         public void buildSignature(XMLNode node) {
                 writer.writeSignature(
                         (FieldDoc) enumConstants.get(currentEnumConstantsIndex));
         }
         /**
          * Build the deprecation information.
          */
         public void buildDeprecationInfo(XMLNode node) {
                 writer.writeDeprecated(
                         (FieldDoc) enumConstants.get(currentEnumConstantsIndex));
         }
         /**
          * Build the comments for the enum constant.  Do nothing if
          * {@link Configuration#nocomment} is set to true.
          */
         public void buildEnumConstantComments(XMLNode node) {
                 if (!configuration.nocomment) {
                         writer.writeComments(
                                 (FieldDoc) enumConstants.get(currentEnumConstantsIndex));
                 }
         }
         /**
          * Build the tag information.
          */
         public void buildTagInfo(XMLNode node) {
                 writer.writeTags(
                         (FieldDoc) enumConstants.get(currentEnumConstantsIndex));
         }
         /**
          * Build the footer for the individual enum constants.
          */
         public void buildEnumConstantFooter(XMLNode node) {
                 writer.writeEnumConstantFooter();
         }
         /**
          * Build the overall footer.
          */
         public void buildFooter(XMLNode node) {
                 writer.writeFooter(classDoc);
         }
         /**
          * Return the enum constant writer for this builder.
          *
          * @return the enum constant writer for this builder.
          */
         public EnumConstantWriter getWriter() {
                 return writer;
         }
 }

Mercurial > jdk8-mips64-public > langtools / annotate

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

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