diff -r 000000000000 -r 9a66ca7c79fa src/share/classes/com/sun/tools/doclets/internal/toolkit/builders/EnumConstantBuilder.java --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/share/classes/com/sun/tools/doclets/internal/toolkit/builders/EnumConstantBuilder.java Sat Dec 01 00:00:00 2007 +0000 @@ -0,0 +1,254 @@ +/* + * Copyright 2003 Sun Microsystems, Inc. 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. Sun designates this + * particular file as subject to the "Classpath" exception as provided + * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, + * CA 95054 USA or visit www.sun.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.*; +import java.lang.reflect.*; + +/** + * 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 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(builder.visibleMemberMap.getMembersFor(classDoc)); + if (configuration.getMemberComparator() != null) { + Collections.sort( + builder.enumConstants, + configuration.getMemberComparator()); + } + return builder; + } + + /** + * {@inheritDoc} + */ + public String getName() { + return "EnumConstantDetails"; + } + + /** + * {@inheritDoc} + */ + public void invokeMethod( + String methodName, + Class[] paramClasses, + Object[] params) + throws Exception { + if (DEBUG) { + configuration.root.printError( + "DEBUG: " + this.getClass().getName() + "." + methodName); + } + Method method = this.getClass().getMethod(methodName, paramClasses); + method.invoke(this, params); + } + + /** + * 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 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(List elements) { + if (writer == null) { + return; + } + for (currentEnumConstantsIndex = 0; + currentEnumConstantsIndex < enumConstants.size(); + currentEnumConstantsIndex++) { + build(elements); + } + } + + /** + * Build the overall header. + */ + public void buildHeader() { + writer.writeHeader( + classDoc, + configuration.getText("doclet.Enum_Constant_Detail")); + } + + /** + * Build the header for the individual enum constants. + */ + public void buildEnumConstantHeader() { + writer.writeEnumConstantHeader( + (FieldDoc) enumConstants.get(currentEnumConstantsIndex), + currentEnumConstantsIndex == 0); + } + + /** + * Build the signature. + */ + public void buildSignature() { + writer.writeSignature( + (FieldDoc) enumConstants.get(currentEnumConstantsIndex)); + } + + /** + * Build the deprecation information. + */ + public void buildDeprecationInfo() { + 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() { + if (!configuration.nocomment) { + writer.writeComments( + (FieldDoc) enumConstants.get(currentEnumConstantsIndex)); + } + } + + /** + * Build the tag information. + */ + public void buildTagInfo() { + writer.writeTags( + (FieldDoc) enumConstants.get(currentEnumConstantsIndex)); + } + + /** + * Build the footer for the individual enum constants. + */ + public void buildEnumConstantFooter() { + writer.writeEnumConstantFooter(); + } + + /** + * Build the overall footer. + */ + public void buildFooter() { + writer.writeFooter(classDoc); + } + + /** + * Return the enum constant writer for this builder. + * + * @return the enum constant writer for this builder. + */ + public EnumConstantWriter getWriter() { + return writer; + } +}