duke@1: /* ohair@554: * Copyright (c) 2003, 2008, 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: duke@1: duke@1: import com.sun.tools.doclets.internal.toolkit.util.*; duke@1: import com.sun.tools.doclets.internal.toolkit.*; duke@1: import com.sun.javadoc.*; duke@1: import java.util.*; duke@1: duke@1: /** duke@1: * Builds documentation for required annotation type members. duke@1: * duke@1: * This code is not part of an API. duke@1: * It is implementation that is subject to change. duke@1: * Do not use it as an API duke@1: * duke@1: * @author Jamie Ho duke@1: * @since 1.5 duke@1: */ duke@1: public class AnnotationTypeRequiredMemberBuilder extends AbstractMemberBuilder { duke@1: duke@1: /** duke@1: * The annotation type whose members are being documented. duke@1: */ duke@1: protected ClassDoc classDoc; duke@1: duke@1: /** duke@1: * The visible members for the given class. duke@1: */ duke@1: protected VisibleMemberMap visibleMemberMap; duke@1: duke@1: /** duke@1: * The writer to output the member documentation. duke@1: */ duke@1: protected AnnotationTypeRequiredMemberWriter writer; duke@1: duke@1: /** duke@1: * The list of members being documented. duke@1: */ jjg@74: protected List members; duke@1: duke@1: /** duke@1: * The index of the current member that is being documented at this point duke@1: * in time. duke@1: */ duke@1: protected int currentMemberIndex; duke@1: duke@1: /** duke@1: * Construct a new AnnotationTypeRequiredMemberBuilder. duke@1: * duke@1: * @param configuration the current configuration of the duke@1: * doclet. duke@1: */ duke@1: protected AnnotationTypeRequiredMemberBuilder(Configuration configuration) { duke@1: super(configuration); duke@1: } duke@1: duke@1: duke@1: /** duke@1: * Construct a new AnnotationTypeMemberBuilder. duke@1: * duke@1: * @param configuration the current configuration of the doclet. duke@1: * @param classDoc the class whoses members are being documented. duke@1: * @param writer the doclet specific writer. duke@1: */ duke@1: public static AnnotationTypeRequiredMemberBuilder getInstance( duke@1: Configuration configuration, ClassDoc classDoc, duke@1: AnnotationTypeRequiredMemberWriter writer) { duke@1: AnnotationTypeRequiredMemberBuilder builder = duke@1: new AnnotationTypeRequiredMemberBuilder(configuration); duke@1: builder.classDoc = classDoc; duke@1: builder.writer = writer; duke@1: builder.visibleMemberMap = new VisibleMemberMap(classDoc, duke@1: VisibleMemberMap.ANNOTATION_TYPE_MEMBER_REQUIRED, configuration.nodeprecated); jjg@74: builder.members = new ArrayList( duke@1: builder.visibleMemberMap.getMembersFor(classDoc)); duke@1: if (configuration.getMemberComparator() != null) { duke@1: Collections.sort(builder.members, duke@1: configuration.getMemberComparator()); duke@1: } duke@1: return builder; duke@1: } duke@1: duke@1: /** duke@1: * {@inheritDoc} duke@1: */ duke@1: public String getName() { duke@1: return "AnnotationTypeRequiredMemberDetails"; duke@1: } duke@1: duke@1: /** duke@1: * Returns a list of members that will be documented for the given class. duke@1: * This information can be used for doclet specific documentation duke@1: * generation. duke@1: * duke@1: * @param classDoc the {@link ClassDoc} we want to check. duke@1: * @return a list of members that will be documented. duke@1: */ mcimadamore@184: public List members(ClassDoc classDoc) { duke@1: return visibleMemberMap.getMembersFor(classDoc); duke@1: } duke@1: duke@1: /** duke@1: * Returns the visible member map for the members of this class. duke@1: * duke@1: * @return the visible member map for the members of this class. duke@1: */ duke@1: public VisibleMemberMap getVisibleMemberMap() { duke@1: return visibleMemberMap; duke@1: } duke@1: duke@1: /** duke@1: * summaryOrder.size() duke@1: */ duke@1: public boolean hasMembersToDocument() { duke@1: return members.size() > 0; duke@1: } duke@1: duke@1: /** duke@1: * Build the member documentation. duke@1: * duke@1: * @param elements the XML elements that specify how to construct this duke@1: * documentation. duke@1: */ jjg@589: public void buildAnnotationTypeRequiredMember(XMLNode node) { duke@1: if (writer == null) { duke@1: return; duke@1: } duke@1: for (currentMemberIndex = 0; currentMemberIndex < members.size(); duke@1: currentMemberIndex++) { jjg@589: buildChildren(node); duke@1: } duke@1: } duke@1: duke@1: /** duke@1: * Build the overall header. duke@1: */ jjg@589: public void buildHeader(XMLNode node) { duke@1: writer.writeHeader(classDoc, duke@1: configuration.getText("doclet.Annotation_Type_Member_Detail")); duke@1: } duke@1: duke@1: /** duke@1: * Build the header for the individual members. duke@1: */ jjg@589: public void buildMemberHeader(XMLNode node) { duke@1: writer.writeMemberHeader((MemberDoc) members.get( duke@1: currentMemberIndex), duke@1: currentMemberIndex == 0); duke@1: } duke@1: duke@1: /** duke@1: * Build the signature. duke@1: */ jjg@589: public void buildSignature(XMLNode node) { duke@1: writer.writeSignature((MemberDoc) members.get(currentMemberIndex)); duke@1: } duke@1: duke@1: /** duke@1: * Build the deprecation information. duke@1: */ jjg@589: public void buildDeprecationInfo(XMLNode node) { duke@1: writer.writeDeprecated((MemberDoc) members.get(currentMemberIndex)); duke@1: } duke@1: duke@1: /** duke@1: * Build the comments for the member. Do nothing if duke@1: * {@link Configuration#nocomment} is set to true. duke@1: */ jjg@589: public void buildMemberComments(XMLNode node) { duke@1: if(! configuration.nocomment){ duke@1: writer.writeComments((MemberDoc) members.get(currentMemberIndex)); duke@1: } duke@1: } duke@1: duke@1: /** duke@1: * Build the tag information. duke@1: */ jjg@589: public void buildTagInfo(XMLNode node) { duke@1: writer.writeTags((MemberDoc) members.get(currentMemberIndex)); duke@1: } duke@1: duke@1: /** duke@1: * Build the footer for the individual member. duke@1: */ jjg@589: public void buildMemberFooter(XMLNode node) { duke@1: writer.writeMemberFooter(); duke@1: } duke@1: duke@1: /** duke@1: * Build the overall footer. duke@1: */ jjg@589: public void buildFooter(XMLNode node) { duke@1: writer.writeFooter(classDoc); duke@1: } duke@1: duke@1: /** duke@1: * Return the annotation type required member writer for this builder. duke@1: * duke@1: * @return the annotation type required member constant writer for this duke@1: * builder. duke@1: */ duke@1: public AnnotationTypeRequiredMemberWriter getWriter() { duke@1: return writer; duke@1: } duke@1: }