1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/src/share/classes/com/sun/tools/doclets/internal/toolkit/ProfilePackageSummaryWriter.java Mon Jan 21 00:45:35 2013 -0500
1.3 @@ -0,0 +1,116 @@
1.4 +/*
1.5 + * Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved.
1.6 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
1.7 + *
1.8 + * This code is free software; you can redistribute it and/or modify it
1.9 + * under the terms of the GNU General Public License version 2 only, as
1.10 + * published by the Free Software Foundation. Oracle designates this
1.11 + * particular file as subject to the "Classpath" exception as provided
1.12 + * by Oracle in the LICENSE file that accompanied this code.
1.13 + *
1.14 + * This code is distributed in the hope that it will be useful, but WITHOUT
1.15 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
1.16 + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
1.17 + * version 2 for more details (a copy is included in the LICENSE file that
1.18 + * accompanied this code).
1.19 + *
1.20 + * You should have received a copy of the GNU General Public License version
1.21 + * 2 along with this work; if not, write to the Free Software Foundation,
1.22 + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
1.23 + *
1.24 + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
1.25 + * or visit www.oracle.com if you need additional information or have any
1.26 + * questions.
1.27 + */
1.28 +
1.29 +package com.sun.tools.doclets.internal.toolkit;
1.30 +
1.31 +import java.io.*;
1.32 +
1.33 +import com.sun.javadoc.*;
1.34 +
1.35 +/**
1.36 + * The interface for writing profile package summary output.
1.37 + *
1.38 + * <p><b>This is NOT part of any supported API.
1.39 + * If you write code that depends on this, you do so at your own risk.
1.40 + * This code and its internal interfaces are subject to change or
1.41 + * deletion without notice.</b>
1.42 + *
1.43 + * @author Bhavesh Patel
1.44 + */
1.45 +
1.46 +public interface ProfilePackageSummaryWriter {
1.47 +
1.48 + /**
1.49 + * Get the header for the summary.
1.50 + *
1.51 + * @param heading Package name.
1.52 + * @return the header to be added to the content tree
1.53 + */
1.54 + public abstract Content getPackageHeader(String heading);
1.55 +
1.56 + /**
1.57 + * Get the header for the content.
1.58 + *
1.59 + * @return a content tree for the content header
1.60 + */
1.61 + public abstract Content getContentHeader();
1.62 +
1.63 + /**
1.64 + * Get the header for the package summary.
1.65 + *
1.66 + * @return a content tree with the package summary header
1.67 + */
1.68 + public abstract Content getSummaryHeader();
1.69 +
1.70 + /**
1.71 + * Adds the table of classes to the documentation tree.
1.72 + *
1.73 + * @param classes the array of classes to document.
1.74 + * @param label the label for this table.
1.75 + * @param tableSummary the summary string for the table
1.76 + * @param tableHeader array of table headers
1.77 + * @param summaryContentTree the content tree to which the summaries will be added
1.78 + */
1.79 + public abstract void addClassesSummary(ClassDoc[] classes, String label,
1.80 + String tableSummary, String[] tableHeader, Content summaryContentTree);
1.81 +
1.82 + /**
1.83 + * Adds the package description from the "packages.html" file to the documentation
1.84 + * tree.
1.85 + *
1.86 + * @param packageContentTree the content tree to which the package description
1.87 + * will be added
1.88 + */
1.89 + public abstract void addPackageDescription(Content packageContentTree);
1.90 +
1.91 + /**
1.92 + * Adds the tag information from the "packages.html" file to the documentation
1.93 + * tree.
1.94 + *
1.95 + * @param packageContentTree the content tree to which the package tags will
1.96 + * be added
1.97 + */
1.98 + public abstract void addPackageTags(Content packageContentTree);
1.99 +
1.100 + /**
1.101 + * Adds the footer to the documentation tree.
1.102 + *
1.103 + * @param contentTree the tree to which the footer will be added
1.104 + */
1.105 + public abstract void addPackageFooter(Content contentTree);
1.106 +
1.107 + /**
1.108 + * Print the package summary document.
1.109 + *
1.110 + * @param contentTree the content tree that will be printed
1.111 + */
1.112 + public abstract void printDocument(Content contentTree) throws IOException;
1.113 +
1.114 + /**
1.115 + * Close the writer.
1.116 + */
1.117 + public abstract void close() throws IOException;
1.118 +
1.119 +}
