ConstantsSummaryWriter.java revision 0
0N/A/*
0N/A * Copyright 2003 Sun Microsystems, Inc. All Rights Reserved.
0N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
0N/A *
0N/A * This code is free software; you can redistribute it and/or modify it
0N/A * under the terms of the GNU General Public License version 2 only, as
0N/A * published by the Free Software Foundation. Sun designates this
0N/A * particular file as subject to the "Classpath" exception as provided
0N/A * by Sun in the LICENSE file that accompanied this code.
0N/A *
0N/A * This code is distributed in the hope that it will be useful, but WITHOUT
0N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
0N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
0N/A * version 2 for more details (a copy is included in the LICENSE file that
0N/A * accompanied this code).
0N/A *
0N/A * You should have received a copy of the GNU General Public License version
0N/A * 2 along with this work; if not, write to the Free Software Foundation,
0N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
0N/A *
0N/A * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
0N/A * CA 95054 USA or visit www.sun.com if you need additional information or
0N/A * have any questions.
0N/A */
0N/A
0N/Apackage com.sun.tools.doclets.internal.toolkit;
0N/A
0N/Aimport com.sun.javadoc.*;
0N/Aimport java.util.*;
0N/Aimport java.io.*;
0N/A
0N/A/**
0N/A * The interface for writing constants summary output.
0N/A *
0N/A * This code is not part of an API.
0N/A * It is implementation that is subject to change.
0N/A * Do not use it as an API
0N/A *
0N/A * @author Jamie Ho
0N/A * @since 1.5
0N/A */
0N/A
0N/Apublic interface ConstantsSummaryWriter {
0N/A
0N/A /**
0N/A * Write the header for the summary.
0N/A */
0N/A public abstract void writeHeader();
0N/A
0N/A /**
0N/A * Write the footer for the summary.
0N/A */
0N/A public abstract void writeFooter();
0N/A
0N/A /**
0N/A * Close the writer.
0N/A */
0N/A public abstract void close() throws IOException;
0N/A
0N/A /**
0N/A * Write the header for the index.
0N/A */
0N/A public abstract void writeContentsHeader();
0N/A
0N/A /**
0N/A * Write the footer for the index.
0N/A */
0N/A public abstract void writeContentsFooter();
0N/A
0N/A /**
0N/A * Add the given package name to the index.
0N/A * @param pkg the {@link PackageDoc} to index.
0N/A * @param parsedPackageName the parsed package name. We only Write the
0N/A * first 2 directory levels of the package
0N/A * name. For example, java.lang.ref would be
0N/A * indexed as java.lang.*.
0N/A * @param WriteedPackageHeaders the set of package headers that have already
0N/A * been indexed. We don't want to index
0N/A * something more than once.
0N/A */
0N/A public abstract void writeLinkToPackageContent(PackageDoc pkg, String parsedPackageName,
0N/A Set WriteedPackageHeaders);
0N/A
0N/A /**
0N/A * Write the given package name.
0N/A * @param pkg the {@link PackageDoc} to index.
0N/A * @param parsedPackageName the parsed package name. We only Write the
0N/A * first 2 directory levels of the package
0N/A * name. For example, java.lang.ref would be
0N/A * indexed as java.lang.*.
0N/A */
0N/A public abstract void writePackageName(PackageDoc pkg,
0N/A String parsedPackageName);
0N/A
0N/A /**
0N/A * Write the heading for the current table of constants for a given class.
0N/A * @param cd the class whose constants are being documented.
0N/A */
0N/A public abstract void writeConstantMembersHeader(ClassDoc cd);
0N/A
0N/A /**
0N/A * Document the given constants.
0N/A * @param cd the class whose constants are being documented.
0N/A * @param fields the constants being documented.
0N/A */
0N/A public abstract void writeConstantMembers(ClassDoc cd, List fields);
0N/A
0N/A /**
0N/A * Document the given constants.
0N/A * @param cd the class whose constants are being documented.
0N/A */
0N/A public abstract void writeConstantMembersFooter(ClassDoc cd);
0N/A
0N/A}