NestedClassWriter.java revision 0
0N/A/*
0N/A * Copyright 2003 Sun Microsystems, Inc. All Rights Reserved.
0N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
0N/A *
0N/A * This code is free software; you can redistribute it and/or modify it
0N/A * under the terms of the GNU General Public License version 2 only, as
0N/A * published by the Free Software Foundation. Sun designates this
0N/A * particular file as subject to the "Classpath" exception as provided
0N/A * by Sun in the LICENSE file that accompanied this code.
0N/A *
0N/A * This code is distributed in the hope that it will be useful, but WITHOUT
0N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
0N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
0N/A * version 2 for more details (a copy is included in the LICENSE file that
0N/A * accompanied this code).
0N/A *
0N/A * You should have received a copy of the GNU General Public License version
0N/A * 2 along with this work; if not, write to the Free Software Foundation,
0N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
0N/A *
0N/A * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
0N/A * CA 95054 USA or visit www.sun.com if you need additional information or
0N/A * have any questions.
0N/A */
0N/A
0N/Apackage com.sun.tools.doclets.internal.toolkit;
0N/A
0N/Aimport java.io.*;
0N/Aimport com.sun.javadoc.*;
0N/A
0N/A/**
0N/A * The interface for writing class output.
0N/A *
0N/A * This code is not part of an API.
0N/A * It is implementation that is subject to change.
0N/A * Do not use it as an API
0N/A *
0N/A * @author Jamie Ho
0N/A * @since 1.5
0N/A */
0N/A
0N/Apublic interface NestedClassWriter {
0N/A
0N/A /**
0N/A * Write the classes summary header for the given class.
0N/A *
0N/A * @param nestedClass the class the summary belongs to.
0N/A */
0N/A public void writeNestedClassSummaryHeader(ClassDoc nestedClass);
0N/A
0N/A /**
0N/A * Write the class summary for the given class and class.
0N/A *
0N/A * @param classDoc the class the summary belongs to.
0N/A * @param nestedClass the nested class that I am summarizing.
0N/A */
0N/A public void writeNestedClassSummary(ClassDoc classDoc, ClassDoc nestedClass);
0N/A
0N/A /**
0N/A * Write the classes summary footer for the given class.
0N/A *
0N/A * @param nestedClass the class the summary belongs to.
0N/A */
0N/A public void writeNestedClassSummaryFooter(ClassDoc nestedClass);
0N/A
0N/A /**
0N/A * Write the inherited classes summary header for the given class.
0N/A *
0N/A * @param nestedClass the class the summary belongs to.
0N/A */
0N/A public void writeInheritedNestedClassSummaryHeader(ClassDoc nestedClass);
0N/A
0N/A /**
0N/A * Write the inherited nested class summary for the given class and nested
0N/A * class.
0N/A *
0N/A * @param classDoc the class the inherited nested class belongs to.
0N/A * @param nestedClass the inherited nested class that I am summarizing.
0N/A * @param isFirst true if this is the first member in the list.
0N/A */
0N/A public void writeInheritedNestedClassSummary(ClassDoc classDoc,
0N/A ClassDoc nestedClass, boolean isFirst);
0N/A
0N/A /**
0N/A * Write the inherited classes summary footer for the given class.
0N/A *
0N/A * @param nestedClass the class the summary belongs to.
0N/A */
0N/A public void writeInheritedNestedClassSummaryFooter(ClassDoc nestedClass);
0N/A
0N/A /**
0N/A * Close the writer.
0N/A */
0N/A public void close() throws IOException;
0N/A}