src/share/classes/com/sun/tools/doclets/internal/toolkit/builders/ConstructorBuilder.java

Tue, 09 Oct 2012 19:10:00 -0700

author
jjg
date
Tue, 09 Oct 2012 19:10:00 -0700
changeset 1357
c75be5bc5283
parent 798
4868a36f6fd8
child 1359
25e14ad23cef
permissions
-rw-r--r--

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

mercurial