Wed, 31 Oct 2012 13:48:15 -0700
8001664: refactor javadoc to use abstraction to handle files
Reviewed-by: darcy
duke@1 | 1 | /* |
jjg@1357 | 2 | * Copyright (c) 2003, 2012, 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 | |
bpatel@766 | 28 | import java.util.*; |
jjg@1357 | 29 | |
jjg@1357 | 30 | import com.sun.javadoc.*; |
jjg@1357 | 31 | import com.sun.tools.doclets.internal.toolkit.*; |
duke@1 | 32 | import com.sun.tools.doclets.internal.toolkit.util.*; |
duke@1 | 33 | |
duke@1 | 34 | /** |
duke@1 | 35 | * Builds documentation for a constructor. |
duke@1 | 36 | * |
jjg@1359 | 37 | * <p><b>This is NOT part of any supported API. |
jjg@1359 | 38 | * If you write code that depends on this, you do so at your own risk. |
jjg@1359 | 39 | * This code and its internal interfaces are subject to change or |
jjg@1359 | 40 | * deletion without notice.</b> |
duke@1 | 41 | * |
duke@1 | 42 | * @author Jamie Ho |
bpatel@766 | 43 | * @author Bhavesh Patel (Modified) |
duke@1 | 44 | * @since 1.5 |
duke@1 | 45 | */ |
duke@1 | 46 | public class ConstructorBuilder extends AbstractMemberBuilder { |
duke@1 | 47 | |
bpatel@766 | 48 | /** |
bpatel@766 | 49 | * The name of this builder. |
bpatel@766 | 50 | */ |
bpatel@766 | 51 | public static final String NAME = "ConstructorDetails"; |
duke@1 | 52 | |
bpatel@766 | 53 | /** |
bpatel@766 | 54 | * The index of the current field that is being documented at this point |
bpatel@766 | 55 | * in time. |
bpatel@766 | 56 | */ |
bpatel@766 | 57 | private int currentConstructorIndex; |
duke@1 | 58 | |
bpatel@766 | 59 | /** |
bpatel@766 | 60 | * The class whose constructors are being documented. |
bpatel@766 | 61 | */ |
bpatel@766 | 62 | private ClassDoc classDoc; |
duke@1 | 63 | |
bpatel@766 | 64 | /** |
bpatel@766 | 65 | * The visible constructors for the given class. |
bpatel@766 | 66 | */ |
bpatel@766 | 67 | private VisibleMemberMap visibleMemberMap; |
duke@1 | 68 | |
bpatel@766 | 69 | /** |
bpatel@766 | 70 | * The writer to output the constructor documentation. |
bpatel@766 | 71 | */ |
bpatel@766 | 72 | private ConstructorWriter writer; |
duke@1 | 73 | |
bpatel@766 | 74 | /** |
bpatel@766 | 75 | * The constructors being documented. |
bpatel@766 | 76 | */ |
bpatel@766 | 77 | private List<ProgramElementDoc> constructors; |
duke@1 | 78 | |
bpatel@766 | 79 | /** |
bpatel@766 | 80 | * Construct a new ConstructorBuilder. |
bpatel@766 | 81 | * |
bpatel@766 | 82 | * @param configuration the current configuration of the |
bpatel@766 | 83 | * doclet. |
bpatel@766 | 84 | */ |
bpatel@766 | 85 | private ConstructorBuilder(Configuration configuration) { |
bpatel@766 | 86 | super(configuration); |
bpatel@766 | 87 | } |
bpatel@766 | 88 | |
bpatel@766 | 89 | /** |
bpatel@766 | 90 | * Construct a new ConstructorBuilder. |
bpatel@766 | 91 | * |
bpatel@766 | 92 | * @param configuration the current configuration of the doclet. |
bpatel@766 | 93 | * @param classDoc the class whoses members are being documented. |
bpatel@766 | 94 | * @param writer the doclet specific writer. |
bpatel@766 | 95 | */ |
bpatel@766 | 96 | public static ConstructorBuilder getInstance( |
bpatel@766 | 97 | Configuration configuration, |
bpatel@766 | 98 | ClassDoc classDoc, |
bpatel@766 | 99 | ConstructorWriter writer) { |
bpatel@766 | 100 | ConstructorBuilder builder = new ConstructorBuilder(configuration); |
bpatel@766 | 101 | builder.classDoc = classDoc; |
bpatel@766 | 102 | builder.writer = writer; |
bpatel@766 | 103 | builder.visibleMemberMap = |
bpatel@766 | 104 | new VisibleMemberMap( |
bpatel@766 | 105 | classDoc, |
bpatel@766 | 106 | VisibleMemberMap.CONSTRUCTORS, |
bpatel@766 | 107 | configuration.nodeprecated); |
bpatel@766 | 108 | builder.constructors = |
bpatel@766 | 109 | new ArrayList<ProgramElementDoc>(builder.visibleMemberMap.getMembersFor(classDoc)); |
bpatel@766 | 110 | for (int i = 0; i < builder.constructors.size(); i++) { |
bpatel@766 | 111 | if (builder.constructors.get(i).isProtected() |
bpatel@766 | 112 | || builder.constructors.get(i).isPrivate()) { |
bpatel@766 | 113 | writer.setFoundNonPubConstructor(true); |
bpatel@766 | 114 | } |
duke@1 | 115 | } |
bpatel@766 | 116 | if (configuration.getMemberComparator() != null) { |
bpatel@766 | 117 | Collections.sort( |
bpatel@766 | 118 | builder.constructors, |
bpatel@766 | 119 | configuration.getMemberComparator()); |
bpatel@766 | 120 | } |
bpatel@766 | 121 | return builder; |
bpatel@766 | 122 | } |
duke@1 | 123 | |
bpatel@766 | 124 | /** |
bpatel@766 | 125 | * {@inheritDoc} |
bpatel@766 | 126 | */ |
bpatel@766 | 127 | public String getName() { |
bpatel@766 | 128 | return NAME; |
bpatel@766 | 129 | } |
bpatel@766 | 130 | |
bpatel@766 | 131 | /** |
bpatel@766 | 132 | * {@inheritDoc} |
bpatel@766 | 133 | */ |
bpatel@766 | 134 | public boolean hasMembersToDocument() { |
bpatel@766 | 135 | return constructors.size() > 0; |
bpatel@766 | 136 | } |
bpatel@766 | 137 | |
bpatel@766 | 138 | /** |
bpatel@766 | 139 | * Returns a list of constructors that will be documented for the given class. |
bpatel@766 | 140 | * This information can be used for doclet specific documentation |
bpatel@766 | 141 | * generation. |
bpatel@766 | 142 | * |
bpatel@766 | 143 | * @return a list of constructors that will be documented. |
bpatel@766 | 144 | */ |
bpatel@766 | 145 | public List<ProgramElementDoc> members(ClassDoc classDoc) { |
bpatel@766 | 146 | return visibleMemberMap.getMembersFor(classDoc); |
bpatel@766 | 147 | } |
bpatel@766 | 148 | |
bpatel@766 | 149 | /** |
bpatel@766 | 150 | * Return the constructor writer for this builder. |
bpatel@766 | 151 | * |
bpatel@766 | 152 | * @return the constructor writer for this builder. |
bpatel@766 | 153 | */ |
bpatel@766 | 154 | public ConstructorWriter getWriter() { |
bpatel@766 | 155 | return writer; |
bpatel@766 | 156 | } |
bpatel@766 | 157 | |
bpatel@766 | 158 | /** |
bpatel@766 | 159 | * Build the constructor documentation. |
bpatel@766 | 160 | * |
bpatel@766 | 161 | * @param node the XML element that specifies which components to document |
bpatel@766 | 162 | * @param memberDetailsTree the content tree to which the documentation will be added |
bpatel@766 | 163 | */ |
bpatel@766 | 164 | public void buildConstructorDoc(XMLNode node, Content memberDetailsTree) { |
bpatel@766 | 165 | if (writer == null) { |
bpatel@766 | 166 | return; |
duke@1 | 167 | } |
bpatel@766 | 168 | int size = constructors.size(); |
bpatel@766 | 169 | if (size > 0) { |
bpatel@766 | 170 | Content constructorDetailsTree = writer.getConstructorDetailsTreeHeader( |
bpatel@766 | 171 | classDoc, memberDetailsTree); |
bpatel@766 | 172 | for (currentConstructorIndex = 0; currentConstructorIndex < size; |
bpatel@766 | 173 | currentConstructorIndex++) { |
bpatel@766 | 174 | Content constructorDocTree = writer.getConstructorDocTreeHeader( |
bpatel@766 | 175 | (ConstructorDoc) constructors.get(currentConstructorIndex), |
bpatel@766 | 176 | constructorDetailsTree); |
bpatel@766 | 177 | buildChildren(node, constructorDocTree); |
bpatel@766 | 178 | constructorDetailsTree.addContent(writer.getConstructorDoc( |
bpatel@766 | 179 | constructorDocTree, (currentConstructorIndex == size - 1))); |
bpatel@766 | 180 | } |
bpatel@766 | 181 | memberDetailsTree.addContent( |
bpatel@766 | 182 | writer.getConstructorDetails(constructorDetailsTree)); |
bpatel@766 | 183 | } |
bpatel@766 | 184 | } |
duke@1 | 185 | |
bpatel@766 | 186 | /** |
bpatel@766 | 187 | * Build the signature. |
bpatel@766 | 188 | * |
bpatel@766 | 189 | * @param node the XML element that specifies which components to document |
bpatel@766 | 190 | * @param constructorDocTree the content tree to which the documentation will be added |
bpatel@766 | 191 | */ |
bpatel@766 | 192 | public void buildSignature(XMLNode node, Content constructorDocTree) { |
bpatel@766 | 193 | constructorDocTree.addContent( |
bpatel@766 | 194 | writer.getSignature( |
bpatel@766 | 195 | (ConstructorDoc) constructors.get(currentConstructorIndex))); |
bpatel@766 | 196 | } |
bpatel@766 | 197 | |
bpatel@766 | 198 | /** |
bpatel@766 | 199 | * Build the deprecation information. |
bpatel@766 | 200 | * |
bpatel@766 | 201 | * @param node the XML element that specifies which components to document |
bpatel@766 | 202 | * @param constructorDocTree the content tree to which the documentation will be added |
bpatel@766 | 203 | */ |
bpatel@766 | 204 | public void buildDeprecationInfo(XMLNode node, Content constructorDocTree) { |
bpatel@766 | 205 | writer.addDeprecated( |
bpatel@766 | 206 | (ConstructorDoc) constructors.get(currentConstructorIndex), constructorDocTree); |
bpatel@766 | 207 | } |
bpatel@766 | 208 | |
bpatel@766 | 209 | /** |
bpatel@766 | 210 | * Build the comments for the constructor. Do nothing if |
bpatel@766 | 211 | * {@link Configuration#nocomment} is set to true. |
bpatel@766 | 212 | * |
bpatel@766 | 213 | * @param node the XML element that specifies which components to document |
bpatel@766 | 214 | * @param constructorDocTree the content tree to which the documentation will be added |
bpatel@766 | 215 | */ |
bpatel@766 | 216 | public void buildConstructorComments(XMLNode node, Content constructorDocTree) { |
bpatel@766 | 217 | if (!configuration.nocomment) { |
bpatel@766 | 218 | writer.addComments( |
bpatel@766 | 219 | (ConstructorDoc) constructors.get(currentConstructorIndex), |
bpatel@766 | 220 | constructorDocTree); |
duke@1 | 221 | } |
bpatel@766 | 222 | } |
duke@1 | 223 | |
bpatel@766 | 224 | /** |
bpatel@766 | 225 | * Build the tag information. |
bpatel@766 | 226 | * |
bpatel@766 | 227 | * @param node the XML element that specifies which components to document |
bpatel@766 | 228 | * @param constructorDocTree the content tree to which the documentation will be added |
bpatel@766 | 229 | */ |
bpatel@766 | 230 | public void buildTagInfo(XMLNode node, Content constructorDocTree) { |
bpatel@766 | 231 | writer.addTags((ConstructorDoc) constructors.get(currentConstructorIndex), |
bpatel@766 | 232 | constructorDocTree); |
bpatel@766 | 233 | } |
duke@1 | 234 | } |