Mercurial > jdk8-mips64-public > langtools / file revision
src/share/classes/com/sun/tools/doclets/internal/toolkit/ConstantsSummaryWriter.java@90af8d87741f
src/share/classes/com/sun/tools/doclets/internal/toolkit/ConstantsSummaryWriter.java
Wed, 01 Dec 2010 11:02:38 -0800
- author
- bpatel
- date
- Wed, 01 Dec 2010 11:02:38 -0800
- changeset 766
- 90af8d87741f
- parent 554
- 9d9f26857129
- child 798
- 4868a36f6fd8
- permissions
- -rw-r--r--
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
Reviewed-by: jjg
1 /*
2 * Copyright (c) 2003, 2008, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
26 package com.sun.tools.doclets.internal.toolkit;
28 import java.util.*;
29 import java.io.*;
30 import com.sun.javadoc.*;
32 /**
33 * The interface for writing constants summary output.
34 *
35 * This code is not part of an API.
36 * It is implementation that is subject to change.
37 * Do not use it as an API
38 *
39 * @author Jamie Ho
40 * @author Bhavesh Patel (Modified)
41 * @since 1.5
42 */
44 public interface ConstantsSummaryWriter {
46 /**
47 * Close the writer.
48 */
49 public abstract void close() throws IOException;
51 /**
52 * Get the header for the constant summary documentation.
53 *
54 * @return header that needs to be added to the documentation
55 */
56 public abstract Content getHeader();
58 /**
59 * Get the header for the constant content list.
60 *
61 * @return content header that needs to be added to the documentation
62 */
63 public abstract Content getContentsHeader();
65 /**
66 * Adds the given package name link to the constant content list tree.
67 *
68 * @param pkg the {@link PackageDoc} to index.
69 * @param parsedPackageName the parsed package name. We only Write the
70 * first 2 directory levels of the package
71 * name. For example, java.lang.ref would be
72 * indexed as java.lang.*.
73 * @param WriteedPackageHeaders the set of package headers that have already
74 * been indexed. We don't want to index
75 * something more than once.
76 * @param contentListTree the content tree to which the link will be added
77 */
78 public abstract void addLinkToPackageContent(PackageDoc pkg, String parsedPackageName,
79 Set<String> WriteedPackageHeaders, Content contentListTree);
81 /**
82 * Get the content list to be added to the documentation tree.
83 *
84 * @param contentListTree the content that will be added to the list
85 * @return content list that will be added to the documentation tree
86 */
87 public abstract Content getContentsList(Content contentListTree);
89 /**
90 * Get the constant summaries for the document.
91 *
92 * @return constant summaries header to be added to the documentation tree
93 */
94 public abstract Content getConstantSummaries();
96 /**
97 * Adds the given package name.
98 *
99 * @param pkg the {@link PackageDoc} to index.
100 * @param parsedPackageName the parsed package name. We only Write the
101 * first 2 directory levels of the package
102 * name. For example, java.lang.ref would be
103 * indexed as java.lang.*.
104 * @param summariesTree the documentation tree to which the package name will
105 * be written
106 */
107 public abstract void addPackageName(PackageDoc pkg,
108 String parsedPackageName, Content summariesTree);
110 /**
111 * Get the class summary header for the constants summary.
112 *
113 * @return the header content for the class constants summary
114 */
115 public abstract Content getClassConstantHeader();
117 /**
118 * Adds the constant member table to the documentation tree.
119 *
120 * @param cd the class whose constants are being documented.
121 * @param fields the constants being documented.
122 * @param classConstantTree the documentation tree to which theconstant member
123 * table content will be added
124 */
125 public abstract void addConstantMembers(ClassDoc cd, List<FieldDoc> fields,
126 Content classConstantTree);
128 /**
129 * Adds the footer for the summary documentation.
130 *
131 * @param contentTree content tree to which the footer will be added
132 */
133 public abstract void addFooter(Content contentTree);
135 /**
136 * Print the constants summary document.
137 *
138 * @param contentTree content tree which should be printed
139 */
140 public abstract void printDocument(Content contentTree);
142 }
