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 java.util.*;
aoqi@0: import com.sun.javadoc.*;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * The interface for writing member summary 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 MemberSummaryWriter {
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Get the member summary header for the given class.
aoqi@0:      *
aoqi@0:      * @param classDoc the class the summary belongs to
aoqi@0:      * @param memberSummaryTree the content tree to which the member summary will be added
aoqi@0:      * @return a content tree for the member summary header
aoqi@0:      */
aoqi@0:     public Content getMemberSummaryHeader(ClassDoc classDoc,
aoqi@0:             Content memberSummaryTree);
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Get the summary table for the given class.
aoqi@0:      *
aoqi@0:      * @param classDoc the class the summary table belongs to
aoqi@0:      * @param tableContents list of contents that will be added to the summary table
aoqi@0:      * @return a content tree for the member summary table
aoqi@0:      */
aoqi@0:     public Content getSummaryTableTree(ClassDoc classDoc,
aoqi@0:             List<Content> tableContents);
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Add the member summary for the given class and member.
aoqi@0:      *
aoqi@0:      * @param classDoc the class the summary belongs to
aoqi@0:      * @param member the member that is documented
aoqi@0:      * @param firstSentenceTags the tags for the sentence being documented
aoqi@0:      * @param tableContents list of contents to which the summary will be added
aoqi@0:      * @param counter the counter for determining id and style for the table row
aoqi@0:      */
aoqi@0:     public void addMemberSummary(ClassDoc classDoc, ProgramElementDoc member,
aoqi@0:             Tag[] firstSentenceTags, List<Content> tableContents, int counter);
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Get the inherited member summary header for the given class.
aoqi@0:      *
aoqi@0:      * @param classDoc the class the summary belongs to
aoqi@0:      * @return a content tree containing the inherited summary header
aoqi@0:      */
aoqi@0:     public Content getInheritedSummaryHeader(ClassDoc classDoc);
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Add the inherited member summary for the given class and member.
aoqi@0:      *
aoqi@0:      * @param classDoc the class the inherited member belongs to
aoqi@0:      * @param member the inherited member that is being documented
aoqi@0:      * @param isFirst true if this is the first member in the list
aoqi@0:      * @param isLast true if this is the last member in the list
aoqi@0:      * @param linksTree the content tree to which the links will be added
aoqi@0:      */
aoqi@0:     public void addInheritedMemberSummary(ClassDoc classDoc,
aoqi@0:         ProgramElementDoc member, boolean isFirst, boolean isLast,
aoqi@0:         Content linksTree);
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Get inherited summary links.
aoqi@0:      *
aoqi@0:      * @return a content tree conatining the inherited summary links
aoqi@0:      */
aoqi@0:     public Content getInheritedSummaryLinksTree();
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Get the member tree.
aoqi@0:      *
aoqi@0:      * @param memberTree the content tree representating the member
aoqi@0:      * @return a content tree for the member
aoqi@0:      */
aoqi@0:     public Content getMemberTree(Content memberTree);
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Close the writer.
aoqi@0:      */
aoqi@0:     public void close() throws IOException;
aoqi@0: }