Mercurial > jdk8-mips64-public > langtools / annotate
src/share/classes/com/sun/tools/doclets/internal/toolkit/MemberSummaryWriter.java@93012e2a5d1d (annotated)
src/share/classes/com/sun/tools/doclets/internal/toolkit/MemberSummaryWriter.java
Sat, 07 Nov 2020 10:30:02 +0800
- author
- aoqi
- date
- Sat, 07 Nov 2020 10:30:02 +0800
- changeset 3938
- 93012e2a5d1d
- parent 2525
- 2eb010b6cb22
- permissions
- -rw-r--r--
Added tag mips-jdk8u275-b01 for changeset eb6ee6a5f2fe
| aoqi@0 | 1 | /* |
| aoqi@0 | 2 | * Copyright (c) 2003, 2012, Oracle and/or its affiliates. All rights reserved. |
| aoqi@0 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| aoqi@0 | 4 | * |
| aoqi@0 | 5 | * This code is free software; you can redistribute it and/or modify it |
| aoqi@0 | 6 | * under the terms of the GNU General Public License version 2 only, as |
| aoqi@0 | 7 | * published by the Free Software Foundation. Oracle designates this |
| aoqi@0 | 8 | * particular file as subject to the "Classpath" exception as provided |
| aoqi@0 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
| aoqi@0 | 10 | * |
| aoqi@0 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| aoqi@0 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| aoqi@0 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| aoqi@0 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| aoqi@0 | 15 | * accompanied this code). |
| aoqi@0 | 16 | * |
| aoqi@0 | 17 | * You should have received a copy of the GNU General Public License version |
| aoqi@0 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| aoqi@0 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| aoqi@0 | 20 | * |
| aoqi@0 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| aoqi@0 | 22 | * or visit www.oracle.com if you need additional information or have any |
| aoqi@0 | 23 | * questions. |
| aoqi@0 | 24 | */ |
| aoqi@0 | 25 | |
| aoqi@0 | 26 | package com.sun.tools.doclets.internal.toolkit; |
| aoqi@0 | 27 | |
| aoqi@0 | 28 | import java.io.*; |
| aoqi@0 | 29 | import java.util.*; |
| aoqi@0 | 30 | import com.sun.javadoc.*; |
| aoqi@0 | 31 | |
| aoqi@0 | 32 | /** |
| aoqi@0 | 33 | * The interface for writing member summary output. |
| aoqi@0 | 34 | * |
| aoqi@0 | 35 | * <p><b>This is NOT part of any supported API. |
| aoqi@0 | 36 | * If you write code that depends on this, you do so at your own risk. |
| aoqi@0 | 37 | * This code and its internal interfaces are subject to change or |
| aoqi@0 | 38 | * deletion without notice.</b> |
| aoqi@0 | 39 | * |
| aoqi@0 | 40 | * @author Jamie Ho |
| aoqi@0 | 41 | * @author Bhavesh Patel (Modified) |
| aoqi@0 | 42 | * @since 1.5 |
| aoqi@0 | 43 | */ |
| aoqi@0 | 44 | |
| aoqi@0 | 45 | public interface MemberSummaryWriter { |
| aoqi@0 | 46 | |
| aoqi@0 | 47 | /** |
| aoqi@0 | 48 | * Get the member summary header for the given class. |
| aoqi@0 | 49 | * |
| aoqi@0 | 50 | * @param classDoc the class the summary belongs to |
| aoqi@0 | 51 | * @param memberSummaryTree the content tree to which the member summary will be added |
| aoqi@0 | 52 | * @return a content tree for the member summary header |
| aoqi@0 | 53 | */ |
| aoqi@0 | 54 | public Content getMemberSummaryHeader(ClassDoc classDoc, |
| aoqi@0 | 55 | Content memberSummaryTree); |
| aoqi@0 | 56 | |
| aoqi@0 | 57 | /** |
| aoqi@0 | 58 | * Get the summary table for the given class. |
| aoqi@0 | 59 | * |
| aoqi@0 | 60 | * @param classDoc the class the summary table belongs to |
| aoqi@0 | 61 | * @param tableContents list of contents that will be added to the summary table |
| aoqi@0 | 62 | * @return a content tree for the member summary table |
| aoqi@0 | 63 | */ |
| aoqi@0 | 64 | public Content getSummaryTableTree(ClassDoc classDoc, |
| aoqi@0 | 65 | List<Content> tableContents); |
| aoqi@0 | 66 | |
| aoqi@0 | 67 | /** |
| aoqi@0 | 68 | * Add the member summary for the given class and member. |
| aoqi@0 | 69 | * |
| aoqi@0 | 70 | * @param classDoc the class the summary belongs to |
| aoqi@0 | 71 | * @param member the member that is documented |
| aoqi@0 | 72 | * @param firstSentenceTags the tags for the sentence being documented |
| aoqi@0 | 73 | * @param tableContents list of contents to which the summary will be added |
| aoqi@0 | 74 | * @param counter the counter for determining id and style for the table row |
| aoqi@0 | 75 | */ |
| aoqi@0 | 76 | public void addMemberSummary(ClassDoc classDoc, ProgramElementDoc member, |
| aoqi@0 | 77 | Tag[] firstSentenceTags, List<Content> tableContents, int counter); |
| aoqi@0 | 78 | |
| aoqi@0 | 79 | /** |
| aoqi@0 | 80 | * Get the inherited member summary header for the given class. |
| aoqi@0 | 81 | * |
| aoqi@0 | 82 | * @param classDoc the class the summary belongs to |
| aoqi@0 | 83 | * @return a content tree containing the inherited summary header |
| aoqi@0 | 84 | */ |
| aoqi@0 | 85 | public Content getInheritedSummaryHeader(ClassDoc classDoc); |
| aoqi@0 | 86 | |
| aoqi@0 | 87 | /** |
| aoqi@0 | 88 | * Add the inherited member summary for the given class and member. |
| aoqi@0 | 89 | * |
| aoqi@0 | 90 | * @param classDoc the class the inherited member belongs to |
| aoqi@0 | 91 | * @param member the inherited member that is being documented |
| aoqi@0 | 92 | * @param isFirst true if this is the first member in the list |
| aoqi@0 | 93 | * @param isLast true if this is the last member in the list |
| aoqi@0 | 94 | * @param linksTree the content tree to which the links will be added |
| aoqi@0 | 95 | */ |
| aoqi@0 | 96 | public void addInheritedMemberSummary(ClassDoc classDoc, |
| aoqi@0 | 97 | ProgramElementDoc member, boolean isFirst, boolean isLast, |
| aoqi@0 | 98 | Content linksTree); |
| aoqi@0 | 99 | |
| aoqi@0 | 100 | /** |
| aoqi@0 | 101 | * Get inherited summary links. |
| aoqi@0 | 102 | * |
| aoqi@0 | 103 | * @return a content tree conatining the inherited summary links |
| aoqi@0 | 104 | */ |
| aoqi@0 | 105 | public Content getInheritedSummaryLinksTree(); |
| aoqi@0 | 106 | |
| aoqi@0 | 107 | /** |
| aoqi@0 | 108 | * Get the member tree. |
| aoqi@0 | 109 | * |
| aoqi@0 | 110 | * @param memberTree the content tree representating the member |
| aoqi@0 | 111 | * @return a content tree for the member |
| aoqi@0 | 112 | */ |
| aoqi@0 | 113 | public Content getMemberTree(Content memberTree); |
| aoqi@0 | 114 | |
| aoqi@0 | 115 | /** |
| aoqi@0 | 116 | * Close the writer. |
| aoqi@0 | 117 | */ |
| aoqi@0 | 118 | public void close() throws IOException; |
| aoqi@0 | 119 | } |
