author | hannesw |
Wed, 27 Nov 2019 13:08:16 +0100 | |
changeset 59294 | 48b88b9c11eb |
parent 54596 | 86c1da00dd6a |
permissions | -rw-r--r-- |
10 | 1 |
/* |
47427 | 2 |
* Copyright (c) 2003, 2017, Oracle and/or its affiliates. All rights reserved. |
10 | 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 |
|
5520 | 7 |
* published by the Free Software Foundation. Oracle designates this |
10 | 8 |
* particular file as subject to the "Classpath" exception as provided |
5520 | 9 |
* by Oracle in the LICENSE file that accompanied this code. |
10 | 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 |
* |
|
5520 | 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. |
|
10 | 24 |
*/ |
25 |
||
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
29957
diff
changeset
|
26 |
package jdk.javadoc.internal.doclets.toolkit; |
10 | 27 |
|
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
29957
diff
changeset
|
28 |
import java.util.SortedSet; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
29957
diff
changeset
|
29 |
|
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
29957
diff
changeset
|
30 |
import javax.lang.model.element.TypeElement; |
10 | 31 |
|
40587 | 32 |
import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException; |
33 |
||
10 | 34 |
/** |
35 |
* The interface for writing package summary output. |
|
36 |
* |
|
14260
727a84636f12
8000665: fix "internal API" comments on javadoc files
jjg
parents:
14258
diff
changeset
|
37 |
* <p><b>This is NOT part of any supported API. |
727a84636f12
8000665: fix "internal API" comments on javadoc files
jjg
parents:
14258
diff
changeset
|
38 |
* If you write code that depends on this, you do so at your own risk. |
727a84636f12
8000665: fix "internal API" comments on javadoc files
jjg
parents:
14258
diff
changeset
|
39 |
* This code and its internal interfaces are subject to change or |
727a84636f12
8000665: fix "internal API" comments on javadoc files
jjg
parents:
14258
diff
changeset
|
40 |
* deletion without notice.</b> |
10 | 41 |
* |
42 |
* @author Jamie Ho |
|
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
43 |
* @author Bhavesh Patel (Modified) |
10 | 44 |
*/ |
45 |
||
46 |
public interface PackageSummaryWriter { |
|
47 |
||
48 |
/** |
|
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
49 |
* Get the header for the summary. |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
50 |
* |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
51 |
* @param heading Package name. |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
52 |
* @return the header to be added to the content tree |
10 | 53 |
*/ |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
54 |
public abstract Content getPackageHeader(String heading); |
10 | 55 |
|
56 |
/** |
|
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
57 |
* Get the header for the package content. |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
58 |
* |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
59 |
* @return a content tree for the package content header |
10 | 60 |
*/ |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
61 |
public abstract Content getContentHeader(); |
10 | 62 |
|
63 |
/** |
|
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
64 |
* Get the header for the package summary. |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
65 |
* |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
66 |
* @return a content tree with the package summary header |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
67 |
*/ |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
68 |
public abstract Content getSummaryHeader(); |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
69 |
|
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
70 |
/** |
47427 | 71 |
* Adds the table of interfaces to the documentation tree. |
72 |
* |
|
73 |
* @param interfaces the interfaces to document. |
|
74 |
* @param summaryContentTree the content tree to which the summaries will be added |
|
75 |
*/ |
|
76 |
public abstract void addInterfaceSummary(SortedSet<TypeElement> interfaces, |
|
77 |
Content summaryContentTree); |
|
78 |
||
79 |
/** |
|
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
80 |
* Adds the table of classes to the documentation tree. |
10 | 81 |
* |
47427 | 82 |
* @param classes the classes to document. |
83 |
* @param summaryContentTree the content tree to which the summaries will be added |
|
84 |
*/ |
|
85 |
public abstract void addClassSummary(SortedSet<TypeElement> classes, |
|
86 |
Content summaryContentTree); |
|
87 |
||
88 |
/** |
|
89 |
* Adds the table of enums to the documentation tree. |
|
90 |
* |
|
91 |
* @param enums the enums to document. |
|
92 |
* @param summaryContentTree the content tree to which the summaries will be added |
|
93 |
*/ |
|
94 |
public abstract void addEnumSummary(SortedSet<TypeElement> enums, |
|
95 |
Content summaryContentTree); |
|
96 |
||
97 |
/** |
|
98 |
* Adds the table of exceptions to the documentation tree. |
|
99 |
* |
|
100 |
* @param exceptions the exceptions to document. |
|
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
101 |
* @param summaryContentTree the content tree to which the summaries will be added |
10 | 102 |
*/ |
47427 | 103 |
public abstract void addExceptionSummary(SortedSet<TypeElement> exceptions, |
104 |
Content summaryContentTree); |
|
105 |
||
106 |
/** |
|
107 |
* Adds the table of errors to the documentation tree. |
|
108 |
* |
|
109 |
* @param errors the errors to document. |
|
110 |
* @param summaryContentTree the content tree to which the summaries will be added |
|
111 |
*/ |
|
112 |
public abstract void addErrorSummary(SortedSet<TypeElement> errors, |
|
113 |
Content summaryContentTree); |
|
114 |
||
115 |
/** |
|
116 |
* Adds the table of annotation types to the documentation tree. |
|
117 |
* |
|
118 |
* @param annoTypes the annotation types to document. |
|
119 |
* @param summaryContentTree the content tree to which the summaries will be added |
|
120 |
*/ |
|
121 |
public abstract void addAnnotationTypeSummary(SortedSet<TypeElement> annoTypes, |
|
122 |
Content summaryContentTree); |
|
10 | 123 |
|
124 |
/** |
|
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
125 |
* Adds the package description from the "packages.html" file to the documentation |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
126 |
* tree. |
10 | 127 |
* |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
128 |
* @param packageContentTree the content tree to which the package description |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
129 |
* will be added |
10 | 130 |
*/ |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
131 |
public abstract void addPackageDescription(Content packageContentTree); |
10 | 132 |
|
133 |
/** |
|
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
134 |
* Adds the tag information from the "packages.html" file to the documentation |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
135 |
* tree. |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
136 |
* |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
137 |
* @param packageContentTree the content tree to which the package tags will |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
138 |
* be added |
10 | 139 |
*/ |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
140 |
public abstract void addPackageTags(Content packageContentTree); |
10 | 141 |
|
142 |
/** |
|
29957
7740f9657f56
8072945: Javadoc should generate valid and compliant HTML5 output
bpatel
parents:
25874
diff
changeset
|
143 |
* Adds the tag information from the "packages.html" or "package-info.java" file to the |
7740f9657f56
8072945: Javadoc should generate valid and compliant HTML5 output
bpatel
parents:
25874
diff
changeset
|
144 |
* documentation tree. |
7740f9657f56
8072945: Javadoc should generate valid and compliant HTML5 output
bpatel
parents:
25874
diff
changeset
|
145 |
* |
7740f9657f56
8072945: Javadoc should generate valid and compliant HTML5 output
bpatel
parents:
25874
diff
changeset
|
146 |
* @param packageContentTree the package content tree to be added |
7740f9657f56
8072945: Javadoc should generate valid and compliant HTML5 output
bpatel
parents:
25874
diff
changeset
|
147 |
*/ |
59294
48b88b9c11eb
8223378: CSS solution for navbar problem with <a> elements is not ideal
hannesw
parents:
54596
diff
changeset
|
148 |
public abstract void addPackageContent(Content packageContentTree); |
29957
7740f9657f56
8072945: Javadoc should generate valid and compliant HTML5 output
bpatel
parents:
25874
diff
changeset
|
149 |
|
7740f9657f56
8072945: Javadoc should generate valid and compliant HTML5 output
bpatel
parents:
25874
diff
changeset
|
150 |
/** |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
151 |
* Adds the footer to the documentation tree. |
10 | 152 |
*/ |
59294
48b88b9c11eb
8223378: CSS solution for navbar problem with <a> elements is not ideal
hannesw
parents:
54596
diff
changeset
|
153 |
public abstract void addPackageFooter(); |
10 | 154 |
|
155 |
/** |
|
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
156 |
* Print the package summary document. |
10 | 157 |
* |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
158 |
* @param contentTree the content tree that will be printed |
40587 | 159 |
* @throws DocFileIOException if there is a problem while writing the document |
10 | 160 |
*/ |
40587 | 161 |
public abstract void printDocument(Content contentTree) throws DocFileIOException; |
10 | 162 |
|
54596
86c1da00dd6a
8219998: Eliminate inherently singleton lists
pmuthuswamy
parents:
47427
diff
changeset
|
163 |
/** |
86c1da00dd6a
8219998: Eliminate inherently singleton lists
pmuthuswamy
parents:
47427
diff
changeset
|
164 |
* Gets the package summary tree. |
86c1da00dd6a
8219998: Eliminate inherently singleton lists
pmuthuswamy
parents:
47427
diff
changeset
|
165 |
* @param summaryContentTree the content tree representing the package summary |
86c1da00dd6a
8219998: Eliminate inherently singleton lists
pmuthuswamy
parents:
47427
diff
changeset
|
166 |
* @return a content tree for the package summary |
86c1da00dd6a
8219998: Eliminate inherently singleton lists
pmuthuswamy
parents:
47427
diff
changeset
|
167 |
*/ |
86c1da00dd6a
8219998: Eliminate inherently singleton lists
pmuthuswamy
parents:
47427
diff
changeset
|
168 |
public abstract Content getPackageSummary(Content summaryContentTree); |
86c1da00dd6a
8219998: Eliminate inherently singleton lists
pmuthuswamy
parents:
47427
diff
changeset
|
169 |
|
10 | 170 |
} |