Fri, 18 Jun 2010 21:13:56 -0700
6961178: Allow doclet.xml to contain XML attributes
Reviewed-by: bpatel
duke@1 | 1 | /* |
ohair@554 | 2 | * Copyright (c) 2003, 2008, Oracle and/or its affiliates. All rights reserved. |
duke@1 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
duke@1 | 4 | * |
duke@1 | 5 | * This code is free software; you can redistribute it and/or modify it |
duke@1 | 6 | * under the terms of the GNU General Public License version 2 only, as |
ohair@554 | 7 | * published by the Free Software Foundation. Oracle designates this |
duke@1 | 8 | * particular file as subject to the "Classpath" exception as provided |
ohair@554 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
duke@1 | 10 | * |
duke@1 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
duke@1 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
duke@1 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
duke@1 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
duke@1 | 15 | * accompanied this code). |
duke@1 | 16 | * |
duke@1 | 17 | * You should have received a copy of the GNU General Public License version |
duke@1 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
duke@1 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
duke@1 | 20 | * |
ohair@554 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
ohair@554 | 22 | * or visit www.oracle.com if you need additional information or have any |
ohair@554 | 23 | * questions. |
duke@1 | 24 | */ |
duke@1 | 25 | |
duke@1 | 26 | package com.sun.tools.doclets.internal.toolkit.builders; |
duke@1 | 27 | |
duke@1 | 28 | |
duke@1 | 29 | import com.sun.tools.doclets.internal.toolkit.util.*; |
duke@1 | 30 | import com.sun.tools.doclets.internal.toolkit.*; |
duke@1 | 31 | import com.sun.javadoc.*; |
duke@1 | 32 | import java.util.*; |
duke@1 | 33 | |
duke@1 | 34 | /** |
duke@1 | 35 | * Builds documentation for required annotation type members. |
duke@1 | 36 | * |
duke@1 | 37 | * This code is not part of an API. |
duke@1 | 38 | * It is implementation that is subject to change. |
duke@1 | 39 | * Do not use it as an API |
duke@1 | 40 | * |
duke@1 | 41 | * @author Jamie Ho |
duke@1 | 42 | * @since 1.5 |
duke@1 | 43 | */ |
duke@1 | 44 | public class AnnotationTypeRequiredMemberBuilder extends AbstractMemberBuilder { |
duke@1 | 45 | |
duke@1 | 46 | /** |
duke@1 | 47 | * The annotation type whose members are being documented. |
duke@1 | 48 | */ |
duke@1 | 49 | protected ClassDoc classDoc; |
duke@1 | 50 | |
duke@1 | 51 | /** |
duke@1 | 52 | * The visible members for the given class. |
duke@1 | 53 | */ |
duke@1 | 54 | protected VisibleMemberMap visibleMemberMap; |
duke@1 | 55 | |
duke@1 | 56 | /** |
duke@1 | 57 | * The writer to output the member documentation. |
duke@1 | 58 | */ |
duke@1 | 59 | protected AnnotationTypeRequiredMemberWriter writer; |
duke@1 | 60 | |
duke@1 | 61 | /** |
duke@1 | 62 | * The list of members being documented. |
duke@1 | 63 | */ |
jjg@74 | 64 | protected List<ProgramElementDoc> members; |
duke@1 | 65 | |
duke@1 | 66 | /** |
duke@1 | 67 | * The index of the current member that is being documented at this point |
duke@1 | 68 | * in time. |
duke@1 | 69 | */ |
duke@1 | 70 | protected int currentMemberIndex; |
duke@1 | 71 | |
duke@1 | 72 | /** |
duke@1 | 73 | * Construct a new AnnotationTypeRequiredMemberBuilder. |
duke@1 | 74 | * |
duke@1 | 75 | * @param configuration the current configuration of the |
duke@1 | 76 | * doclet. |
duke@1 | 77 | */ |
duke@1 | 78 | protected AnnotationTypeRequiredMemberBuilder(Configuration configuration) { |
duke@1 | 79 | super(configuration); |
duke@1 | 80 | } |
duke@1 | 81 | |
duke@1 | 82 | |
duke@1 | 83 | /** |
duke@1 | 84 | * Construct a new AnnotationTypeMemberBuilder. |
duke@1 | 85 | * |
duke@1 | 86 | * @param configuration the current configuration of the doclet. |
duke@1 | 87 | * @param classDoc the class whoses members are being documented. |
duke@1 | 88 | * @param writer the doclet specific writer. |
duke@1 | 89 | */ |
duke@1 | 90 | public static AnnotationTypeRequiredMemberBuilder getInstance( |
duke@1 | 91 | Configuration configuration, ClassDoc classDoc, |
duke@1 | 92 | AnnotationTypeRequiredMemberWriter writer) { |
duke@1 | 93 | AnnotationTypeRequiredMemberBuilder builder = |
duke@1 | 94 | new AnnotationTypeRequiredMemberBuilder(configuration); |
duke@1 | 95 | builder.classDoc = classDoc; |
duke@1 | 96 | builder.writer = writer; |
duke@1 | 97 | builder.visibleMemberMap = new VisibleMemberMap(classDoc, |
duke@1 | 98 | VisibleMemberMap.ANNOTATION_TYPE_MEMBER_REQUIRED, configuration.nodeprecated); |
jjg@74 | 99 | builder.members = new ArrayList<ProgramElementDoc>( |
duke@1 | 100 | builder.visibleMemberMap.getMembersFor(classDoc)); |
duke@1 | 101 | if (configuration.getMemberComparator() != null) { |
duke@1 | 102 | Collections.sort(builder.members, |
duke@1 | 103 | configuration.getMemberComparator()); |
duke@1 | 104 | } |
duke@1 | 105 | return builder; |
duke@1 | 106 | } |
duke@1 | 107 | |
duke@1 | 108 | /** |
duke@1 | 109 | * {@inheritDoc} |
duke@1 | 110 | */ |
duke@1 | 111 | public String getName() { |
duke@1 | 112 | return "AnnotationTypeRequiredMemberDetails"; |
duke@1 | 113 | } |
duke@1 | 114 | |
duke@1 | 115 | /** |
duke@1 | 116 | * Returns a list of members that will be documented for the given class. |
duke@1 | 117 | * This information can be used for doclet specific documentation |
duke@1 | 118 | * generation. |
duke@1 | 119 | * |
duke@1 | 120 | * @param classDoc the {@link ClassDoc} we want to check. |
duke@1 | 121 | * @return a list of members that will be documented. |
duke@1 | 122 | */ |
mcimadamore@184 | 123 | public List<ProgramElementDoc> members(ClassDoc classDoc) { |
duke@1 | 124 | return visibleMemberMap.getMembersFor(classDoc); |
duke@1 | 125 | } |
duke@1 | 126 | |
duke@1 | 127 | /** |
duke@1 | 128 | * Returns the visible member map for the members of this class. |
duke@1 | 129 | * |
duke@1 | 130 | * @return the visible member map for the members of this class. |
duke@1 | 131 | */ |
duke@1 | 132 | public VisibleMemberMap getVisibleMemberMap() { |
duke@1 | 133 | return visibleMemberMap; |
duke@1 | 134 | } |
duke@1 | 135 | |
duke@1 | 136 | /** |
duke@1 | 137 | * summaryOrder.size() |
duke@1 | 138 | */ |
duke@1 | 139 | public boolean hasMembersToDocument() { |
duke@1 | 140 | return members.size() > 0; |
duke@1 | 141 | } |
duke@1 | 142 | |
duke@1 | 143 | /** |
duke@1 | 144 | * Build the member documentation. |
duke@1 | 145 | * |
duke@1 | 146 | * @param elements the XML elements that specify how to construct this |
duke@1 | 147 | * documentation. |
duke@1 | 148 | */ |
jjg@589 | 149 | public void buildAnnotationTypeRequiredMember(XMLNode node) { |
duke@1 | 150 | if (writer == null) { |
duke@1 | 151 | return; |
duke@1 | 152 | } |
duke@1 | 153 | for (currentMemberIndex = 0; currentMemberIndex < members.size(); |
duke@1 | 154 | currentMemberIndex++) { |
jjg@589 | 155 | buildChildren(node); |
duke@1 | 156 | } |
duke@1 | 157 | } |
duke@1 | 158 | |
duke@1 | 159 | /** |
duke@1 | 160 | * Build the overall header. |
duke@1 | 161 | */ |
jjg@589 | 162 | public void buildHeader(XMLNode node) { |
duke@1 | 163 | writer.writeHeader(classDoc, |
duke@1 | 164 | configuration.getText("doclet.Annotation_Type_Member_Detail")); |
duke@1 | 165 | } |
duke@1 | 166 | |
duke@1 | 167 | /** |
duke@1 | 168 | * Build the header for the individual members. |
duke@1 | 169 | */ |
jjg@589 | 170 | public void buildMemberHeader(XMLNode node) { |
duke@1 | 171 | writer.writeMemberHeader((MemberDoc) members.get( |
duke@1 | 172 | currentMemberIndex), |
duke@1 | 173 | currentMemberIndex == 0); |
duke@1 | 174 | } |
duke@1 | 175 | |
duke@1 | 176 | /** |
duke@1 | 177 | * Build the signature. |
duke@1 | 178 | */ |
jjg@589 | 179 | public void buildSignature(XMLNode node) { |
duke@1 | 180 | writer.writeSignature((MemberDoc) members.get(currentMemberIndex)); |
duke@1 | 181 | } |
duke@1 | 182 | |
duke@1 | 183 | /** |
duke@1 | 184 | * Build the deprecation information. |
duke@1 | 185 | */ |
jjg@589 | 186 | public void buildDeprecationInfo(XMLNode node) { |
duke@1 | 187 | writer.writeDeprecated((MemberDoc) members.get(currentMemberIndex)); |
duke@1 | 188 | } |
duke@1 | 189 | |
duke@1 | 190 | /** |
duke@1 | 191 | * Build the comments for the member. Do nothing if |
duke@1 | 192 | * {@link Configuration#nocomment} is set to true. |
duke@1 | 193 | */ |
jjg@589 | 194 | public void buildMemberComments(XMLNode node) { |
duke@1 | 195 | if(! configuration.nocomment){ |
duke@1 | 196 | writer.writeComments((MemberDoc) members.get(currentMemberIndex)); |
duke@1 | 197 | } |
duke@1 | 198 | } |
duke@1 | 199 | |
duke@1 | 200 | /** |
duke@1 | 201 | * Build the tag information. |
duke@1 | 202 | */ |
jjg@589 | 203 | public void buildTagInfo(XMLNode node) { |
duke@1 | 204 | writer.writeTags((MemberDoc) members.get(currentMemberIndex)); |
duke@1 | 205 | } |
duke@1 | 206 | |
duke@1 | 207 | /** |
duke@1 | 208 | * Build the footer for the individual member. |
duke@1 | 209 | */ |
jjg@589 | 210 | public void buildMemberFooter(XMLNode node) { |
duke@1 | 211 | writer.writeMemberFooter(); |
duke@1 | 212 | } |
duke@1 | 213 | |
duke@1 | 214 | /** |
duke@1 | 215 | * Build the overall footer. |
duke@1 | 216 | */ |
jjg@589 | 217 | public void buildFooter(XMLNode node) { |
duke@1 | 218 | writer.writeFooter(classDoc); |
duke@1 | 219 | } |
duke@1 | 220 | |
duke@1 | 221 | /** |
duke@1 | 222 | * Return the annotation type required member writer for this builder. |
duke@1 | 223 | * |
duke@1 | 224 | * @return the annotation type required member constant writer for this |
duke@1 | 225 | * builder. |
duke@1 | 226 | */ |
duke@1 | 227 | public AnnotationTypeRequiredMemberWriter getWriter() { |
duke@1 | 228 | return writer; |
duke@1 | 229 | } |
duke@1 | 230 | } |