Sat, 07 Nov 2020 10:30:02 +0800
Added tag mips-jdk8u275-b01 for changeset eb6ee6a5f2fe
aoqi@0 | 1 | /* |
aoqi@0 | 2 | * Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved. |
aoqi@0 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
aoqi@0 | 4 | * |
aoqi@0 | 5 | * This code is free software; you can redistribute it and/or modify it |
aoqi@0 | 6 | * under the terms of the GNU General Public License version 2 only, as |
aoqi@0 | 7 | * published by the Free Software Foundation. Oracle designates this |
aoqi@0 | 8 | * particular file as subject to the "Classpath" exception as provided |
aoqi@0 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
aoqi@0 | 10 | * |
aoqi@0 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
aoqi@0 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
aoqi@0 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
aoqi@0 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
aoqi@0 | 15 | * accompanied this code). |
aoqi@0 | 16 | * |
aoqi@0 | 17 | * You should have received a copy of the GNU General Public License version |
aoqi@0 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
aoqi@0 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
aoqi@0 | 20 | * |
aoqi@0 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
aoqi@0 | 22 | * or visit www.oracle.com if you need additional information or have any |
aoqi@0 | 23 | * questions. |
aoqi@0 | 24 | */ |
aoqi@0 | 25 | |
aoqi@0 | 26 | package com.sun.tools.doclets.internal.toolkit.builders; |
aoqi@0 | 27 | |
aoqi@0 | 28 | import java.util.*; |
aoqi@0 | 29 | |
aoqi@0 | 30 | import com.sun.javadoc.*; |
aoqi@0 | 31 | import com.sun.tools.doclets.internal.toolkit.*; |
aoqi@0 | 32 | import com.sun.tools.doclets.internal.toolkit.util.*; |
aoqi@0 | 33 | |
aoqi@0 | 34 | /** |
aoqi@0 | 35 | * Builds documentation for annotation type fields. |
aoqi@0 | 36 | * |
aoqi@0 | 37 | * <p><b>This is NOT part of any supported API. |
aoqi@0 | 38 | * If you write code that depends on this, you do so at your own risk. |
aoqi@0 | 39 | * This code and its internal interfaces are subject to change or |
aoqi@0 | 40 | * deletion without notice.</b> |
aoqi@0 | 41 | * |
aoqi@0 | 42 | * @author Bhavesh Patel |
aoqi@0 | 43 | * @since 1.8 |
aoqi@0 | 44 | */ |
aoqi@0 | 45 | public class AnnotationTypeFieldBuilder extends AbstractMemberBuilder { |
aoqi@0 | 46 | |
aoqi@0 | 47 | /** |
aoqi@0 | 48 | * The annotation type whose members are being documented. |
aoqi@0 | 49 | */ |
aoqi@0 | 50 | protected ClassDoc classDoc; |
aoqi@0 | 51 | |
aoqi@0 | 52 | /** |
aoqi@0 | 53 | * The visible members for the given class. |
aoqi@0 | 54 | */ |
aoqi@0 | 55 | protected VisibleMemberMap visibleMemberMap; |
aoqi@0 | 56 | |
aoqi@0 | 57 | /** |
aoqi@0 | 58 | * The writer to output the member documentation. |
aoqi@0 | 59 | */ |
aoqi@0 | 60 | protected AnnotationTypeFieldWriter writer; |
aoqi@0 | 61 | |
aoqi@0 | 62 | /** |
aoqi@0 | 63 | * The list of members being documented. |
aoqi@0 | 64 | */ |
aoqi@0 | 65 | protected List<ProgramElementDoc> members; |
aoqi@0 | 66 | |
aoqi@0 | 67 | /** |
aoqi@0 | 68 | * The index of the current member that is being documented at this point |
aoqi@0 | 69 | * in time. |
aoqi@0 | 70 | */ |
aoqi@0 | 71 | protected int currentMemberIndex; |
aoqi@0 | 72 | |
aoqi@0 | 73 | /** |
aoqi@0 | 74 | * Construct a new AnnotationTypeFieldsBuilder. |
aoqi@0 | 75 | * |
aoqi@0 | 76 | * @param context the build context. |
aoqi@0 | 77 | * @param classDoc the class whose members are being documented. |
aoqi@0 | 78 | * @param writer the doclet specific writer. |
aoqi@0 | 79 | * @param memberType the type of member that is being documented. |
aoqi@0 | 80 | */ |
aoqi@0 | 81 | protected AnnotationTypeFieldBuilder(Context context, |
aoqi@0 | 82 | ClassDoc classDoc, |
aoqi@0 | 83 | AnnotationTypeFieldWriter writer, |
aoqi@0 | 84 | int memberType) { |
aoqi@0 | 85 | super(context); |
aoqi@0 | 86 | this.classDoc = classDoc; |
aoqi@0 | 87 | this.writer = writer; |
aoqi@0 | 88 | this.visibleMemberMap = new VisibleMemberMap(classDoc, memberType, |
aoqi@0 | 89 | configuration); |
aoqi@0 | 90 | this.members = new ArrayList<ProgramElementDoc>( |
aoqi@0 | 91 | this.visibleMemberMap.getMembersFor(classDoc)); |
aoqi@0 | 92 | if (configuration.getMemberComparator() != null) { |
aoqi@0 | 93 | Collections.sort(this.members, configuration.getMemberComparator()); |
aoqi@0 | 94 | } |
aoqi@0 | 95 | } |
aoqi@0 | 96 | |
aoqi@0 | 97 | |
aoqi@0 | 98 | /** |
aoqi@0 | 99 | * Construct a new AnnotationTypeFieldBuilder. |
aoqi@0 | 100 | * |
aoqi@0 | 101 | * @param context the build context. |
aoqi@0 | 102 | * @param classDoc the class whose members are being documented. |
aoqi@0 | 103 | * @param writer the doclet specific writer. |
aoqi@0 | 104 | */ |
aoqi@0 | 105 | public static AnnotationTypeFieldBuilder getInstance( |
aoqi@0 | 106 | Context context, ClassDoc classDoc, |
aoqi@0 | 107 | AnnotationTypeFieldWriter writer) { |
aoqi@0 | 108 | return new AnnotationTypeFieldBuilder(context, classDoc, |
aoqi@0 | 109 | writer, VisibleMemberMap.ANNOTATION_TYPE_FIELDS); |
aoqi@0 | 110 | } |
aoqi@0 | 111 | |
aoqi@0 | 112 | /** |
aoqi@0 | 113 | * {@inheritDoc} |
aoqi@0 | 114 | */ |
aoqi@0 | 115 | public String getName() { |
aoqi@0 | 116 | return "AnnotationTypeFieldDetails"; |
aoqi@0 | 117 | } |
aoqi@0 | 118 | |
aoqi@0 | 119 | /** |
aoqi@0 | 120 | * Returns a list of members that will be documented for the given class. |
aoqi@0 | 121 | * This information can be used for doclet specific documentation |
aoqi@0 | 122 | * generation. |
aoqi@0 | 123 | * |
aoqi@0 | 124 | * @param classDoc the {@link ClassDoc} we want to check. |
aoqi@0 | 125 | * @return a list of members that will be documented. |
aoqi@0 | 126 | */ |
aoqi@0 | 127 | public List<ProgramElementDoc> members(ClassDoc classDoc) { |
aoqi@0 | 128 | return visibleMemberMap.getMembersFor(classDoc); |
aoqi@0 | 129 | } |
aoqi@0 | 130 | |
aoqi@0 | 131 | /** |
aoqi@0 | 132 | * Returns the visible member map for the members of this class. |
aoqi@0 | 133 | * |
aoqi@0 | 134 | * @return the visible member map for the members of this class. |
aoqi@0 | 135 | */ |
aoqi@0 | 136 | public VisibleMemberMap getVisibleMemberMap() { |
aoqi@0 | 137 | return visibleMemberMap; |
aoqi@0 | 138 | } |
aoqi@0 | 139 | |
aoqi@0 | 140 | /** |
aoqi@0 | 141 | * summaryOrder.size() |
aoqi@0 | 142 | */ |
aoqi@0 | 143 | public boolean hasMembersToDocument() { |
aoqi@0 | 144 | return members.size() > 0; |
aoqi@0 | 145 | } |
aoqi@0 | 146 | |
aoqi@0 | 147 | /** |
aoqi@0 | 148 | * Build the annotation type field documentation. |
aoqi@0 | 149 | * |
aoqi@0 | 150 | * @param node the XML element that specifies which components to document |
aoqi@0 | 151 | * @param memberDetailsTree the content tree to which the documentation will be added |
aoqi@0 | 152 | */ |
aoqi@0 | 153 | public void buildAnnotationTypeField(XMLNode node, Content memberDetailsTree) { |
aoqi@0 | 154 | buildAnnotationTypeMember(node, memberDetailsTree); |
aoqi@0 | 155 | } |
aoqi@0 | 156 | |
aoqi@0 | 157 | /** |
aoqi@0 | 158 | * Build the member documentation. |
aoqi@0 | 159 | * |
aoqi@0 | 160 | * @param node the XML element that specifies which components to document |
aoqi@0 | 161 | * @param memberDetailsTree the content tree to which the documentation will be added |
aoqi@0 | 162 | */ |
aoqi@0 | 163 | public void buildAnnotationTypeMember(XMLNode node, Content memberDetailsTree) { |
aoqi@0 | 164 | if (writer == null) { |
aoqi@0 | 165 | return; |
aoqi@0 | 166 | } |
aoqi@0 | 167 | int size = members.size(); |
aoqi@0 | 168 | if (size > 0) { |
aoqi@0 | 169 | writer.addAnnotationFieldDetailsMarker(memberDetailsTree); |
aoqi@0 | 170 | for (currentMemberIndex = 0; currentMemberIndex < size; |
aoqi@0 | 171 | currentMemberIndex++) { |
aoqi@0 | 172 | Content detailsTree = writer.getMemberTreeHeader(); |
aoqi@0 | 173 | writer.addAnnotationDetailsTreeHeader(classDoc, detailsTree); |
aoqi@0 | 174 | Content annotationDocTree = writer.getAnnotationDocTreeHeader( |
aoqi@0 | 175 | (MemberDoc) members.get(currentMemberIndex), |
aoqi@0 | 176 | detailsTree); |
aoqi@0 | 177 | buildChildren(node, annotationDocTree); |
aoqi@0 | 178 | detailsTree.addContent(writer.getAnnotationDoc( |
aoqi@0 | 179 | annotationDocTree, (currentMemberIndex == size - 1))); |
aoqi@0 | 180 | memberDetailsTree.addContent(writer.getAnnotationDetails(detailsTree)); |
aoqi@0 | 181 | } |
aoqi@0 | 182 | } |
aoqi@0 | 183 | } |
aoqi@0 | 184 | |
aoqi@0 | 185 | /** |
aoqi@0 | 186 | * Build the signature. |
aoqi@0 | 187 | * |
aoqi@0 | 188 | * @param node the XML element that specifies which components to document |
aoqi@0 | 189 | * @param annotationDocTree the content tree to which the documentation will be added |
aoqi@0 | 190 | */ |
aoqi@0 | 191 | public void buildSignature(XMLNode node, Content annotationDocTree) { |
aoqi@0 | 192 | annotationDocTree.addContent( |
aoqi@0 | 193 | writer.getSignature((MemberDoc) members.get(currentMemberIndex))); |
aoqi@0 | 194 | } |
aoqi@0 | 195 | |
aoqi@0 | 196 | /** |
aoqi@0 | 197 | * Build the deprecation information. |
aoqi@0 | 198 | * |
aoqi@0 | 199 | * @param node the XML element that specifies which components to document |
aoqi@0 | 200 | * @param annotationDocTree the content tree to which the documentation will be added |
aoqi@0 | 201 | */ |
aoqi@0 | 202 | public void buildDeprecationInfo(XMLNode node, Content annotationDocTree) { |
aoqi@0 | 203 | writer.addDeprecated((MemberDoc) members.get(currentMemberIndex), |
aoqi@0 | 204 | annotationDocTree); |
aoqi@0 | 205 | } |
aoqi@0 | 206 | |
aoqi@0 | 207 | /** |
aoqi@0 | 208 | * Build the comments for the member. Do nothing if |
aoqi@0 | 209 | * {@link Configuration#nocomment} is set to true. |
aoqi@0 | 210 | * |
aoqi@0 | 211 | * @param node the XML element that specifies which components to document |
aoqi@0 | 212 | * @param annotationDocTree the content tree to which the documentation will be added |
aoqi@0 | 213 | */ |
aoqi@0 | 214 | public void buildMemberComments(XMLNode node, Content annotationDocTree) { |
aoqi@0 | 215 | if(! configuration.nocomment){ |
aoqi@0 | 216 | writer.addComments((MemberDoc) members.get(currentMemberIndex), |
aoqi@0 | 217 | annotationDocTree); |
aoqi@0 | 218 | } |
aoqi@0 | 219 | } |
aoqi@0 | 220 | |
aoqi@0 | 221 | /** |
aoqi@0 | 222 | * Build the tag information. |
aoqi@0 | 223 | * |
aoqi@0 | 224 | * @param node the XML element that specifies which components to document |
aoqi@0 | 225 | * @param annotationDocTree the content tree to which the documentation will be added |
aoqi@0 | 226 | */ |
aoqi@0 | 227 | public void buildTagInfo(XMLNode node, Content annotationDocTree) { |
aoqi@0 | 228 | writer.addTags((MemberDoc) members.get(currentMemberIndex), |
aoqi@0 | 229 | annotationDocTree); |
aoqi@0 | 230 | } |
aoqi@0 | 231 | |
aoqi@0 | 232 | /** |
aoqi@0 | 233 | * Return the annotation type field writer for this builder. |
aoqi@0 | 234 | * |
aoqi@0 | 235 | * @return the annotation type field writer for this builder. |
aoqi@0 | 236 | */ |
aoqi@0 | 237 | public AnnotationTypeFieldWriter getWriter() { |
aoqi@0 | 238 | return writer; |
aoqi@0 | 239 | } |
aoqi@0 | 240 | } |