jdk8-mips64-public/langtools: src/share/classes/com/sun/tools/doclets/internal/toolkit/MemberSummaryWriter.java@4868a36f6fd8

     1 /*

     2  * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.

     3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

     4  *

     5  * This code is free software; you can redistribute it and/or modify it

     6  * under the terms of the GNU General Public License version 2 only, as

     7  * published by the Free Software Foundation.  Oracle designates this

     8  * particular file as subject to the "Classpath" exception as provided

     9  * by Oracle in the LICENSE file that accompanied this code.

    10  *

    11  * This code is distributed in the hope that it will be useful, but WITHOUT

    12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

    13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

    14  * version 2 for more details (a copy is included in the LICENSE file that

    15  * accompanied this code).

    16  *

    17  * You should have received a copy of the GNU General Public License version

    18  * 2 along with this work; if not, write to the Free Software Foundation,

    19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

    20  *

    21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

    22  * or visit www.oracle.com if you need additional information or have any

    23  * questions.

    24  */

    26 package com.sun.tools.doclets.internal.toolkit;

    28 import java.io.*;

    29 import java.util.*;

    30 import com.sun.javadoc.*;

    32 /**

    33  * The interface for writing member summary output.

    34  *

    35  * This code is not part of an API.

    36  * It is implementation that is subject to change.

    37  * Do not use it as an API

    38  *

    39  * @author Jamie Ho

    40  * @author Bhavesh Patel (Modified)

    41  * @since 1.5

    42  */

    44 public interface MemberSummaryWriter {

    46     /**

    47      * Get the member summary header for the given class.

    48      *

    49      * @param classDoc the class the summary belongs to

    50      * @param memberSummaryTree the content tree to which the member summary will be added

    51      * @return a content tree for the member summary header

    52      */

    53     public Content getMemberSummaryHeader(ClassDoc classDoc,

    54             Content memberSummaryTree);

    56     /**

    57      * Get the summary table for the given class.

    58      *

    59      * @param classDoc the class the summary table belongs to

    60      * @return a content tree for the member summary table

    61      */

    62     public Content getSummaryTableTree(ClassDoc classDoc);

    64     /**

    65      * Add the member summary for the given class and member.

    66      *

    67      * @param classDoc the class the summary belongs to

    68      * @param member the member that is documented

    69      * @param firstSentenceTags the tags for the sentence being documented

    70      * @param tableTree the content treeto which the information will be added

    71      * @param counter the counter for determing style for the table row

    72      */

    73     public void addMemberSummary(ClassDoc classDoc, ProgramElementDoc member,

    74         Tag[] firstSentenceTags, Content tableTree, int counter);

    76     /**

    77      * Get the inherited member summary header for the given class.

    78      *

    79      * @param classDoc the class the summary belongs to

    80      * @return a content tree containing the inherited summary header

    81      */

    82     public Content getInheritedSummaryHeader(ClassDoc classDoc);

    84     /**

    85      * Add the inherited member summary for the given class and member.

    86      *

    87      * @param classDoc the class the inherited member belongs to

    88      * @param member the inherited member that is being documented

    89      * @param isFirst true if this is the first member in the list

    90      * @param isLast true if this is the last member in the list

    91      * @param linksTree the content tree to which the links will be added

    92      */

    93     public void addInheritedMemberSummary(ClassDoc classDoc,

    94         ProgramElementDoc member, boolean isFirst, boolean isLast,

    95         Content linksTree);

    97     /**

    98      * Get inherited summary links.

    99      *

   100      * @return a content tree conatining the inherited summary links

   101      */

   102     public Content getInheritedSummaryLinksTree();

   104     /**

   105      * Get the member tree.

   106      *

   107      * @param memberTree the content tree representating the member

   108      * @return a content tree for the member

   109      */

   110     public Content getMemberTree(Content memberTree);

   112     /**

   113      * Close the writer.

   114      */

   115     public void close() throws IOException;

   116 }

Mercurial > jdk8-mips64-public > langtools / file revision