Mercurial > jdk8-mips64-public > langtools / file comparison

comparison: src/share/classes/com/sun/tools/doclets/internal/toolkit/AnnotationTypeWriter.java

src/share/classes/com/sun/tools/doclets/internal/toolkit/AnnotationTypeWriter.java

changeset 766
90af8d87741f
parent 554
9d9f26857129
child 798
4868a36f6fd8
equal deleted inserted replaced
758:bcbc86cc5b31 766:90af8d87741f
35 * This code is not part of an API. 35 * This code is not part of an API.
36 * It is implementation that is subject to change. 36 * It is implementation that is subject to change.
37 * Do not use it as an API. 37 * Do not use it as an API.
38 * 38 *
39 * @author Jamie Ho 39 * @author Jamie Ho
40 * @author Bhavesh Patel (Modified)
40 * @since 1.5 41 * @since 1.5
41 */ 42 */
42 43
43 public interface AnnotationTypeWriter { 44 public interface AnnotationTypeWriter {
44 45
45 /** 46 /**
46 * Write the header of the page. 47 * Get the header of the page.
47 * @param header the header to write. 48 *
49 * @param header the header string to write
50 * @return a content tree for the header documentation
48 */ 51 */
49 public void writeHeader(String header); 52 public Content getHeader(String header);
50 53
51 /** 54 /**
52 * Write the signature of the current annotation type. 55 * Get the annotation content header.
53 * 56 *
54 * @param modifiers the modifiers for the signature. 57 * @return annotation content header that needs to be added to the documentation
55 */ 58 */
56 public void writeAnnotationTypeSignature(String modifiers); 59 public Content getAnnotationContentHeader();
60
61 /**
62 * Get the annotation information tree header.
63 *
64 * @return annotation information tree header that needs to be added to the documentation
65 */
66 public Content getAnnotationInfoTreeHeader();
67
68 /**
69 * Get the annotation information.
70 *
71 * @param annotationInfoTree content tree containing the annotation information
72 * @return a content tree for the annotation
73 */
74 public Content getAnnotationInfo(Content annotationInfoTree);
75
76 /**
77 * Add the signature of the current annotation type.
78 *
79 * @param modifiers the modifiers for the signature
80 * @param annotationInfoTree the annotation content tree to which the signature will be added
81 */
82 public void addAnnotationTypeSignature(String modifiers, Content annotationInfoTree);
57 83
58 /** 84 /**
59 * Build the annotation type description. 85 * Build the annotation type description.
86 *
87 * @param annotationInfoTree content tree to which the description will be added
60 */ 88 */
61 public void writeAnnotationTypeDescription(); 89 public void addAnnotationTypeDescription(Content annotationInfoTree);
62 90
63 /** 91 /**
64 * Write the tag information for the current annotation type. 92 * Add the tag information for the current annotation type.
93 *
94 * @param annotationInfoTree content tree to which the tag information will be added
65 */ 95 */
66 public void writeAnnotationTypeTagInfo(); 96 public void addAnnotationTypeTagInfo(Content annotationInfoTree);
67 97
68 /** 98 /**
69 * If this annotation type is deprecated, write the appropriate information. 99 * If this annotation is deprecated, add the appropriate information.
100 *
101 * @param annotationInfoTree content tree to which the deprecated information will be added
70 */ 102 */
71 public void writeAnnotationTypeDeprecationInfo(); 103 public void addAnnotationTypeDeprecationInfo (Content annotationInfoTree);
72 104
73 /** 105 /**
74 * Write the footer of the page. 106 * Add the annotation type details marker.
107 *
108 * @param memberDetails the content tree representing member details marker
75 */ 109 */
76 public void writeFooter(); 110 public void addAnnotationDetailsMarker(Content memberDetails);
111
112 /**
113 * Get the member tree header for the annotation type.
114 *
115 * @return a content tree for the member tree header
116 */
117 public Content getMemberTreeHeader();
118
119 /**
120 * Get the member tree.
121 *
122 * @param memberTree the content tree that will be modified and returned
123 * @return a content tree for the member
124 */
125 public Content getMemberTree(Content memberTree);
126
127 /**
128 * Get the member summary tree.
129 *
130 * @param memberTree the content tree that will be used to build the summary tree
131 * @return a content tree for the member summary
132 */
133 public Content getMemberSummaryTree(Content memberTree);
134
135 /**
136 * Get the member details tree.
137 *
138 * @param memberTree the content tree that will be used to build the details tree
139 * @return a content tree for the member details
140 */
141 public Content getMemberDetailsTree(Content memberTree);
142
143 /**
144 * Add the footer of the page.
145 *
146 * @param contentTree content tree to which the footer will be added
147 */
148 public void addFooter(Content contentTree);
149
150 /**
151 * Print the document.
152 *
153 * @param contentTree content tree that will be printed as a document
154 */
155 public void printDocument(Content contentTree);
77 156
78 /** 157 /**
79 * Close the writer. 158 * Close the writer.
80 */ 159 */
81 public void close() throws IOException; 160 public void close() throws IOException;
84 * Return the {@link AnnotationTypeDoc} being documented. 163 * Return the {@link AnnotationTypeDoc} being documented.
85 * 164 *
86 * @return the AnnotationTypeDoc being documented. 165 * @return the AnnotationTypeDoc being documented.
87 */ 166 */
88 public AnnotationTypeDoc getAnnotationTypeDoc(); 167 public AnnotationTypeDoc getAnnotationTypeDoc();
89
90 /**
91 * Perform any operations that are necessary when the member summary
92 * finished building.
93 */
94 public void completeMemberSummaryBuild();
95 } 168 }

Mercurial Repository: jdk8-mips64-public/langtools

mercurial