Skip to content

Commit 12050f0

Browse files
hnshns
committed
8266651: Convert Table method parameters from String to Content
Reviewed-by: jjg
1 parent e749f75 commit 12050f0

File tree

8 files changed

+57
-59
lines changed

8 files changed

+57
-59
lines changed

‎src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/AllClassesIndexWriter.java

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -115,14 +115,14 @@ protected void addContents(Content content) {
115115
.setHeader(new TableHeader(contents.classLabel, contents.descriptionLabel))
116116
.setColumnStyles(HtmlStyle.colFirst, HtmlStyle.colLast)
117117
.setId(HtmlIds.ALL_CLASSES_TABLE)
118-
.setDefaultTab(contents.allClassesAndInterfacesLabel.toString())
119-
.addTab(contents.interfaces.toString(), utils::isInterface)
120-
.addTab(contents.classes.toString(), e -> utils.isOrdinaryClass((TypeElement)e))
121-
.addTab(contents.enums.toString(), utils::isEnum)
122-
.addTab(contents.records.toString(), e -> utils.isRecord((TypeElement)e))
123-
.addTab(contents.exceptions.toString(), e -> utils.isException((TypeElement)e))
124-
.addTab(contents.errors.toString(), e -> utils.isError((TypeElement)e))
125-
.addTab(contents.annotationTypes.toString(), utils::isAnnotationType);
118+
.setDefaultTab(contents.allClassesAndInterfacesLabel)
119+
.addTab(contents.interfaces, utils::isInterface)
120+
.addTab(contents.classes, e -> utils.isOrdinaryClass((TypeElement)e))
121+
.addTab(contents.enums, utils::isEnum)
122+
.addTab(contents.records, e -> utils.isRecord((TypeElement)e))
123+
.addTab(contents.exceptions, e -> utils.isException((TypeElement)e))
124+
.addTab(contents.errors, e -> utils.isError((TypeElement)e))
125+
.addTab(contents.annotationTypes, utils::isAnnotationType);
126126
for (Character unicode : indexBuilder.getFirstCharacters()) {
127127
for (IndexItem indexItem : indexBuilder.getItems(unicode)) {
128128
TypeElement typeElement = (TypeElement) indexItem.getElement();

‎src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/MethodWriterImpl.java

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -201,14 +201,14 @@ protected Table createSummaryTable() {
201201
.setHeader(getSummaryTableHeader(typeElement))
202202
.setColumnStyles(HtmlStyle.colFirst, HtmlStyle.colSecond, HtmlStyle.colLast)
203203
.setId(HtmlIds.METHOD_SUMMARY_TABLE)
204-
.setDefaultTab(resources.getText("doclet.All_Methods"))
205-
.addTab(resources.getText("doclet.Static_Methods"), utils::isStatic)
206-
.addTab(resources.getText("doclet.Instance_Methods"), e -> !utils.isStatic(e))
207-
.addTab(resources.getText("doclet.Abstract_Methods"), utils::isAbstract)
208-
.addTab(resources.getText("doclet.Concrete_Methods"),
204+
.setDefaultTab(contents.getContent("doclet.All_Methods"))
205+
.addTab(contents.getContent("doclet.Static_Methods"), utils::isStatic)
206+
.addTab(contents.getContent("doclet.Instance_Methods"), e -> !utils.isStatic(e))
207+
.addTab(contents.getContent("doclet.Abstract_Methods"), utils::isAbstract)
208+
.addTab(contents.getContent("doclet.Concrete_Methods"),
209209
e -> !utils.isAbstract(e) && !utils.isInterface(e.getEnclosingElement()))
210-
.addTab(resources.getText("doclet.Default_Methods"), utils::isDefault)
211-
.addTab(resources.getText("doclet.Deprecated_Methods"),
210+
.addTab(contents.getContent("doclet.Default_Methods"), utils::isDefault)
211+
.addTab(contents.getContent("doclet.Deprecated_Methods"),
212212
e -> utils.isDeprecated(e) || utils.isDeprecated(typeElement));
213213
}
214214

‎src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/ModuleIndexWriter.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,13 +93,13 @@ protected void addIndex(Content main) {
9393
.setHeader(tableHeader)
9494
.setColumnStyles(HtmlStyle.colFirst, HtmlStyle.colLast)
9595
.setId(HtmlIds.ALL_MODULES_TABLE)
96-
.setDefaultTab(resources.getText("doclet.All_Modules"));
96+
.setDefaultTab(contents.getContent("doclet.All_Modules"));
9797

9898
// add the tabs in command-line order
9999
for (String groupName : configuration.group.getGroupList()) {
100100
Set<ModuleElement> groupModules = groupModuleMap.get(groupName);
101101
if (groupModules != null) {
102-
table.addTab(groupName, groupModules::contains);
102+
table.addTab(Text.of(groupName), groupModules::contains);
103103
}
104104
}
105105

‎src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/ModuleWriterImpl.java

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -551,10 +551,10 @@ public void addPackagesSummary(Content summariesList) {
551551
public void addPackageSummary(HtmlTree li) {
552552
Table table = new Table(HtmlStyle.summaryTable)
553553
.setId(HtmlIds.PACKAGE_SUMMARY_TABLE)
554-
.setDefaultTab(resources.getText("doclet.All_Packages"))
555-
.addTab(resources.getText("doclet.Exported_Packages_Summary"), this::isExported)
556-
.addTab(resources.getText("doclet.Opened_Packages_Summary"), this::isOpened)
557-
.addTab(resources.getText("doclet.Concealed_Packages_Summary"), this::isConcealed);
554+
.setDefaultTab(contents.getContent("doclet.All_Packages"))
555+
.addTab(contents.getContent("doclet.Exported_Packages_Summary"), this::isExported)
556+
.addTab(contents.getContent("doclet.Opened_Packages_Summary"), this::isOpened)
557+
.addTab(contents.getContent("doclet.Concealed_Packages_Summary"), this::isConcealed);
558558

559559
// Determine whether to show the "Exported To" and "Opened To" columns,
560560
// based on whether such columns would provide "useful" info.
@@ -648,9 +648,9 @@ private boolean isConcealed(Element e) {
648648

649649
private Content getPackageExportOpensTo(Set<ModuleElement> modules) {
650650
if (modules == null) {
651-
return Text.of(resources.getText("doclet.None"));
651+
return contents.getContent("doclet.None");
652652
} else if (modules.isEmpty()) {
653-
return Text.of(resources.getText("doclet.All_Modules"));
653+
return contents.getContent("doclet.All_Modules");
654654
} else {
655655
Content list = new ContentBuilder();
656656
for (ModuleElement m : modules) {

‎src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/PackageIndexWriter.java

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@
3131

3232
import jdk.javadoc.internal.doclets.formats.html.markup.ContentBuilder;
3333
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;
34+
import jdk.javadoc.internal.doclets.formats.html.markup.Text;
3435
import jdk.javadoc.internal.doclets.toolkit.Content;
3536
import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
3637
import jdk.javadoc.internal.doclets.toolkit.util.DocPath;
@@ -93,13 +94,13 @@ protected void addIndex(Content main) {
9394
.setHeader(getPackageTableHeader())
9495
.setColumnStyles(HtmlStyle.colFirst, HtmlStyle.colLast)
9596
.setId(HtmlIds.ALL_PACKAGES_TABLE)
96-
.setDefaultTab(resources.getText("doclet.All_Packages"));
97+
.setDefaultTab(contents.getContent("doclet.All_Packages"));
9798

9899
// add the tabs in command-line order
99100
for (String groupName : configuration.group.getGroupList()) {
100101
Set<PackageElement> groupPackages = groupPackageMap.get(groupName);
101102
if (groupPackages != null) {
102-
table.addTab(groupName, groupPackages::contains);
103+
table.addTab(Text.of(groupName), groupPackages::contains);
103104
}
104105
}
105106

‎src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/PackageWriterImpl.java

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -252,14 +252,14 @@ public void addAllClassesAndInterfacesSummary(Content summaryContentTree) {
252252
.setHeader(new TableHeader(contents.classLabel, contents.descriptionLabel))
253253
.setColumnStyles(HtmlStyle.colFirst, HtmlStyle.colLast)
254254
.setId(HtmlIds.CLASS_SUMMARY)
255-
.setDefaultTab(contents.allClassesAndInterfacesLabel.toString())
256-
.addTab(contents.interfaces.toString(), utils::isInterface)
257-
.addTab(contents.classes.toString(), e -> utils.isOrdinaryClass((TypeElement)e))
258-
.addTab(contents.enums.toString(), utils::isEnum)
259-
.addTab(contents.records.toString(), e -> utils.isRecord((TypeElement)e))
260-
.addTab(contents.exceptions.toString(), e -> utils.isException((TypeElement)e))
261-
.addTab(contents.errors.toString(), e -> utils.isError((TypeElement)e))
262-
.addTab(contents.annotationTypes.toString(), utils::isAnnotationType);
255+
.setDefaultTab(contents.allClassesAndInterfacesLabel)
256+
.addTab(contents.interfaces, utils::isInterface)
257+
.addTab(contents.classes, e -> utils.isOrdinaryClass((TypeElement)e))
258+
.addTab(contents.enums, utils::isEnum)
259+
.addTab(contents.records, e -> utils.isRecord((TypeElement)e))
260+
.addTab(contents.exceptions, e -> utils.isException((TypeElement)e))
261+
.addTab(contents.errors, e -> utils.isError((TypeElement)e))
262+
.addTab(contents.annotationTypes, utils::isAnnotationType);
263263
for (TypeElement typeElement : allClasses) {
264264
if (typeElement != null && utils.isCoreClass(typeElement)) {
265265
Content classLink = getLink(new HtmlLinkInfo(

‎src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/Table.java

Lines changed: 21 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,6 @@
4343
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlId;
4444
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;
4545
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
46-
import jdk.javadoc.internal.doclets.formats.html.markup.Text;
4746
import jdk.javadoc.internal.doclets.formats.html.markup.TagName;
4847
import jdk.javadoc.internal.doclets.toolkit.Content;
4948

@@ -77,9 +76,9 @@
7776
public class Table extends Content {
7877
private final HtmlStyle tableStyle;
7978
private Content caption;
80-
private Map<String, Predicate<Element>> tabMap;
81-
private String defaultTab;
82-
private Set<String> tabs;
79+
private Map<Content, Predicate<Element>> tabMap;
80+
private Content defaultTab;
81+
private Set<Content> tabs;
8382
private HtmlStyle tabListStyle = HtmlStyle.tableTabs;
8483
private HtmlStyle activeTabStyle = HtmlStyle.activeTableTab;
8584
private HtmlStyle tabStyle = HtmlStyle.tableTab;
@@ -118,28 +117,28 @@ public Table setCaption(Content captionContent) {
118117
* predicate for the tab, and an element associated with each row.
119118
* Tabs will appear left-to-right in the order they are added.
120119
*
121-
* @param name the name of the tab
120+
* @param label the tab label
122121
* @param predicate the predicate
123122
* @return this object
124123
*/
125-
public Table addTab(String name, Predicate<Element> predicate) {
124+
public Table addTab(Content label, Predicate<Element> predicate) {
126125
if (tabMap == null) {
127126
tabMap = new LinkedHashMap<>(); // preserves order that tabs are added
128127
tabs = new HashSet<>(); // order not significant
129128
}
130-
tabMap.put(name, predicate);
129+
tabMap.put(label, predicate);
131130
return this;
132131
}
133132

134133
/**
135-
* Sets the name for the default tab, which displays all the rows in the table.
134+
* Sets the label for the default tab, which displays all the rows in the table.
136135
* This tab will appear first in the left-to-right list of displayed tabs.
137136
*
138-
* @param name the name
137+
* @param label the default tab label
139138
* @return this object
140139
*/
141-
public Table setDefaultTab(String name) {
142-
defaultTab = name;
140+
public Table setDefaultTab(Content label) {
141+
defaultTab = label;
143142
return this;
144143
}
145144

@@ -266,7 +265,7 @@ public void addRow(List<Content> contents) {
266265
* If tabs have been added to the table, the specified element will be used
267266
* to determine whether the row should be displayed when any particular tab
268267
* is selected, using the predicate specified when the tab was
269-
* {@link #addTab(String,Predicate) added}.
268+
* {@link #addTab(Content, Predicate) added}.
270269
*
271270
* @param element the element
272271
* @param contents the contents for the row
@@ -285,7 +284,7 @@ public void addRow(Element element, Content... contents) {
285284
* If tabs have been added to the table, the specified element will be used
286285
* to determine whether the row should be displayed when any particular tab
287286
* is selected, using the predicate specified when the tab was
288-
* {@link #addTab(String,Predicate) added}.
287+
* {@link #addTab(Content, Predicate) added}.
289288
*
290289
* @param element the element
291290
* @param contents the contents for the row
@@ -312,11 +311,11 @@ public void addRow(Element element, List<Content> contents) {
312311
// The values are used to determine the cells to make visible when a tab is selected.
313312
tabClasses.add(id.name());
314313
int tabIndex = 1;
315-
for (Map.Entry<String, Predicate<Element>> e : tabMap.entrySet()) {
316-
String name = e.getKey();
314+
for (Map.Entry<Content, Predicate<Element>> e : tabMap.entrySet()) {
315+
Content label = e.getKey();
317316
Predicate<Element> predicate = e.getValue();
318317
if (predicate.test(element)) {
319-
tabs.add(name);
318+
tabs.add(label);
320319
tabClasses.add(HtmlIds.forTab(id, tabIndex).name());
321320
}
322321
tabIndex++;
@@ -380,8 +379,7 @@ private Content toContent() {
380379
if (tabMap == null) {
381380
main.add(caption);
382381
} else {
383-
String tabName = tabs.iterator().next();
384-
main.add(getCaption(Text.of(tabName)));
382+
main.add(getCaption(tabs.iterator().next()));
385383
}
386384
table.add(getTableBody());
387385
main.add(table);
@@ -393,10 +391,10 @@ private Content toContent() {
393391
int tabIndex = 0;
394392
tablist.add(createTab(HtmlIds.forTab(id, tabIndex), activeTabStyle, true, defaultTab));
395393
table.put(HtmlAttr.ARIA_LABELLEDBY, HtmlIds.forTab(id, tabIndex).name());
396-
for (String tabName : tabMap.keySet()) {
394+
for (Content tabLabel : tabMap.keySet()) {
397395
tabIndex++;
398-
if (tabs.contains(tabName)) {
399-
HtmlTree tab = createTab(HtmlIds.forTab(id, tabIndex), tabStyle, false, tabName);
396+
if (tabs.contains(tabLabel)) {
397+
HtmlTree tab = createTab(HtmlIds.forTab(id, tabIndex), tabStyle, false, tabLabel);
400398
tablist.add(tab);
401399
}
402400
}
@@ -414,7 +412,7 @@ private Content toContent() {
414412
return main;
415413
}
416414

417-
private HtmlTree createTab(HtmlId tabId, HtmlStyle style, boolean defaultTab, String tabName) {
415+
private HtmlTree createTab(HtmlId tabId, HtmlStyle style, boolean defaultTab, Content tabLabel) {
418416
HtmlTree tab = new HtmlTree(TagName.BUTTON)
419417
.setId(tabId)
420418
.put(HtmlAttr.ROLE, "tab")
@@ -425,7 +423,7 @@ private HtmlTree createTab(HtmlId tabId, HtmlStyle style, boolean defaultTab, St
425423
.put(HtmlAttr.ONCLICK, "show('" + id.name() + "', '" + (defaultTab ? id : tabId).name()
426424
+ "', " + columnStyles.size() + ")")
427425
.setStyle(style);
428-
tab.add(tabName);
426+
tab.add(tabLabel);
429427
return tab;
430428
}
431429

‎src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/TagletWriterImpl.java

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,6 @@
6767
import jdk.javadoc.internal.doclets.toolkit.util.DocLink;
6868
import jdk.javadoc.internal.doclets.toolkit.util.DocPath;
6969
import jdk.javadoc.internal.doclets.toolkit.util.DocPaths;
70-
import jdk.javadoc.internal.doclets.toolkit.util.DocletConstants;
7170
import jdk.javadoc.internal.doclets.toolkit.util.IndexItem;
7271
import jdk.javadoc.internal.doclets.toolkit.util.Utils;
7372

@@ -329,7 +328,7 @@ public Content seeTagOutput(Element holder, List<? extends SeeTree> seeTags) {
329328
utils.getSimpleName(holder);
330329
DocLink link = constantsPath.fragment(whichConstant);
331330
links.add(htmlWriter.links.createLink(link,
332-
Text.of(resources.getText("doclet.Constants_Summary"))));
331+
contents.getContent("doclet.Constants_Summary")));
333332
}
334333
if (utils.isClass(holder) && utils.isSerializable((TypeElement)holder)) {
335334
//Automatically add link to serialized form page for serializable classes.
@@ -338,7 +337,7 @@ public Content seeTagOutput(Element holder, List<? extends SeeTree> seeTags) {
338337
DocPath serialPath = htmlWriter.pathToRoot.resolve(DocPaths.SERIALIZED_FORM);
339338
DocLink link = serialPath.fragment(utils.getFullyQualifiedName(holder));
340339
links.add(htmlWriter.links.createLink(link,
341-
Text.of(resources.getText("doclet.Serialized_Form"))));
340+
contents.getContent("doclet.Serialized_Form")));
342341
}
343342
}
344343
if (links.isEmpty()) {

0 commit comments

Comments
 (0)