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