diff -r 000000000000 -r 9a66ca7c79fa src/share/classes/com/sun/tools/doclets/internal/toolkit/ConstructorWriter.java --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/share/classes/com/sun/tools/doclets/internal/toolkit/ConstructorWriter.java Sat Dec 01 00:00:00 2007 +0000 @@ -0,0 +1,112 @@ +/* + * Copyright 2003 Sun Microsystems, Inc. All Rights Reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Sun designates this + * particular file as subject to the "Classpath" exception as provided + * by Sun in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, + * CA 95054 USA or visit www.sun.com if you need additional information or + * have any questions. + */ + +package com.sun.tools.doclets.internal.toolkit; + +import java.io.*; +import com.sun.javadoc.*; + +/** + * The interface for writing constructor output. + * + * This code is not part of an API. + * It is implementation that is subject to change. + * Do not use it as an API + * + * @author Jamie Ho + * @since 1.5 + */ + +public interface ConstructorWriter { + + /** + * Write the header for the constructor documentation. + * + * @param classDoc the class that the constructors belong to. + * @param header the header to write. + */ + public void writeHeader(ClassDoc classDoc, String header); + + /** + * Write the constructor header for the given constructor. + * + * @param constructor the constructor being documented. + * @param isFirst the flag to indicate whether or not the constructor is the + * first to be documented. + */ + public void writeConstructorHeader(ConstructorDoc constructor, boolean isFirst); + + /** + * Write the signature for the given constructor. + * + * @param constructor the constructor being documented. + */ + public void writeSignature(ConstructorDoc constructor); + + /** + * Write the deprecated output for the given constructor. + * + * @param constructor the constructor being documented. + */ + public void writeDeprecated(ConstructorDoc constructor); + + /** + * Write the comments for the given constructor. + * + * @param constructor the constructor being documented. + */ + public void writeComments(ConstructorDoc constructor); + + /** + * Write the tag output for the given constructor. + * + * @param constructor the constructor being documented. + */ + public void writeTags(ConstructorDoc constructor); + + /** + * Write the constructor footer. + */ + public void writeConstructorFooter(); + + /** + * Write the footer for the constructor documentation. + * + * @param classDoc the class that the constructors belong to. + */ + public void writeFooter(ClassDoc classDoc); + + /** + * Let the writer know whether a non public constructor was found. + * + * @param foundNonPubConstructor true if we found a non public constructor. + */ + public void setFoundNonPubConstructor(boolean foundNonPubConstructor); + + /** + * Close the writer. + */ + public void close() throws IOException; +}