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.TypeElement;
32 import javax.lang.model.element.VariableElement;
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.EnumConstantWriter;
38
39 import static jdk.javadoc.internal.doclets.toolkit.util.VisibleMemberTable.Kind.*;
40
41 /**
42 * Builds documentation for a enum constants.
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 EnumConstantBuilder extends AbstractMemberBuilder {
50
51 /**
52 * The writer to output the enum constants documentation.
53 */
54 private final EnumConstantWriter writer;
55
56 /**
57 * The set of enum constants being documented.
58 */
59 private final List<? extends Element> enumConstants;
60
61 /**
62 * The current enum constant that is being documented at this point
63 * in time.
64 */
65 private VariableElement currentElement;
66
67 /**
68 * Construct a new EnumConstantsBuilder.
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 EnumConstantBuilder(Context context,
75 TypeElement typeElement, EnumConstantWriter writer) {
76 super(context, typeElement);
77 this.writer = writer;
78 enumConstants = getVisibleMembers(ENUM_CONSTANTS);
79 }
80
81 /**
82 * Construct a new EnumConstantsBuilder.
83 *
84 * @param context the build context.
85 * @param typeElement the class whose members are being documented.
86 * @param writer the doclet specific writer.
87 * @return the new EnumConstantsBuilder
88 */
89 public static EnumConstantBuilder getInstance(Context context,
90 TypeElement typeElement, EnumConstantWriter writer) {
91 return new EnumConstantBuilder(context, typeElement, writer);
92 }
93
94 /**
95 * Returns whether or not there are members to document.
96 *
97 * @return whether or not there are members to document
98 */
99 @Override
100 public boolean hasMembersToDocument() {
101 return !enumConstants.isEmpty();
102 }
103
104 /**
105 * {@inheritDoc}
106 */
107 @Override
108 public void build(Content contentTree) throws DocletException {
109 buildEnumConstant(contentTree);
110 }
111
112 /**
113 * Build the enum constant documentation.
114 *
115 * @param memberDetailsTree the content tree to which the documentation will be added
116 * @throws DocletException is there is a problem while building the documentation
117 */
118 protected void buildEnumConstant(Content memberDetailsTree) throws DocletException {
119 if (writer == null) {
120 return;
121 }
122 if (hasMembersToDocument()) {
123 Content enumConstantsDetailsTreeHeader = writer.getEnumConstantsDetailsTreeHeader(typeElement,
124 memberDetailsTree);
125 Content enumConstantsDetailsTree = writer.getMemberTreeHeader();
126
127 for (Element enumConstant : enumConstants) {
128 currentElement = (VariableElement)enumConstant;
129 Content enumConstantsTree = writer.getEnumConstantsTreeHeader(currentElement,
130 enumConstantsDetailsTree);
131
132 buildSignature(enumConstantsTree);
133 buildDeprecationInfo(enumConstantsTree);
134 buildEnumConstantComments(enumConstantsTree);
135 buildTagInfo(enumConstantsTree);
136
137 enumConstantsDetailsTree.add(writer.getEnumConstants(enumConstantsTree));
138 }
139 memberDetailsTree.add(
140 writer.getEnumConstantsDetails(enumConstantsDetailsTreeHeader, enumConstantsDetailsTree));
141 }
142 }
143
144 /**
145 * Build the signature.
146 *
147 * @param enumConstantsTree the content tree to which the documentation will be added
148 */
149 protected void buildSignature(Content enumConstantsTree) {
150 enumConstantsTree.add(writer.getSignature(currentElement));
151 }
152
153 /**
154 * Build the deprecation information.
155 *
156 * @param enumConstantsTree the content tree to which the documentation will be added
157 */
158 protected void buildDeprecationInfo(Content enumConstantsTree) {
159 writer.addDeprecated(currentElement, enumConstantsTree);
160 }
161
162 /**
163 * Build the comments for the enum constant. Do nothing if
164 * {@link BaseConfiguration#nocomment} is set to true.
165 *
166 * @param enumConstantsTree the content tree to which the documentation will be added
167 */
168 protected void buildEnumConstantComments(Content enumConstantsTree) {
169 if (!configuration.nocomment) {
170 writer.addComments(currentElement, enumConstantsTree);
171 }
172 }
173
174 /**
175 * Build the tag information.
176 *
177 * @param enumConstantsTree the content tree to which the documentation will be added
178 */
179 protected void buildTagInfo(Content enumConstantsTree) {
180 writer.addTags(currentElement, enumConstantsTree);
181 }
182
183 /**
184 * Return the enum constant writer for this builder.
185 *
186 * @return the enum constant writer for this builder.
187 */
188 public EnumConstantWriter getWriter() {
189 return writer;
190 }
191 }