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