duke@1: /*
jjg@1359:  * Copyright (c) 2003, 2012, Oracle and/or its affiliates. All rights reserved.
duke@1:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1:  *
duke@1:  * This code is free software; you can redistribute it and/or modify it
duke@1:  * under the terms of the GNU General Public License version 2 only, as
ohair@554:  * published by the Free Software Foundation.  Oracle designates this
duke@1:  * particular file as subject to the "Classpath" exception as provided
ohair@554:  * by Oracle in the LICENSE file that accompanied this code.
duke@1:  *
duke@1:  * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
duke@1:  * version 2 for more details (a copy is included in the LICENSE file that
duke@1:  * accompanied this code).
duke@1:  *
duke@1:  * You should have received a copy of the GNU General Public License version
duke@1:  * 2 along with this work; if not, write to the Free Software Foundation,
duke@1:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1:  *
ohair@554:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@554:  * or visit www.oracle.com if you need additional information or have any
ohair@554:  * questions.
duke@1:  */
duke@1: 
duke@1: package com.sun.tools.doclets.internal.toolkit;
duke@1: 
duke@1: import java.io.*;
bpatel@766: import java.util.*;
duke@1: import com.sun.javadoc.*;
duke@1: 
duke@1: /**
duke@1:  * The interface for writing member summary output.
duke@1:  *
jjg@1359:  *  <p><b>This is NOT part of any supported API.
jjg@1359:  *  If you write code that depends on this, you do so at your own risk.
jjg@1359:  *  This code and its internal interfaces are subject to change or
jjg@1359:  *  deletion without notice.</b>
duke@1:  *
duke@1:  * @author Jamie Ho
bpatel@766:  * @author Bhavesh Patel (Modified)
duke@1:  * @since 1.5
duke@1:  */
duke@1: 
duke@1: public interface MemberSummaryWriter {
duke@1: 
duke@1:     /**
bpatel@766:      * Get the member summary header for the given class.
duke@1:      *
bpatel@766:      * @param classDoc the class the summary belongs to
bpatel@766:      * @param memberSummaryTree the content tree to which the member summary will be added
bpatel@766:      * @return a content tree for the member summary header
duke@1:      */
bpatel@766:     public Content getMemberSummaryHeader(ClassDoc classDoc,
bpatel@766:             Content memberSummaryTree);
duke@1: 
duke@1:     /**
bpatel@766:      * Get the summary table for the given class.
duke@1:      *
bpatel@766:      * @param classDoc the class the summary table belongs to
bpatel@1417:      * @param tableContents list of contents that will be added to the summary table
bpatel@766:      * @return a content tree for the member summary table
duke@1:      */
bpatel@1417:     public Content getSummaryTableTree(ClassDoc classDoc,
bpatel@1417:             List<Content> tableContents);
duke@1: 
duke@1:     /**
bpatel@766:      * Add the member summary for the given class and member.
duke@1:      *
bpatel@766:      * @param classDoc the class the summary belongs to
bpatel@766:      * @param member the member that is documented
bpatel@766:      * @param firstSentenceTags the tags for the sentence being documented
bpatel@1417:      * @param tableContents list of contents to which the summary will be added
bpatel@1417:      * @param counter the counter for determining id and style for the table row
duke@1:      */
bpatel@766:     public void addMemberSummary(ClassDoc classDoc, ProgramElementDoc member,
bpatel@1417:             Tag[] firstSentenceTags, List<Content> tableContents, int counter);
duke@1: 
duke@1:     /**
bpatel@766:      * Get the inherited member summary header for the given class.
duke@1:      *
bpatel@766:      * @param classDoc the class the summary belongs to
bpatel@766:      * @return a content tree containing the inherited summary header
duke@1:      */
bpatel@766:     public Content getInheritedSummaryHeader(ClassDoc classDoc);
duke@1: 
duke@1:     /**
bpatel@766:      * Add the inherited member summary for the given class and member.
duke@1:      *
bpatel@766:      * @param classDoc the class the inherited member belongs to
bpatel@766:      * @param member the inherited member that is being documented
bpatel@766:      * @param isFirst true if this is the first member in the list
bpatel@766:      * @param isLast true if this is the last member in the list
bpatel@766:      * @param linksTree the content tree to which the links will be added
duke@1:      */
bpatel@766:     public void addInheritedMemberSummary(ClassDoc classDoc,
bpatel@766:         ProgramElementDoc member, boolean isFirst, boolean isLast,
bpatel@766:         Content linksTree);
duke@1: 
duke@1:     /**
bpatel@766:      * Get inherited summary links.
duke@1:      *
bpatel@766:      * @return a content tree conatining the inherited summary links
duke@1:      */
bpatel@766:     public Content getInheritedSummaryLinksTree();
bpatel@766: 
bpatel@766:     /**
bpatel@766:      * Get the member tree.
bpatel@766:      *
bpatel@766:      * @param memberTree the content tree representating the member
bpatel@766:      * @return a content tree for the member
bpatel@766:      */
bpatel@766:     public Content getMemberTree(Content memberTree);
duke@1: 
duke@1:     /**
duke@1:      * Close the writer.
duke@1:      */
duke@1:     public void close() throws IOException;
duke@1: }