aoqi@0: /* aoqi@0: * Copyright (c) 2003, 2012, Oracle and/or its affiliates. All rights reserved. aoqi@0: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. aoqi@0: * aoqi@0: * This code is free software; you can redistribute it and/or modify it aoqi@0: * under the terms of the GNU General Public License version 2 only, as aoqi@0: * published by the Free Software Foundation. Oracle designates this aoqi@0: * particular file as subject to the "Classpath" exception as provided aoqi@0: * by Oracle in the LICENSE file that accompanied this code. aoqi@0: * aoqi@0: * This code is distributed in the hope that it will be useful, but WITHOUT aoqi@0: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or aoqi@0: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License aoqi@0: * version 2 for more details (a copy is included in the LICENSE file that aoqi@0: * accompanied this code). aoqi@0: * aoqi@0: * You should have received a copy of the GNU General Public License version aoqi@0: * 2 along with this work; if not, write to the Free Software Foundation, aoqi@0: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. aoqi@0: * aoqi@0: * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA aoqi@0: * or visit www.oracle.com if you need additional information or have any aoqi@0: * questions. aoqi@0: */ aoqi@0: aoqi@0: package com.sun.tools.doclets.internal.toolkit; aoqi@0: aoqi@0: import java.io.*; aoqi@0: import java.util.*; aoqi@0: aoqi@0: import com.sun.javadoc.*; aoqi@0: aoqi@0: /** aoqi@0: * The interface for writing constants summary output. aoqi@0: * aoqi@0: *

This is NOT part of any supported API. aoqi@0: * If you write code that depends on this, you do so at your own risk. aoqi@0: * This code and its internal interfaces are subject to change or aoqi@0: * deletion without notice. aoqi@0: * aoqi@0: * @author Jamie Ho aoqi@0: * @author Bhavesh Patel (Modified) aoqi@0: * @since 1.5 aoqi@0: */ aoqi@0: aoqi@0: public interface ConstantsSummaryWriter { aoqi@0: aoqi@0: /** aoqi@0: * Close the writer. aoqi@0: */ aoqi@0: public abstract void close() throws IOException; aoqi@0: aoqi@0: /** aoqi@0: * Get the header for the constant summary documentation. aoqi@0: * aoqi@0: * @return header that needs to be added to the documentation aoqi@0: */ aoqi@0: public abstract Content getHeader(); aoqi@0: aoqi@0: /** aoqi@0: * Get the header for the constant content list. aoqi@0: * aoqi@0: * @return content header that needs to be added to the documentation aoqi@0: */ aoqi@0: public abstract Content getContentsHeader(); aoqi@0: aoqi@0: /** aoqi@0: * Adds the given package name link to the constant content list tree. aoqi@0: * aoqi@0: * @param pkg the {@link PackageDoc} to index. aoqi@0: * @param parsedPackageName the parsed package name. We only Write the aoqi@0: * first 2 directory levels of the package aoqi@0: * name. For example, java.lang.ref would be aoqi@0: * indexed as java.lang.*. aoqi@0: * @param WriteedPackageHeaders the set of package headers that have already aoqi@0: * been indexed. We don't want to index aoqi@0: * something more than once. aoqi@0: * @param contentListTree the content tree to which the link will be added aoqi@0: */ aoqi@0: public abstract void addLinkToPackageContent(PackageDoc pkg, String parsedPackageName, aoqi@0: Set WriteedPackageHeaders, Content contentListTree); aoqi@0: aoqi@0: /** aoqi@0: * Get the content list to be added to the documentation tree. aoqi@0: * aoqi@0: * @param contentListTree the content that will be added to the list aoqi@0: * @return content list that will be added to the documentation tree aoqi@0: */ aoqi@0: public abstract Content getContentsList(Content contentListTree); aoqi@0: aoqi@0: /** aoqi@0: * Get the constant summaries for the document. aoqi@0: * aoqi@0: * @return constant summaries header to be added to the documentation tree aoqi@0: */ aoqi@0: public abstract Content getConstantSummaries(); aoqi@0: aoqi@0: /** aoqi@0: * Adds the given package name. aoqi@0: * aoqi@0: * @param pkg the {@link PackageDoc} to index. aoqi@0: * @param parsedPackageName the parsed package name. We only Write the aoqi@0: * first 2 directory levels of the package aoqi@0: * name. For example, java.lang.ref would be aoqi@0: * indexed as java.lang.*. aoqi@0: * @param summariesTree the documentation tree to which the package name will aoqi@0: * be written aoqi@0: */ aoqi@0: public abstract void addPackageName(PackageDoc pkg, aoqi@0: String parsedPackageName, Content summariesTree); aoqi@0: aoqi@0: /** aoqi@0: * Get the class summary header for the constants summary. aoqi@0: * aoqi@0: * @return the header content for the class constants summary aoqi@0: */ aoqi@0: public abstract Content getClassConstantHeader(); aoqi@0: aoqi@0: /** aoqi@0: * Adds the constant member table to the documentation tree. aoqi@0: * aoqi@0: * @param cd the class whose constants are being documented. aoqi@0: * @param fields the constants being documented. aoqi@0: * @param classConstantTree the documentation tree to which theconstant member aoqi@0: * table content will be added aoqi@0: */ aoqi@0: public abstract void addConstantMembers(ClassDoc cd, List fields, aoqi@0: Content classConstantTree); aoqi@0: aoqi@0: /** aoqi@0: * Adds the footer for the summary documentation. aoqi@0: * aoqi@0: * @param contentTree content tree to which the footer will be added aoqi@0: */ aoqi@0: public abstract void addFooter(Content contentTree); aoqi@0: aoqi@0: /** aoqi@0: * Print the constants summary document. aoqi@0: * aoqi@0: * @param contentTree content tree which should be printed aoqi@0: */ aoqi@0: public abstract void printDocument(Content contentTree) throws IOException; aoqi@0: aoqi@0: }