001: /*
002: * Copyright 2003 Sun Microsystems, Inc. All Rights Reserved.
003: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004: *
005: * This code is free software; you can redistribute it and/or modify it
006: * under the terms of the GNU General Public License version 2 only, as
007: * published by the Free Software Foundation. Sun designates this
008: * particular file as subject to the "Classpath" exception as provided
009: * by Sun in the LICENSE file that accompanied this code.
010: *
011: * This code is distributed in the hope that it will be useful, but WITHOUT
012: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
014: * version 2 for more details (a copy is included in the LICENSE file that
015: * accompanied this code).
016: *
017: * You should have received a copy of the GNU General Public License version
018: * 2 along with this work; if not, write to the Free Software Foundation,
019: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020: *
021: * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022: * CA 95054 USA or visit www.sun.com if you need additional information or
023: * have any questions.
024: */
025:
026: package com.sun.tools.doclets.internal.toolkit;
027:
028: import java.io.*;
029: import com.sun.javadoc.*;
030:
031: /**
032: * The interface for writing class output.
033: *
034: * This code is not part of an API.
035: * It is implementation that is subject to change.
036: * Do not use it as an API
037: *
038: * @author Jamie Ho
039: * @since 1.5
040: */
041:
042: public interface ClassWriter {
043:
044: /**
045: * Write the header of the page.
046: * @param header the header to write.
047: */
048: public void writeHeader(String header);
049:
050: /**
051: * Write the class tree documentation.
052: */
053: public void writeClassTree();
054:
055: /**
056: * Write all implemented interfaces if this is a class.
057: */
058: public void writeImplementedInterfacesInfo();
059:
060: /**
061: * Write all super interfaces if this is an interface.
062: */
063: public void writeSuperInterfacesInfo();
064:
065: /**
066: * Write the type parameter information.
067: */
068: public void writeTypeParamInfo();
069:
070: /**
071: * Write all the classes that extend this one.
072: */
073: public void writeSubClassInfo();
074:
075: /**
076: * Write all the interfaces that extend this one.
077: */
078: public void writeSubInterfacesInfo();
079:
080: /**
081: * If this is an interface, write all classes that implement this
082: * interface.
083: */
084: public void writeInterfaceUsageInfo();
085:
086: /**
087: * If this is an inner class or interface, write the enclosing class or
088: * interface.
089: */
090: public void writeNestedClassInfo();
091:
092: /**
093: * If this class is deprecated, write the appropriate information.
094: */
095: public void writeClassDeprecationInfo();
096:
097: /**
098: * Write the signature of the current class.
099: *
100: * @param modifiers the modifiers for the signature.
101: */
102: public void writeClassSignature(String modifiers);
103:
104: /**
105: * Build the class description.
106: */
107: public void writeClassDescription();
108:
109: /**
110: * Write the tag information for the current class.
111: */
112: public void writeClassTagInfo();
113:
114: /**
115: * Write the footer of the page.
116: */
117: public void writeFooter();
118:
119: /**
120: * Close the writer.
121: */
122: public void close() throws IOException;
123:
124: /**
125: * Return the classDoc being documented.
126: *
127: * @return the classDoc being documented.
128: */
129: public ClassDoc getClassDoc();
130:
131: /**
132: * Perform any operations that are necessary when the member summary
133: * finished building.
134: */
135: public void completeMemberSummaryBuild();
136: }
|