Mercurial > jdk8-mips64-public > langtools / annotate
src/share/classes/com/sun/tools/doclets/internal/toolkit/ClassWriter.java@9a66ca7c79fa (annotated)
src/share/classes/com/sun/tools/doclets/internal/toolkit/ClassWriter.java
Sat, 01 Dec 2007 00:00:00 +0000
- author
- duke
- date
- Sat, 01 Dec 2007 00:00:00 +0000
- changeset 1
- 9a66ca7c79fa
- child 554
- 9d9f26857129
- permissions
- -rw-r--r--
Initial load
| duke@1 | 1 | /* |
| duke@1 | 2 | * Copyright 2003 Sun Microsystems, Inc. All Rights Reserved. |
| duke@1 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| duke@1 | 4 | * |
| duke@1 | 5 | * This code is free software; you can redistribute it and/or modify it |
| duke@1 | 6 | * under the terms of the GNU General Public License version 2 only, as |
| duke@1 | 7 | * published by the Free Software Foundation. Sun designates this |
| duke@1 | 8 | * particular file as subject to the "Classpath" exception as provided |
| duke@1 | 9 | * by Sun in the LICENSE file that accompanied this code. |
| duke@1 | 10 | * |
| duke@1 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| duke@1 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| duke@1 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| duke@1 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| duke@1 | 15 | * accompanied this code). |
| duke@1 | 16 | * |
| duke@1 | 17 | * You should have received a copy of the GNU General Public License version |
| duke@1 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| duke@1 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| duke@1 | 20 | * |
| duke@1 | 21 | * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, |
| duke@1 | 22 | * CA 95054 USA or visit www.sun.com if you need additional information or |
| duke@1 | 23 | * have any questions. |
| duke@1 | 24 | */ |
| duke@1 | 25 | |
| duke@1 | 26 | |
| duke@1 | 27 | package com.sun.tools.doclets.internal.toolkit; |
| duke@1 | 28 | |
| duke@1 | 29 | import java.io.*; |
| duke@1 | 30 | import com.sun.javadoc.*; |
| duke@1 | 31 | |
| duke@1 | 32 | /** |
| duke@1 | 33 | * The interface for writing class output. |
| duke@1 | 34 | * |
| duke@1 | 35 | * This code is not part of an API. |
| duke@1 | 36 | * It is implementation that is subject to change. |
| duke@1 | 37 | * Do not use it as an API |
| duke@1 | 38 | * |
| duke@1 | 39 | * @author Jamie Ho |
| duke@1 | 40 | * @since 1.5 |
| duke@1 | 41 | */ |
| duke@1 | 42 | |
| duke@1 | 43 | public interface ClassWriter { |
| duke@1 | 44 | |
| duke@1 | 45 | /** |
| duke@1 | 46 | * Write the header of the page. |
| duke@1 | 47 | * @param header the header to write. |
| duke@1 | 48 | */ |
| duke@1 | 49 | public void writeHeader(String header); |
| duke@1 | 50 | |
| duke@1 | 51 | /** |
| duke@1 | 52 | * Write the class tree documentation. |
| duke@1 | 53 | */ |
| duke@1 | 54 | public void writeClassTree(); |
| duke@1 | 55 | |
| duke@1 | 56 | /** |
| duke@1 | 57 | * Write all implemented interfaces if this is a class. |
| duke@1 | 58 | */ |
| duke@1 | 59 | public void writeImplementedInterfacesInfo(); |
| duke@1 | 60 | |
| duke@1 | 61 | /** |
| duke@1 | 62 | * Write all super interfaces if this is an interface. |
| duke@1 | 63 | */ |
| duke@1 | 64 | public void writeSuperInterfacesInfo(); |
| duke@1 | 65 | |
| duke@1 | 66 | /** |
| duke@1 | 67 | * Write the type parameter information. |
| duke@1 | 68 | */ |
| duke@1 | 69 | public void writeTypeParamInfo(); |
| duke@1 | 70 | |
| duke@1 | 71 | /** |
| duke@1 | 72 | * Write all the classes that extend this one. |
| duke@1 | 73 | */ |
| duke@1 | 74 | public void writeSubClassInfo(); |
| duke@1 | 75 | |
| duke@1 | 76 | /** |
| duke@1 | 77 | * Write all the interfaces that extend this one. |
| duke@1 | 78 | */ |
| duke@1 | 79 | public void writeSubInterfacesInfo(); |
| duke@1 | 80 | |
| duke@1 | 81 | /** |
| duke@1 | 82 | * If this is an interface, write all classes that implement this |
| duke@1 | 83 | * interface. |
| duke@1 | 84 | */ |
| duke@1 | 85 | public void writeInterfaceUsageInfo (); |
| duke@1 | 86 | |
| duke@1 | 87 | /** |
| duke@1 | 88 | * If this is an inner class or interface, write the enclosing class or |
| duke@1 | 89 | * interface. |
| duke@1 | 90 | */ |
| duke@1 | 91 | public void writeNestedClassInfo (); |
| duke@1 | 92 | |
| duke@1 | 93 | /** |
| duke@1 | 94 | * If this class is deprecated, write the appropriate information. |
| duke@1 | 95 | */ |
| duke@1 | 96 | public void writeClassDeprecationInfo (); |
| duke@1 | 97 | |
| duke@1 | 98 | /** |
| duke@1 | 99 | * Write the signature of the current class. |
| duke@1 | 100 | * |
| duke@1 | 101 | * @param modifiers the modifiers for the signature. |
| duke@1 | 102 | */ |
| duke@1 | 103 | public void writeClassSignature(String modifiers); |
| duke@1 | 104 | |
| duke@1 | 105 | /** |
| duke@1 | 106 | * Build the class description. |
| duke@1 | 107 | */ |
| duke@1 | 108 | public void writeClassDescription(); |
| duke@1 | 109 | |
| duke@1 | 110 | /** |
| duke@1 | 111 | * Write the tag information for the current class. |
| duke@1 | 112 | */ |
| duke@1 | 113 | public void writeClassTagInfo(); |
| duke@1 | 114 | |
| duke@1 | 115 | /** |
| duke@1 | 116 | * Write the footer of the page. |
| duke@1 | 117 | */ |
| duke@1 | 118 | public void writeFooter(); |
| duke@1 | 119 | |
| duke@1 | 120 | /** |
| duke@1 | 121 | * Close the writer. |
| duke@1 | 122 | */ |
| duke@1 | 123 | public void close() throws IOException; |
| duke@1 | 124 | |
| duke@1 | 125 | /** |
| duke@1 | 126 | * Return the classDoc being documented. |
| duke@1 | 127 | * |
| duke@1 | 128 | * @return the classDoc being documented. |
| duke@1 | 129 | */ |
| duke@1 | 130 | public ClassDoc getClassDoc(); |
| duke@1 | 131 | |
| duke@1 | 132 | /** |
| duke@1 | 133 | * Perform any operations that are necessary when the member summary |
| duke@1 | 134 | * finished building. |
| duke@1 | 135 | */ |
| duke@1 | 136 | public void completeMemberSummaryBuild(); |
| duke@1 | 137 | } |
