Mercurial > jdk8-mips64-public > langtools / annotate
src/share/classes/com/sun/tools/doclets/internal/toolkit/ProfilePackageSummaryWriter.java@5f0731e4e5e6 (annotated)
src/share/classes/com/sun/tools/doclets/internal/toolkit/ProfilePackageSummaryWriter.java
Mon, 21 Jan 2013 00:45:35 -0500
- author
- bpatel
- date
- Mon, 21 Jan 2013 00:45:35 -0500
- changeset 1568
- 5f0731e4e5e6
- parent 0
- 959103a6100f
- permissions
- -rw-r--r--
8006124: javadoc/doclet should be updated to support profiles
Reviewed-by: jjg
| aoqi@0 | 1 | /* |
| aoqi@0 | 2 | * Copyright (c) 2013, 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 | |
| aoqi@0 | 30 | import com.sun.javadoc.*; |
| aoqi@0 | 31 | |
| aoqi@0 | 32 | /** |
| aoqi@0 | 33 | * The interface for writing profile package 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 Bhavesh Patel |
| aoqi@0 | 41 | */ |
| aoqi@0 | 42 | |
| aoqi@0 | 43 | public interface ProfilePackageSummaryWriter { |
| aoqi@0 | 44 | |
| aoqi@0 | 45 | /** |
| aoqi@0 | 46 | * Get the header for the summary. |
| aoqi@0 | 47 | * |
| aoqi@0 | 48 | * @param heading Package name. |
| aoqi@0 | 49 | * @return the header to be added to the content tree |
| aoqi@0 | 50 | */ |
| aoqi@0 | 51 | public abstract Content getPackageHeader(String heading); |
| aoqi@0 | 52 | |
| aoqi@0 | 53 | /** |
| aoqi@0 | 54 | * Get the header for the content. |
| aoqi@0 | 55 | * |
| aoqi@0 | 56 | * @return a content tree for the content header |
| aoqi@0 | 57 | */ |
| aoqi@0 | 58 | public abstract Content getContentHeader(); |
| aoqi@0 | 59 | |
| aoqi@0 | 60 | /** |
| aoqi@0 | 61 | * Get the header for the package summary. |
| aoqi@0 | 62 | * |
| aoqi@0 | 63 | * @return a content tree with the package summary header |
| aoqi@0 | 64 | */ |
| aoqi@0 | 65 | public abstract Content getSummaryHeader(); |
| aoqi@0 | 66 | |
| aoqi@0 | 67 | /** |
| aoqi@0 | 68 | * Adds the table of classes to the documentation tree. |
| aoqi@0 | 69 | * |
| aoqi@0 | 70 | * @param classes the array of classes to document. |
| aoqi@0 | 71 | * @param label the label for this table. |
| aoqi@0 | 72 | * @param tableSummary the summary string for the table |
| aoqi@0 | 73 | * @param tableHeader array of table headers |
| aoqi@0 | 74 | * @param summaryContentTree the content tree to which the summaries will be added |
| aoqi@0 | 75 | */ |
| aoqi@0 | 76 | public abstract void addClassesSummary(ClassDoc[] classes, String label, |
| aoqi@0 | 77 | String tableSummary, String[] tableHeader, Content summaryContentTree); |
| aoqi@0 | 78 | |
| aoqi@0 | 79 | /** |
| aoqi@0 | 80 | * Adds the package description from the "packages.html" file to the documentation |
| aoqi@0 | 81 | * tree. |
| aoqi@0 | 82 | * |
| aoqi@0 | 83 | * @param packageContentTree the content tree to which the package description |
| aoqi@0 | 84 | * will be added |
| aoqi@0 | 85 | */ |
| aoqi@0 | 86 | public abstract void addPackageDescription(Content packageContentTree); |
| aoqi@0 | 87 | |
| aoqi@0 | 88 | /** |
| aoqi@0 | 89 | * Adds the tag information from the "packages.html" file to the documentation |
| aoqi@0 | 90 | * tree. |
| aoqi@0 | 91 | * |
| aoqi@0 | 92 | * @param packageContentTree the content tree to which the package tags will |
| aoqi@0 | 93 | * be added |
| aoqi@0 | 94 | */ |
| aoqi@0 | 95 | public abstract void addPackageTags(Content packageContentTree); |
| aoqi@0 | 96 | |
| aoqi@0 | 97 | /** |
| aoqi@0 | 98 | * Adds the footer to the documentation tree. |
| aoqi@0 | 99 | * |
| aoqi@0 | 100 | * @param contentTree the tree to which the footer will be added |
| aoqi@0 | 101 | */ |
| aoqi@0 | 102 | public abstract void addPackageFooter(Content contentTree); |
| aoqi@0 | 103 | |
| aoqi@0 | 104 | /** |
| aoqi@0 | 105 | * Print the package summary document. |
| aoqi@0 | 106 | * |
| aoqi@0 | 107 | * @param contentTree the content tree that will be printed |
| aoqi@0 | 108 | */ |
| aoqi@0 | 109 | public abstract void printDocument(Content contentTree) throws IOException; |
| aoqi@0 | 110 | |
| aoqi@0 | 111 | /** |
| aoqi@0 | 112 | * Close the writer. |
| aoqi@0 | 113 | */ |
| aoqi@0 | 114 | public abstract void close() throws IOException; |
| aoqi@0 | 115 | |
| aoqi@0 | 116 | } |
