aoqi@0: /*
aoqi@0:  * Copyright (c) 2003, 2012, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.  Oracle designates this
aoqi@0:  * particular file as subject to the "Classpath" exception as provided
aoqi@0:  * by Oracle in the LICENSE file that accompanied this code.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  */
aoqi@0: 
aoqi@0: package com.sun.tools.doclets.internal.toolkit;
aoqi@0: 
aoqi@0: import java.io.*;
aoqi@0: import com.sun.javadoc.*;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * The interface for writing constructor output.
aoqi@0:  *
aoqi@0:  *  <p><b>This is NOT part of any supported API.
aoqi@0:  *  If you write code that depends on this, you do so at your own risk.
aoqi@0:  *  This code and its internal interfaces are subject to change or
aoqi@0:  *  deletion without notice.</b>
aoqi@0:  *
aoqi@0:  * @author Jamie Ho
aoqi@0:  * @author Bhavesh Patel (Modified)
aoqi@0:  * @since 1.5
aoqi@0:  */
aoqi@0: 
aoqi@0: public interface ConstructorWriter {
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Get the constructor details tree header.
aoqi@0:      *
aoqi@0:      * @param classDoc the class being documented
aoqi@0:      * @param memberDetailsTree the content tree representing member details
aoqi@0:      * @return content tree for the constructor details header
aoqi@0:      */
aoqi@0:     public Content getConstructorDetailsTreeHeader(ClassDoc classDoc,
aoqi@0:             Content memberDetailsTree);
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Get the constructor documentation tree header.
aoqi@0:      *
aoqi@0:      * @param constructor the constructor being documented
aoqi@0:      * @param constructorDetailsTree the content tree representing constructor details
aoqi@0:      * @return content tree for the constructor documentation header
aoqi@0:      */
aoqi@0:     public Content getConstructorDocTreeHeader(ConstructorDoc constructor,
aoqi@0:             Content constructorDetailsTree);
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Get the signature for the given constructor.
aoqi@0:      *
aoqi@0:      * @param constructor the constructor being documented
aoqi@0:      * @return content tree for the constructor signature
aoqi@0:      */
aoqi@0:     public Content getSignature(ConstructorDoc constructor);
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Add the deprecated output for the given constructor.
aoqi@0:      *
aoqi@0:      * @param constructor the constructor being documented
aoqi@0:      * @param constructorDocTree content tree to which the deprecated information will be added
aoqi@0:      */
aoqi@0:     public void addDeprecated(ConstructorDoc constructor, Content constructorDocTree);
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Add the comments for the given constructor.
aoqi@0:      *
aoqi@0:      * @param constructor the constructor being documented
aoqi@0:      * @param constructorDocTree the content tree to which the comments will be added
aoqi@0:      */
aoqi@0:     public void addComments(ConstructorDoc constructor, Content constructorDocTree);
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Add the tags for the given constructor.
aoqi@0:      *
aoqi@0:      * @param constructor the constructor being documented
aoqi@0:      * @param constructorDocTree the content tree to which the tags will be added
aoqi@0:      */
aoqi@0:     public void addTags(ConstructorDoc constructor, Content constructorDocTree);
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Get the constructor details tree.
aoqi@0:      *
aoqi@0:      * @param memberDetailsTree the content tree representing member details
aoqi@0:      * @return content tree for the constructor details
aoqi@0:      */
aoqi@0:     public Content getConstructorDetails(Content memberDetailsTree);
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Get the constructor documentation.
aoqi@0:      *
aoqi@0:      * @param constructorDocTree the content tree representing constructor documentation
aoqi@0:      * @param isLastContent true if the content to be added is the last content
aoqi@0:      * @return content tree for the constructor documentation
aoqi@0:      */
aoqi@0:     public Content getConstructorDoc(Content constructorDocTree, boolean isLastContent);
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Let the writer know whether a non public constructor was found.
aoqi@0:      *
aoqi@0:      * @param foundNonPubConstructor true if we found a non public constructor.
aoqi@0:      */
aoqi@0:     public void setFoundNonPubConstructor(boolean foundNonPubConstructor);
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Close the writer.
aoqi@0:      */
aoqi@0:     public void close() throws IOException;
aoqi@0: }