Mercurial > jdk8-mips64-public > langtools / file comparison
comparison: src/share/classes/com/sun/tools/doclets/internal/toolkit/SerializedFormWriter.java
src/share/classes/com/sun/tools/doclets/internal/toolkit/SerializedFormWriter.java
- changeset 233
- 5240b1120530
- parent 222
- d424ed561993
- child 240
- 8c55d5b0ed71
equal
deleted
inserted
replaced
| 232:1fbc1cc6e260 | 233:5240b1120530 |
|---|---|
| 23 * have any questions. | 23 * have any questions. |
| 24 */ | 24 */ |
| 25 | 25 |
| 26 package com.sun.tools.doclets.internal.toolkit; | 26 package com.sun.tools.doclets.internal.toolkit; |
| 27 | 27 |
| 28 import java.io.*; | |
| 29 | |
| 28 import com.sun.javadoc.*; | 30 import com.sun.javadoc.*; |
| 29 import java.io.*; | |
| 30 | 31 |
| 31 /** | 32 /** |
| 32 * The interface for writing serialized form output. | 33 * The interface for writing serialized form output. |
| 33 * | 34 * |
| 34 * This code is not part of an API. | 35 * This code is not part of an API. |
| 145 */ | 146 */ |
| 146 public void writeMemberHeader(ClassDoc fieldType, String fieldTypeStr, | 147 public void writeMemberHeader(ClassDoc fieldType, String fieldTypeStr, |
| 147 String fieldDimensions, String fieldName); | 148 String fieldDimensions, String fieldName); |
| 148 | 149 |
| 149 /** | 150 /** |
| 151 * Write the member footer. | |
| 152 */ | |
| 153 public void writeMemberFooter(); | |
| 154 | |
| 155 /** | |
| 156 * Check to see if overview details should be printed. If | |
| 157 * nocomment option set or if there is no text to be printed | |
| 158 * for deprecation info, inline comment or tags, | |
| 159 * do not print overview details. | |
| 160 * | |
| 161 * @param field the field to check overview details for. | |
| 162 * @return true if overview details need to be printed | |
| 163 */ | |
| 164 public boolean shouldPrintOverview(FieldDoc field); | |
| 165 | |
| 166 /** | |
| 150 * Write the footer. | 167 * Write the footer. |
| 151 * | 168 * |
| 169 * @param heading the heading that was written. | |
| 170 */ | |
| 171 public void writeFooter (String heading); | |
| 172 } | |
| 173 | |
| 174 /** | |
| 175 * Write the serialized form for a given field. | |
| 176 */ | |
| 177 public interface SerialMethodWriter { | |
| 178 | |
| 179 /** | |
| 180 * Write the given heading. | |
| 181 * | |
| 182 * @param heading the heading to write. | |
| 183 */ | |
| 184 public void writeHeader(String heading); | |
| 185 | |
| 186 /** | |
| 187 * Write a warning that no serializable methods exist. | |
| 188 * | |
| 189 * @param msg the warning to print. | |
| 190 */ | |
| 191 public void writeNoCustomizationMsg(String msg); | |
| 192 | |
| 193 /** | |
| 194 * Write the header. | |
| 195 * | |
| 152 * @param member the member to write the header for. | 196 * @param member the member to write the header for. |
| 153 */ | 197 */ |
| 154 public void writeMemberFooter(FieldDoc member); | |
| 155 | |
| 156 /** | |
| 157 * Check to see if member details should be printed. If | |
| 158 * nocomment option set or if there is no text to be printed | |
| 159 * for deprecation info, inline comment, no serial tag or inline tags, | |
| 160 * do not print member details. | |
| 161 * | |
| 162 * @param member the member to check details for. | |
| 163 * @return true if details need to be printed | |
| 164 */ | |
| 165 public boolean shouldPrintMemberDetails(FieldDoc member); | |
| 166 } | |
| 167 | |
| 168 /** | |
| 169 * Write the serialized form for a given field. | |
| 170 */ | |
| 171 public interface SerialMethodWriter { | |
| 172 | |
| 173 /** | |
| 174 * Write the given heading. | |
| 175 * | |
| 176 * @param heading the heading to write. | |
| 177 */ | |
| 178 public void writeHeader(String heading); | |
| 179 | |
| 180 /** | |
| 181 * Write a warning that no serializable methods exist. | |
| 182 * | |
| 183 * @param msg the warning to print. | |
| 184 */ | |
| 185 public void writeNoCustomizationMsg(String msg); | |
| 186 | |
| 187 /** | |
| 188 * Write the header. | |
| 189 * | |
| 190 * @param member the member to write the header for. | |
| 191 */ | |
| 192 public void writeMemberHeader(MethodDoc member); | 198 public void writeMemberHeader(MethodDoc member); |
| 193 | 199 |
| 194 /** | 200 /** |
| 195 * Write the footer. | 201 * Write the footer. |
| 196 * | 202 */ |
| 197 * @param member the member to write the header for. | 203 public void writeMemberFooter(); |
| 198 */ | |
| 199 public void writeMemberFooter(MethodDoc member); | |
| 200 | 204 |
| 201 /** | 205 /** |
| 202 * Write the deprecated information for this member. | 206 * Write the deprecated information for this member. |
| 203 */ | 207 */ |
| 204 public void writeDeprecatedMemberInfo(MethodDoc member); | 208 public void writeDeprecatedMemberInfo(MethodDoc member); |
