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
33 import jdk.javadoc.internal.doclets.toolkit.AnnotationTypeRequiredMemberWriter;
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.util.VisibleMemberTable;
38
39 import static jdk.javadoc.internal.doclets.toolkit.util.VisibleMemberTable.Kind.*;
40
41 /**
42 * Builds documentation for required annotation type members.
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 AnnotationTypeRequiredMemberBuilder extends AbstractMemberBuilder {
50
51
52 /**
53 * The writer to output the member documentation.
54 */
164 /**
165 * Build the signature.
166 *
167 * @param annotationDocTree the content tree to which the documentation will be added
168 */
169 protected void buildSignature(Content annotationDocTree) {
170 annotationDocTree.add(writer.getSignature(currentMember));
171 }
172
173 /**
174 * Build the deprecation information.
175 *
176 * @param annotationDocTree the content tree to which the documentation will be added
177 */
178 protected void buildDeprecationInfo(Content annotationDocTree) {
179 writer.addDeprecated(currentMember, annotationDocTree);
180 }
181
182 /**
183 * Build the comments for the member. Do nothing if
184 * {@link BaseConfiguration#nocomment} is set to true.
185 *
186 * @param annotationDocTree the content tree to which the documentation will be added
187 */
188 protected void buildMemberComments(Content annotationDocTree) {
189 if (!configuration.nocomment) {
190 writer.addComments(currentMember, annotationDocTree);
191 }
192 }
193
194 /**
195 * Build the tag information.
196 *
197 * @param annotationDocTree the content tree to which the documentation will be added
198 */
199 protected void buildTagInfo(Content annotationDocTree) {
200 writer.addTags(currentMember, annotationDocTree);
201 }
202
203 /**
204 * Return the annotation type required member writer for this builder.
205 *
206 * @return the annotation type required member constant writer for this
207 * builder.
208 */
209 public AnnotationTypeRequiredMemberWriter getWriter() {
|
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
33 import jdk.javadoc.internal.doclets.toolkit.AnnotationTypeRequiredMemberWriter;
34 import jdk.javadoc.internal.doclets.toolkit.BaseOptions;
35 import jdk.javadoc.internal.doclets.toolkit.Content;
36 import jdk.javadoc.internal.doclets.toolkit.DocletException;
37 import jdk.javadoc.internal.doclets.toolkit.util.VisibleMemberTable;
38
39 import static jdk.javadoc.internal.doclets.toolkit.util.VisibleMemberTable.Kind.*;
40
41 /**
42 * Builds documentation for required annotation type members.
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 AnnotationTypeRequiredMemberBuilder extends AbstractMemberBuilder {
50
51
52 /**
53 * The writer to output the member documentation.
54 */
164 /**
165 * Build the signature.
166 *
167 * @param annotationDocTree the content tree to which the documentation will be added
168 */
169 protected void buildSignature(Content annotationDocTree) {
170 annotationDocTree.add(writer.getSignature(currentMember));
171 }
172
173 /**
174 * Build the deprecation information.
175 *
176 * @param annotationDocTree the content tree to which the documentation will be added
177 */
178 protected void buildDeprecationInfo(Content annotationDocTree) {
179 writer.addDeprecated(currentMember, annotationDocTree);
180 }
181
182 /**
183 * Build the comments for the member. Do nothing if
184 * {@link BaseOptions#noComment} is set to true.
185 *
186 * @param annotationDocTree the content tree to which the documentation will be added
187 */
188 protected void buildMemberComments(Content annotationDocTree) {
189 if (!options.noComment) {
190 writer.addComments(currentMember, annotationDocTree);
191 }
192 }
193
194 /**
195 * Build the tag information.
196 *
197 * @param annotationDocTree the content tree to which the documentation will be added
198 */
199 protected void buildTagInfo(Content annotationDocTree) {
200 writer.addTags(currentMember, annotationDocTree);
201 }
202
203 /**
204 * Return the annotation type required member writer for this builder.
205 *
206 * @return the annotation type required member constant writer for this
207 * builder.
208 */
209 public AnnotationTypeRequiredMemberWriter getWriter() {
|