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 NestedClassWriter {
043    
044        /**
045         * Write the classes summary header for the given class.
046         *
047         * @param nestedClass the class the summary belongs to.
048         */
049        public void writeNestedClassSummaryHeader(ClassDoc nestedClass);
050    
051        /**
052         * Write the class summary for the given class and class.
053         *
054         * @param classDoc the class the summary belongs to.
055         * @param nestedClass the nested class that I am summarizing.
056         */
057        public void writeNestedClassSummary(ClassDoc classDoc, ClassDoc nestedClass);
058    
059        /**
060         * Write the classes summary footer for the given class.
061         *
062         * @param nestedClass the class the summary belongs to.
063         */
064        public void writeNestedClassSummaryFooter(ClassDoc nestedClass);
065    
066        /**
067         * Write the inherited classes summary header for the given class.
068         *
069         * @param nestedClass the class the summary belongs to.
070         */
071        public void writeInheritedNestedClassSummaryHeader(ClassDoc nestedClass);
072    
073        /**
074         * Write the inherited nested class summary for the given class and nested
075         * class.
076         *
077         * @param classDoc the class the inherited nested class belongs to.
078         * @param nestedClass the inherited nested class that I am summarizing.
079         * @param isFirst true if this is the first member in the list.
080         */
081        public void writeInheritedNestedClassSummary(ClassDoc classDoc,
082                ClassDoc nestedClass, boolean isFirst);
083    
084        /**
085         * Write the inherited classes summary footer for the given class.
086         *
087         * @param nestedClass the class the summary belongs to.
088         */
089        public void writeInheritedNestedClassSummaryFooter(ClassDoc nestedClass);
090    
091        /**
092         * Close the writer.
093         */
094        public void close() throws IOException;
095    }