AnnotationTypeRequiredMemberWriter.java revision 3233:b5d08bc0d224 
1/*
2 * Copyright (c) 2003, 2016, 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
26package jdk.javadoc.internal.doclets.toolkit;
27
28import java.io.*;
29
30import javax.lang.model.element.Element;
31import javax.lang.model.element.TypeElement;
32/**
33 * The interface for writing annotation type required member output.
34 *
35 *  <p><b>This is NOT part of any supported API.
36 *  If you write code that depends on this, you do so at your own risk.
37 *  This code and its internal interfaces are subject to change or
38 *  deletion without notice.</b>
39 *
40 *
41 * @author Jamie Ho
42 * @author Bhavesh Patel (Modified)
43 */
44
45public interface AnnotationTypeRequiredMemberWriter {
46
47    /**
48     * Add the annotation type member tree header.
49     *
50     * @return content tree for the member tree header
51     */
52    public Content getMemberTreeHeader();
53
54    /**
55     * Add the annotation type details marker.
56     *
57     * @param memberDetails the content tree representing details marker
58     */
59    public void addAnnotationDetailsMarker(Content memberDetails);
60
61    /**
62     * Add the annotation type details tree header.
63     *
64     * @param typeElement the annotation type being documented
65     * @param memberDetailsTree the content tree representing member details
66     */
67    public void addAnnotationDetailsTreeHeader(TypeElement typeElement,
68            Content memberDetailsTree);
69
70    /**
71     * Get the annotation type documentation tree header.
72     *
73     * @param member the annotation type being documented
74     * @param annotationDetailsTree the content tree representing annotation type details
75     * @return content tree for the annotation type documentation header
76     */
77    public Content getAnnotationDocTreeHeader(Element member,
78            Content annotationDetailsTree);
79
80    /**
81     * Get the annotation type details tree.
82     *
83     * @param annotationDetailsTree the content tree representing annotation type details
84     * @return content tree for the annotation type details
85     */
86    public Content getAnnotationDetails(Content annotationDetailsTree);
87
88    /**
89     * Get the annotation type documentation.
90     *
91     * @param annotationDocTree the content tree representing annotation type documentation
92     * @param isLastContent true if the content to be added is the last content
93     * @return content tree for the annotation type documentation
94     */
95    public Content getAnnotationDoc(Content annotationDocTree, boolean isLastContent);
96
97    /**
98     * Get the signature for the given member.
99     *
100     * @param member the member being documented
101     * @return content tree for the annotation type signature
102     */
103    public Content getSignature(Element member);
104
105    /**
106     * Add the deprecated output for the given member.
107     *
108     * @param member the member being documented
109     * @param annotationDocTree content tree to which the deprecated information will be added
110     */
111    public void addDeprecated(Element member, Content annotationDocTree);
112
113    /**
114     * Add the comments for the given member.
115     *
116     * @param member the member being documented
117     * @param annotationDocTree the content tree to which the comments will be added
118     */
119    public void addComments(Element member, Content annotationDocTree);
120
121    /**
122     * Add the tags for the given member.
123     *
124     * @param member the member being documented
125     * @param annotationDocTree the content tree to which the tags will be added
126     */
127    public void addTags(Element member, Content annotationDocTree);
128
129    /**
130     * Close the writer.
131     */
132    public void close() throws IOException;
133}
134