Skip to content

Commit 3132b1c

Browse files
jonathan-gibbonsjonathan-gibbons
committed
8261665: Clean up naming of StringContent and FixedStringContent
Reviewed-by: hannesw
1 parent c30a90b commit 3132b1c

39 files changed

+216
-222
lines changed

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

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 2018, 2020, Oracle and/or its affiliates. All rights reserved.
2+
* Copyright (c) 2018, 2021, Oracle and/or its affiliates. All rights reserved.
33
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
44
*
55
* This code is free software; you can redistribute it and/or modify it
@@ -22,6 +22,7 @@
2222
* or visit www.oracle.com if you need additional information or have any
2323
* questions.
2424
*/
25+
2526
package jdk.javadoc.internal.doclets.formats.html;
2627

2728
import javax.lang.model.element.PackageElement;
@@ -31,7 +32,7 @@
3132
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;
3233
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
3334
import jdk.javadoc.internal.doclets.formats.html.Navigation.PageMode;
34-
import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
35+
import jdk.javadoc.internal.doclets.formats.html.markup.Text;
3536
import jdk.javadoc.internal.doclets.toolkit.Content;
3637
import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
3738
import jdk.javadoc.internal.doclets.toolkit.util.DocPath;
@@ -94,7 +95,7 @@ protected void buildAllPackagesFile() throws DocFileIOException {
9495
*/
9596
protected void addPackages(Content content) {
9697
Table table = new Table(HtmlStyle.summaryTable)
97-
.setCaption(new StringContent(contents.packageSummary))
98+
.setCaption(Text.of(contents.packageSummary))
9899
.setHeader(new TableHeader(contents.packageLabel, contents.descriptionLabel))
99100
.setColumnStyles(HtmlStyle.colFirst, HtmlStyle.colLast);
100101
for (PackageElement pkg : configuration.packages) {

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 2003, 2020, Oracle and/or its affiliates. All rights reserved.
2+
* Copyright (c) 2003, 2021, Oracle and/or its affiliates. All rights reserved.
33
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
44
*
55
* This code is free software; you can redistribute it and/or modify it
@@ -33,7 +33,7 @@
3333
import jdk.javadoc.internal.doclets.formats.html.markup.ContentBuilder;
3434
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;
3535
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
36-
import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
36+
import jdk.javadoc.internal.doclets.formats.html.markup.Text;
3737
import jdk.javadoc.internal.doclets.toolkit.AnnotationTypeOptionalMemberWriter;
3838
import jdk.javadoc.internal.doclets.toolkit.Content;
3939
import jdk.javadoc.internal.doclets.toolkit.MemberSummaryWriter;
@@ -87,7 +87,7 @@ public void addDefaultValueInfo(Element member, Content annotationDocTree) {
8787
if (value != null) {
8888
Content dl = HtmlTree.DL(HtmlStyle.notes);
8989
dl.add(HtmlTree.DT(contents.default_));
90-
dl.add(HtmlTree.DD(new StringContent(value.toString())));
90+
dl.add(HtmlTree.DD(Text.of(value.toString())));
9191
annotationDocTree.add(dl);
9292
}
9393
}

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

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
import jdk.javadoc.internal.doclets.formats.html.markup.ContentBuilder;
3636
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;
3737
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
38-
import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
38+
import jdk.javadoc.internal.doclets.formats.html.markup.Text;
3939
import jdk.javadoc.internal.doclets.toolkit.AnnotationTypeRequiredMemberWriter;
4040
import jdk.javadoc.internal.doclets.toolkit.Content;
4141
import jdk.javadoc.internal.doclets.toolkit.MemberSummaryWriter;
@@ -106,10 +106,9 @@ public Content getAnnotationDetailsTreeHeader() {
106106

107107
@Override
108108
public Content getAnnotationDocTreeHeader(Element member) {
109-
String simpleName = name(member);
110109
Content annotationDocTree = new ContentBuilder();
111110
Content heading = HtmlTree.HEADING(Headings.TypeDeclaration.MEMBER_HEADING,
112-
new StringContent(simpleName));
111+
Text.of(name(member)));
113112
annotationDocTree.add(heading);
114113
return HtmlTree.SECTION(HtmlStyle.detail, annotationDocTree)
115114
.setId(htmlIds.forMember(typeElement, (ExecutableElement) member));

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@
4444
import jdk.javadoc.internal.doclets.formats.html.markup.TagName;
4545
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
4646
import jdk.javadoc.internal.doclets.formats.html.Navigation.PageMode;
47+
import jdk.javadoc.internal.doclets.formats.html.markup.Text;
4748
import jdk.javadoc.internal.doclets.toolkit.Content;
4849
import jdk.javadoc.internal.doclets.toolkit.util.ClassTree;
4950
import jdk.javadoc.internal.doclets.toolkit.util.ClassUseMapper;

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

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,6 @@
3030
import java.util.Set;
3131
import java.util.SortedSet;
3232
import java.util.TreeSet;
33-
3433
import javax.lang.model.element.AnnotationMirror;
3534
import javax.lang.model.element.Element;
3635
import javax.lang.model.element.ModuleElement;
@@ -41,14 +40,14 @@
4140

4241
import com.sun.source.doctree.DeprecatedTree;
4342
import com.sun.source.doctree.DocTree;
43+
import jdk.javadoc.internal.doclets.formats.html.Navigation.PageMode;
4444
import jdk.javadoc.internal.doclets.formats.html.markup.ContentBuilder;
4545
import jdk.javadoc.internal.doclets.formats.html.markup.Entity;
4646
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlAttr;
4747
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;
48-
import jdk.javadoc.internal.doclets.formats.html.markup.TagName;
4948
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
50-
import jdk.javadoc.internal.doclets.formats.html.Navigation.PageMode;
51-
import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
49+
import jdk.javadoc.internal.doclets.formats.html.markup.TagName;
50+
import jdk.javadoc.internal.doclets.formats.html.markup.Text;
5251
import jdk.javadoc.internal.doclets.toolkit.ClassWriter;
5352
import jdk.javadoc.internal.doclets.toolkit.Content;
5453
import jdk.javadoc.internal.doclets.toolkit.taglets.ParamTaglet;
@@ -114,7 +113,7 @@ public Content getHeader(String header) {
114113
Content moduleNameDiv = HtmlTree.DIV(HtmlStyle.subTitle, classModuleLabel);
115114
moduleNameDiv.add(Entity.NO_BREAK_SPACE);
116115
moduleNameDiv.add(getModuleLink(mdle,
117-
new StringContent(mdle.getQualifiedName())));
116+
Text.of(mdle.getQualifiedName())));
118117
div.add(moduleNameDiv);
119118
}
120119
PackageElement pkg = utils.containingPackage(typeElement);
@@ -131,7 +130,7 @@ public Content getHeader(String header) {
131130
//Let's not link to ourselves in the header.
132131
linkInfo.linkToSelf = false;
133132
Content heading = HtmlTree.HEADING_TITLE(Headings.PAGE_TITLE_HEADING,
134-
HtmlStyle.title, new StringContent(header));
133+
HtmlStyle.title, Text.of(header));
135134
heading.add(getTypeParameterLinks(linkInfo));
136135
div.add(heading);
137136
bodyContents.setHeader(getHeader(PageMode.CLASS, typeElement))
@@ -454,8 +453,7 @@ private Content getClassLinks(HtmlLinkInfo.Kind context, Collection<?> list) {
454453
boolean isFirst = true;
455454
for (Object type : list) {
456455
if (!isFirst) {
457-
Content separator = new StringContent(", ");
458-
content.add(separator);
456+
content.add(Text.of(", "));
459457
} else {
460458
isFirst = false;
461459
}

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

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
import jdk.javadoc.internal.doclets.formats.html.markup.TagName;
4242
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
4343
import jdk.javadoc.internal.doclets.formats.html.Navigation.PageMode;
44-
import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
44+
import jdk.javadoc.internal.doclets.formats.html.markup.Text;
4545
import jdk.javadoc.internal.doclets.toolkit.ConstantsSummaryWriter;
4646
import jdk.javadoc.internal.doclets.toolkit.Content;
4747
import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
@@ -111,8 +111,7 @@ public void addLinkToPackageContent(PackageElement pkg,
111111
contents.defaultPackageLabel, "");
112112
} else {
113113
String parsedPackageName = utils.parsePackageName(pkg);
114-
Content packageNameContent = getPackageLabel(parsedPackageName);
115-
packageNameContent.add(".*");
114+
Content packageNameContent = Text.of(parsedPackageName + ".*");
116115
link = links.createLink(DocLink.fragment(parsedPackageName),
117116
packageNameContent, "");
118117
PackageElement abbrevPkg = configuration.workArounds.getAbbreviatedPackageElement(pkg);
@@ -156,7 +155,7 @@ public void addPackageName(PackageElement pkg, Content summariesTree, boolean fi
156155
anchorName = htmlIds.forPackage(pkg);
157156
pkgNameContent = getPackageLabel(parsedPackageName);
158157
}
159-
Content headingContent = new StringContent(".*");
158+
Content headingContent = Text.of(".*");
160159
Content heading = HtmlTree.HEADING_TITLE(Headings.ConstantsSummary.PACKAGE_HEADING,
161160
pkgNameContent);
162161
heading.add(headingContent);
@@ -186,7 +185,7 @@ public void addConstantMembers(TypeElement typeElement, Collection<VariableEleme
186185
Content classlink = (utils.isPublic(typeElement) || utils.isProtected(typeElement)) ?
187186
getLink(new HtmlLinkInfo(configuration,
188187
HtmlLinkInfo.Kind.CONSTANT_SUMMARY, typeElement)) :
189-
new StringContent(utils.getFullyQualifiedName(typeElement));
188+
Text.of(utils.getFullyQualifiedName(typeElement));
190189

191190
PackageElement enclosingPackage = utils.containingPackage(typeElement);
192191
Content caption = new ContentBuilder();
@@ -218,9 +217,8 @@ private Content getTypeColumn(VariableElement member) {
218217
Content code = new HtmlTree(TagName.CODE)
219218
.setId(htmlIds.forMember(currentTypeElement, member));
220219
for (Modifier mod : member.getModifiers()) {
221-
Content modifier = new StringContent(mod.toString());
222-
code.add(modifier);
223-
code.add(Entity.NO_BREAK_SPACE);
220+
code.add(Text.of(mod.toString()))
221+
.add(Entity.NO_BREAK_SPACE);
224222
}
225223
Content type = getLink(new HtmlLinkInfo(configuration,
226224
HtmlLinkInfo.Kind.CONSTANT_SUMMARY, member.asType()));
@@ -249,8 +247,7 @@ private Content getNameColumn(VariableElement member) {
249247
*/
250248
private Content getValue(VariableElement member) {
251249
String value = utils.constantValueExpression(member);
252-
Content valueContent = new StringContent(value);
253-
return HtmlTree.CODE(valueContent);
250+
return HtmlTree.CODE(Text.of(value));
254251
}
255252

256253
@Override

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;
3939
import jdk.javadoc.internal.doclets.formats.html.markup.TagName;
4040
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
41-
import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
41+
import jdk.javadoc.internal.doclets.formats.html.markup.Text;
4242
import jdk.javadoc.internal.doclets.toolkit.ConstructorWriter;
4343
import jdk.javadoc.internal.doclets.toolkit.Content;
4444
import jdk.javadoc.internal.doclets.toolkit.MemberSummaryWriter;
@@ -117,7 +117,7 @@ public Content getConstructorDetailsTreeHeader(Content memberDetailsTree) {
117117
public Content getConstructorDocTreeHeader(ExecutableElement constructor) {
118118
Content constructorDocTree = new ContentBuilder();
119119
HtmlTree heading = HtmlTree.HEADING(Headings.TypeDeclaration.MEMBER_HEADING,
120-
new StringContent(name(constructor)));
120+
Text.of(name(constructor)));
121121
HtmlId erasureAnchor = htmlIds.forErasure(constructor);
122122
if (erasureAnchor != null) {
123123
heading.setId(erasureAnchor);

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

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,9 @@
3131
import java.util.regex.Matcher;
3232
import java.util.regex.Pattern;
3333

34-
import jdk.javadoc.internal.doclets.formats.html.markup.Comment;
3534
import jdk.javadoc.internal.doclets.formats.html.markup.ContentBuilder;
3635
import jdk.javadoc.internal.doclets.formats.html.markup.Entity;
37-
import jdk.javadoc.internal.doclets.formats.html.markup.FixedStringContent;
38-
import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
36+
import jdk.javadoc.internal.doclets.formats.html.markup.Text;
3937
import jdk.javadoc.internal.doclets.toolkit.Content;
4038
import jdk.javadoc.internal.doclets.toolkit.Resources;
4139
import jdk.javadoc.internal.doclets.toolkit.util.DocletConstants;
@@ -349,7 +347,7 @@ record = getContent("doclet.RecordClass");
349347
* @return a content tree for the string
350348
*/
351349
public Content getContent(String key) {
352-
return new FixedStringContent(resources.getText(key));
350+
return Text.of(resources.getText(key));
353351
}
354352

355353
/**

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
import jdk.javadoc.internal.doclets.formats.html.markup.ContentBuilder;
3434
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;
3535
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
36-
import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
36+
import jdk.javadoc.internal.doclets.formats.html.markup.Text;
3737
import jdk.javadoc.internal.doclets.toolkit.Content;
3838
import jdk.javadoc.internal.doclets.toolkit.EnumConstantWriter;
3939
import jdk.javadoc.internal.doclets.toolkit.MemberSummaryWriter;
@@ -88,7 +88,7 @@ public Content getEnumConstantsTreeHeader(VariableElement enumConstant,
8888
Content enumConstantsDetailsTree) {
8989
Content enumConstantsTree = new ContentBuilder();
9090
HtmlTree heading = HtmlTree.HEADING(Headings.TypeDeclaration.MEMBER_HEADING,
91-
new StringContent(name(enumConstant)));
91+
Text.of(name(enumConstant)));
9292
enumConstantsTree.add(heading);
9393
return HtmlTree.SECTION(HtmlStyle.detail, enumConstantsTree)
9494
.setId(htmlIds.forMember(enumConstant));

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
import jdk.javadoc.internal.doclets.formats.html.markup.Entity;
3737
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;
3838
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
39-
import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
39+
import jdk.javadoc.internal.doclets.formats.html.markup.Text;
4040
import jdk.javadoc.internal.doclets.toolkit.Content;
4141
import jdk.javadoc.internal.doclets.toolkit.FieldWriter;
4242
import jdk.javadoc.internal.doclets.toolkit.MemberSummaryWriter;
@@ -89,7 +89,7 @@ public Content getFieldDetailsTreeHeader(Content memberDetailsTree) {
8989
public Content getFieldDocTreeHeader(VariableElement field) {
9090
Content fieldTree = new ContentBuilder();
9191
Content heading = HtmlTree.HEADING(Headings.TypeDeclaration.MEMBER_HEADING,
92-
new StringContent(name(field)));
92+
Text.of(name(field)));
9393
fieldTree.add(heading);
9494
return HtmlTree.SECTION(HtmlStyle.detail, fieldTree)
9595
.setId(htmlIds.forMember(field));
@@ -164,11 +164,11 @@ public void addInheritedSummaryLabel(TypeElement typeElement, Content inheritedT
164164
HtmlLinkInfo.Kind.MEMBER, typeElement);
165165
Content label;
166166
if (options.summarizeOverriddenMethods()) {
167-
label = new StringContent(utils.isClass(typeElement)
167+
label = Text.of(utils.isClass(typeElement)
168168
? resources.getText("doclet.Fields_Declared_In_Class")
169169
: resources.getText("doclet.Fields_Declared_In_Interface"));
170170
} else {
171-
label = new StringContent(utils.isClass(typeElement)
171+
label = Text.of(utils.isClass(typeElement)
172172
? resources.getText("doclet.Fields_Inherited_From_Class")
173173
: resources.getText("doclet.Fields_Inherited_From_Interface"));
174174
}

0 commit comments

Comments
 (0)