1 /*
2 * Copyright (c) 2003, 2019, 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 */
25
26 package jdk.javadoc.internal.doclets.toolkit.builders;
27
28 import java.util.*;
29
30 import javax.lang.model.element.Element;
31 import javax.lang.model.element.ExecutableElement;
32 import javax.lang.model.element.TypeElement;
33
34 import jdk.javadoc.internal.doclets.toolkit.BaseConfiguration;
35 import jdk.javadoc.internal.doclets.toolkit.Content;
36 import jdk.javadoc.internal.doclets.toolkit.DocletException;
37 import jdk.javadoc.internal.doclets.toolkit.PropertyWriter;
38
39 import static jdk.javadoc.internal.doclets.toolkit.util.VisibleMemberTable.Kind.*;
40
41 /**
42 * Builds documentation for a property.
43 *
44 * <p><b>This is NOT part of any supported API.
45 * If you write code that depends on this, you do so at your own risk.
46 * This code and its internal interfaces are subject to change or
47 * deletion without notice.</b>
48 */
49 public class PropertyBuilder extends AbstractMemberBuilder {
50
51 /**
52 * The writer to output the property documentation.
53 */
54 private final PropertyWriter writer;
55
56 /**
57 * The list of properties being documented.
58 */
59 private final List<? extends Element> properties;
60
61 /**
62 * The index of the current property that is being documented at this point
63 * in time.
64 */
65 private ExecutableElement currentProperty;
66
67 /**
68 * Construct a new PropertyBuilder.
69 *
70 * @param context the build context.
71 * @param typeElement the class whose members are being documented.
72 * @param writer the doclet specific writer.
73 */
74 private PropertyBuilder(Context context,
75 TypeElement typeElement,
76 PropertyWriter writer) {
77 super(context, typeElement);
78 this.writer = writer;
79 properties = getVisibleMembers(PROPERTIES);
80 }
81
82 /**
83 * Construct a new PropertyBuilder.
84 *
85 * @param context the build context.
86 * @param typeElement the class whose members are being documented.
87 * @param writer the doclet specific writer.
88 * @return the new PropertyBuilder
89 */
90 public static PropertyBuilder getInstance(Context context,
91 TypeElement typeElement,
92 PropertyWriter writer) {
93 return new PropertyBuilder(context, typeElement, writer);
94 }
95
96 /**
97 * Returns whether or not there are members to document.
98 *
99 * @return whether or not there are members to document
100 */
101 @Override
102 public boolean hasMembersToDocument() {
103 return !properties.isEmpty();
104 }
105
106 /**
107 * {@inheritDoc}
108 */
109 @Override
110 public void build(Content contentTree) throws DocletException {
111 buildPropertyDoc(contentTree);
112 }
113
114 /**
115 * Build the property documentation.
116 *
117 * @param memberDetailsTree the content tree to which the documentation will be added
118 * @throws DocletException if there is a problem while building the documentation
119 */
120 protected void buildPropertyDoc(Content memberDetailsTree) throws DocletException {
121 if (writer == null) {
122 return;
123 }
124 if (hasMembersToDocument()) {
125 Content propertyDetailsTreeHeader = writer.getPropertyDetailsTreeHeader(typeElement,
126 memberDetailsTree);
127 Content propertyDetailsTree = writer.getMemberTreeHeader();
128
129 for (Element property : properties) {
130 currentProperty = (ExecutableElement)property;
131 Content propertyDocTree = writer.getPropertyDocTreeHeader(currentProperty,
132 propertyDetailsTree);
133
134 buildSignature(propertyDocTree);
135 buildPropertyComments(propertyDocTree);
136 buildTagInfo(propertyDocTree);
137
138 propertyDetailsTree.add(writer.getPropertyDoc(propertyDocTree));
139 }
140 memberDetailsTree.add(
141 writer.getPropertyDetails(propertyDetailsTreeHeader, propertyDetailsTree));
142 }
143 }
144
145 /**
146 * Build the signature.
147 *
148 * @param propertyDocTree the content tree to which the documentation will be added
149 */
150 protected void buildSignature(Content propertyDocTree) {
151 propertyDocTree.add(writer.getSignature(currentProperty));
152 }
153
154 /**
155 * Build the deprecation information.
156 *
157 * @param propertyDocTree the content tree to which the documentation will be added
158 */
159 protected void buildDeprecationInfo(Content propertyDocTree) {
160 writer.addDeprecated(currentProperty, propertyDocTree);
161 }
162
163 /**
164 * Build the comments for the property. Do nothing if
165 * {@link BaseConfiguration#nocomment} is set to true.
166 *
167 * @param propertyDocTree the content tree to which the documentation will be added
168 */
169 protected void buildPropertyComments(Content propertyDocTree) {
170 if (!configuration.nocomment) {
171 writer.addComments(currentProperty, propertyDocTree);
172 }
173 }
174
175 /**
176 * Build the tag information.
177 *
178 * @param propertyDocTree the content tree to which the documentation will be added
179 */
180 protected void buildTagInfo(Content propertyDocTree) {
181 writer.addTags(currentProperty, propertyDocTree);
182 }
183
184 /**
185 * Return the property writer for this builder.
186 *
187 * @return the property writer for this builder.
188 */
189 public PropertyWriter getWriter() {
190 return writer;
191 }
192 }