duke@1: /*
jjg@1357: * Copyright (c) 2003, 2012, Oracle and/or its affiliates. All rights reserved.
duke@1: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1: *
duke@1: * This code is free software; you can redistribute it and/or modify it
duke@1: * under the terms of the GNU General Public License version 2 only, as
ohair@554: * published by the Free Software Foundation. Oracle designates this
duke@1: * particular file as subject to the "Classpath" exception as provided
ohair@554: * by Oracle in the LICENSE file that accompanied this code.
duke@1: *
duke@1: * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
duke@1: * version 2 for more details (a copy is included in the LICENSE file that
duke@1: * accompanied this code).
duke@1: *
duke@1: * You should have received a copy of the GNU General Public License version
duke@1: * 2 along with this work; if not, write to the Free Software Foundation,
duke@1: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1: *
ohair@554: * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@554: * or visit www.oracle.com if you need additional information or have any
ohair@554: * questions.
duke@1: */
duke@1:
duke@1: package com.sun.tools.doclets.internal.toolkit.builders;
duke@1:
bpatel@766: import java.util.*;
jjg@1357:
jjg@1357: import com.sun.javadoc.*;
jjg@1357: import com.sun.tools.doclets.internal.toolkit.*;
duke@1: import com.sun.tools.doclets.internal.toolkit.util.*;
duke@1:
duke@1: /**
duke@1: * Builds documentation for a enum constants.
duke@1: *
jjg@1359: *
This is NOT part of any supported API.
jjg@1359: * If you write code that depends on this, you do so at your own risk.
jjg@1359: * This code and its internal interfaces are subject to change or
jjg@1359: * deletion without notice.
duke@1: *
duke@1: * @author Jamie Ho
bpatel@766: * @author Bhavesh Patel (Modified)
duke@1: * @since 1.5
duke@1: */
duke@1: public class EnumConstantBuilder extends AbstractMemberBuilder {
duke@1:
bpatel@766: /**
bpatel@766: * The class whose enum constants are being documented.
bpatel@766: */
bpatel@766: private ClassDoc classDoc;
duke@1:
bpatel@766: /**
bpatel@766: * The visible enum constantss for the given class.
bpatel@766: */
bpatel@766: private VisibleMemberMap visibleMemberMap;
duke@1:
bpatel@766: /**
bpatel@766: * The writer to output the enum constants documentation.
bpatel@766: */
bpatel@766: private EnumConstantWriter writer;
duke@1:
bpatel@766: /**
bpatel@766: * The list of enum constants being documented.
bpatel@766: */
bpatel@766: private List enumConstants;
duke@1:
bpatel@766: /**
bpatel@766: * The index of the current enum constant that is being documented at this point
bpatel@766: * in time.
bpatel@766: */
bpatel@766: private int currentEnumConstantsIndex;
duke@1:
bpatel@766: /**
bpatel@766: * Construct a new EnumConstantsBuilder.
bpatel@766: *
bpatel@766: * @param configuration the current configuration of the
bpatel@766: * doclet.
bpatel@766: */
bpatel@766: private EnumConstantBuilder(Configuration configuration) {
bpatel@766: super(configuration);
bpatel@766: }
bpatel@766:
bpatel@766: /**
bpatel@766: * Construct a new EnumConstantsBuilder.
bpatel@766: *
bpatel@766: * @param configuration the current configuration of the doclet.
bpatel@766: * @param classDoc the class whoses members are being documented.
bpatel@766: * @param writer the doclet specific writer.
bpatel@766: */
bpatel@766: public static EnumConstantBuilder getInstance(
bpatel@766: Configuration configuration,
bpatel@766: ClassDoc classDoc,
bpatel@766: EnumConstantWriter writer) {
bpatel@766: EnumConstantBuilder builder = new EnumConstantBuilder(configuration);
bpatel@766: builder.classDoc = classDoc;
bpatel@766: builder.writer = writer;
bpatel@766: builder.visibleMemberMap =
bpatel@766: new VisibleMemberMap(
bpatel@766: classDoc,
bpatel@766: VisibleMemberMap.ENUM_CONSTANTS,
bpatel@766: configuration.nodeprecated);
bpatel@766: builder.enumConstants =
bpatel@766: new ArrayList(builder.visibleMemberMap.getMembersFor(classDoc));
bpatel@766: if (configuration.getMemberComparator() != null) {
bpatel@766: Collections.sort(
bpatel@766: builder.enumConstants,
bpatel@766: configuration.getMemberComparator());
duke@1: }
bpatel@766: return builder;
bpatel@766: }
duke@1:
bpatel@766: /**
bpatel@766: * {@inheritDoc}
bpatel@766: */
bpatel@766: public String getName() {
bpatel@766: return "EnumConstantDetails";
bpatel@766: }
bpatel@766:
bpatel@766: /**
bpatel@766: * Returns a list of enum constants that will be documented for the given class.
bpatel@766: * This information can be used for doclet specific documentation
bpatel@766: * generation.
bpatel@766: *
bpatel@766: * @param classDoc the {@link ClassDoc} we want to check.
bpatel@766: * @return a list of enum constants that will be documented.
bpatel@766: */
bpatel@766: public List members(ClassDoc classDoc) {
bpatel@766: return visibleMemberMap.getMembersFor(classDoc);
bpatel@766: }
bpatel@766:
bpatel@766: /**
bpatel@766: * Returns the visible member map for the enum constants of this class.
bpatel@766: *
bpatel@766: * @return the visible member map for the enum constants of this class.
bpatel@766: */
bpatel@766: public VisibleMemberMap getVisibleMemberMap() {
bpatel@766: return visibleMemberMap;
bpatel@766: }
bpatel@766:
bpatel@766: /**
bpatel@766: * summaryOrder.size()
bpatel@766: */
bpatel@766: public boolean hasMembersToDocument() {
bpatel@766: return enumConstants.size() > 0;
bpatel@766: }
bpatel@766:
bpatel@766: /**
bpatel@766: * Build the enum constant documentation.
bpatel@766: *
bpatel@766: * @param node the XML element that specifies which components to document
bpatel@766: * @param memberDetailsTree the content tree to which the documentation will be added
bpatel@766: */
bpatel@766: public void buildEnumConstant(XMLNode node, Content memberDetailsTree) {
bpatel@766: if (writer == null) {
bpatel@766: return;
duke@1: }
bpatel@766: int size = enumConstants.size();
bpatel@766: if (size > 0) {
bpatel@766: Content enumConstantsDetailsTree = writer.getEnumConstantsDetailsTreeHeader(
bpatel@766: classDoc, memberDetailsTree);
bpatel@766: for (currentEnumConstantsIndex = 0; currentEnumConstantsIndex < size;
bpatel@766: currentEnumConstantsIndex++) {
bpatel@766: Content enumConstantsTree = writer.getEnumConstantsTreeHeader(
bpatel@766: (FieldDoc) enumConstants.get(currentEnumConstantsIndex),
bpatel@766: enumConstantsDetailsTree);
bpatel@766: buildChildren(node, enumConstantsTree);
bpatel@766: enumConstantsDetailsTree.addContent(writer.getEnumConstants(
bpatel@766: enumConstantsTree, (currentEnumConstantsIndex == size - 1)));
bpatel@766: }
bpatel@766: memberDetailsTree.addContent(
bpatel@766: writer.getEnumConstantsDetails(enumConstantsDetailsTree));
bpatel@766: }
bpatel@766: }
duke@1:
bpatel@766: /**
bpatel@766: * Build the signature.
bpatel@766: *
bpatel@766: * @param node the XML element that specifies which components to document
bpatel@766: * @param enumConstantsTree the content tree to which the documentation will be added
bpatel@766: */
bpatel@766: public void buildSignature(XMLNode node, Content enumConstantsTree) {
bpatel@766: enumConstantsTree.addContent(writer.getSignature(
bpatel@766: (FieldDoc) enumConstants.get(currentEnumConstantsIndex)));
bpatel@766: }
bpatel@766:
bpatel@766: /**
bpatel@766: * Build the deprecation information.
bpatel@766: *
bpatel@766: * @param node the XML element that specifies which components to document
bpatel@766: * @param enumConstantsTree the content tree to which the documentation will be added
bpatel@766: */
bpatel@766: public void buildDeprecationInfo(XMLNode node, Content enumConstantsTree) {
bpatel@766: writer.addDeprecated(
bpatel@766: (FieldDoc) enumConstants.get(currentEnumConstantsIndex),
bpatel@766: enumConstantsTree);
bpatel@766: }
bpatel@766:
bpatel@766: /**
bpatel@766: * Build the comments for the enum constant. Do nothing if
bpatel@766: * {@link Configuration#nocomment} is set to true.
bpatel@766: *
bpatel@766: * @param node the XML element that specifies which components to document
bpatel@766: * @param enumConstantsTree the content tree to which the documentation will be added
bpatel@766: */
bpatel@766: public void buildEnumConstantComments(XMLNode node, Content enumConstantsTree) {
bpatel@766: if (!configuration.nocomment) {
bpatel@766: writer.addComments(
bpatel@766: (FieldDoc) enumConstants.get(currentEnumConstantsIndex),
bpatel@766: enumConstantsTree);
duke@1: }
bpatel@766: }
duke@1:
bpatel@766: /**
bpatel@766: * Build the tag information.
bpatel@766: *
bpatel@766: * @param node the XML element that specifies which components to document
bpatel@766: * @param enumConstantsTree the content tree to which the documentation will be added
bpatel@766: */
bpatel@766: public void buildTagInfo(XMLNode node, Content enumConstantsTree) {
bpatel@766: writer.addTags(
bpatel@766: (FieldDoc) enumConstants.get(currentEnumConstantsIndex),
bpatel@766: enumConstantsTree);
bpatel@766: }
duke@1:
bpatel@766: /**
bpatel@766: * Return the enum constant writer for this builder.
bpatel@766: *
bpatel@766: * @return the enum constant writer for this builder.
bpatel@766: */
bpatel@766: public EnumConstantWriter getWriter() {
bpatel@766: return writer;
bpatel@766: }
duke@1: }