stan/jdk-24
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

8261665: Clean up naming of StringContent and FixedStringContent

Browse Source 
Reviewed-by: hannesw
This commit is contained in:
Jonathan Gibbons 2021-02-23 19:29:41 +00:00
parent c30a90bb64
commit 3132b1c4b1
39 changed files with 216 additions and 222 deletions

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

@ -1,5 +1,5 @@
/*
* Copyright (c) 2018, 2020, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2018, 2021, Oracle and/or its affiliates. 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
@ -22,6 +22,7 @@
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package jdk.javadoc.internal.doclets.formats.html;
import javax.lang.model.element.PackageElement;
@ -31,7 +32,7 @@ import jdk.javadoc.internal.doclets.formats.html.markup.ContentBuilder;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
import jdk.javadoc.internal.doclets.formats.html.Navigation.PageMode;
import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
import jdk.javadoc.internal.doclets.formats.html.markup.Text;
import jdk.javadoc.internal.doclets.toolkit.Content;
import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
import jdk.javadoc.internal.doclets.toolkit.util.DocPath;
@ -94,7 +95,7 @@ public class AllPackagesIndexWriter extends HtmlDocletWriter {
*/
protected void addPackages(Content content) {
Table table = new Table(HtmlStyle.summaryTable)
.setCaption(new StringContent(contents.packageSummary))
.setCaption(Text.of(contents.packageSummary))
.setHeader(new TableHeader(contents.packageLabel, contents.descriptionLabel))
.setColumnStyles(HtmlStyle.colFirst, HtmlStyle.colLast);
for (PackageElement pkg : configuration.packages) {

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

@ -1,5 +1,5 @@
/*
* Copyright (c) 2003, 2020, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2003, 2021, Oracle and/or its affiliates. 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
@ -33,7 +33,7 @@ import javax.lang.model.element.TypeElement;
import jdk.javadoc.internal.doclets.formats.html.markup.ContentBuilder;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
import jdk.javadoc.internal.doclets.formats.html.markup.Text;
import jdk.javadoc.internal.doclets.toolkit.AnnotationTypeOptionalMemberWriter;
import jdk.javadoc.internal.doclets.toolkit.Content;
import jdk.javadoc.internal.doclets.toolkit.MemberSummaryWriter;
@ -87,7 +87,7 @@ public class AnnotationTypeOptionalMemberWriterImpl extends
if (value != null) {
Content dl = HtmlTree.DL(HtmlStyle.notes);
dl.add(HtmlTree.DT(contents.default_));
dl.add(HtmlTree.DD(new StringContent(value.toString())));
dl.add(HtmlTree.DD(Text.of(value.toString())));
annotationDocTree.add(dl);
}
}

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

@ -35,7 +35,7 @@ import jdk.javadoc.internal.doclets.formats.html.markup.Comment;
import jdk.javadoc.internal.doclets.formats.html.markup.ContentBuilder;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
import jdk.javadoc.internal.doclets.formats.html.markup.Text;
import jdk.javadoc.internal.doclets.toolkit.AnnotationTypeRequiredMemberWriter;
import jdk.javadoc.internal.doclets.toolkit.Content;
import jdk.javadoc.internal.doclets.toolkit.MemberSummaryWriter;
@ -106,10 +106,9 @@ public class AnnotationTypeRequiredMemberWriterImpl extends AbstractMemberWriter
@Override
public Content getAnnotationDocTreeHeader(Element member) {
String simpleName = name(member);
Content annotationDocTree = new ContentBuilder();
Content heading = HtmlTree.HEADING(Headings.TypeDeclaration.MEMBER_HEADING,
new StringContent(simpleName));
Text.of(name(member)));
annotationDocTree.add(heading);
return HtmlTree.SECTION(HtmlStyle.detail, annotationDocTree)
.setId(htmlIds.forMember(typeElement, (ExecutableElement) member));

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

@ -44,6 +44,7 @@ import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;
import jdk.javadoc.internal.doclets.formats.html.markup.TagName;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
import jdk.javadoc.internal.doclets.formats.html.Navigation.PageMode;
import jdk.javadoc.internal.doclets.formats.html.markup.Text;
import jdk.javadoc.internal.doclets.toolkit.Content;
import jdk.javadoc.internal.doclets.toolkit.util.ClassTree;
import jdk.javadoc.internal.doclets.toolkit.util.ClassUseMapper;

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

@ -30,7 +30,6 @@ import java.util.List;
import java.util.Set;
import java.util.SortedSet;
import java.util.TreeSet;
import javax.lang.model.element.AnnotationMirror;
import javax.lang.model.element.Element;
import javax.lang.model.element.ModuleElement;
@ -41,14 +40,14 @@ import javax.lang.model.util.SimpleElementVisitor8;
import com.sun.source.doctree.DeprecatedTree;
import com.sun.source.doctree.DocTree;
import jdk.javadoc.internal.doclets.formats.html.Navigation.PageMode;
import jdk.javadoc.internal.doclets.formats.html.markup.ContentBuilder;
import jdk.javadoc.internal.doclets.formats.html.markup.Entity;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlAttr;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;
import jdk.javadoc.internal.doclets.formats.html.markup.TagName;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
import jdk.javadoc.internal.doclets.formats.html.Navigation.PageMode;
import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
import jdk.javadoc.internal.doclets.formats.html.markup.TagName;
import jdk.javadoc.internal.doclets.formats.html.markup.Text;
import jdk.javadoc.internal.doclets.toolkit.ClassWriter;
import jdk.javadoc.internal.doclets.toolkit.Content;
import jdk.javadoc.internal.doclets.toolkit.taglets.ParamTaglet;
@ -114,7 +113,7 @@ public class ClassWriterImpl extends SubWriterHolderWriter implements ClassWrite
Content moduleNameDiv = HtmlTree.DIV(HtmlStyle.subTitle, classModuleLabel);
moduleNameDiv.add(Entity.NO_BREAK_SPACE);
moduleNameDiv.add(getModuleLink(mdle,
new StringContent(mdle.getQualifiedName())));
Text.of(mdle.getQualifiedName())));
div.add(moduleNameDiv);
}
PackageElement pkg = utils.containingPackage(typeElement);
@ -131,7 +130,7 @@ public class ClassWriterImpl extends SubWriterHolderWriter implements ClassWrite
//Let's not link to ourselves in the header.
linkInfo.linkToSelf = false;
Content heading = HtmlTree.HEADING_TITLE(Headings.PAGE_TITLE_HEADING,
HtmlStyle.title, new StringContent(header));
HtmlStyle.title, Text.of(header));
heading.add(getTypeParameterLinks(linkInfo));
div.add(heading);
bodyContents.setHeader(getHeader(PageMode.CLASS, typeElement))
@ -454,8 +453,7 @@ public class ClassWriterImpl extends SubWriterHolderWriter implements ClassWrite
boolean isFirst = true;
for (Object type : list) {
if (!isFirst) {
Content separator = new StringContent(", ");
content.add(separator);
content.add(Text.of(", "));
} else {
isFirst = false;
}

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

@ -41,7 +41,7 @@ import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;
import jdk.javadoc.internal.doclets.formats.html.markup.TagName;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
import jdk.javadoc.internal.doclets.formats.html.Navigation.PageMode;
import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
import jdk.javadoc.internal.doclets.formats.html.markup.Text;
import jdk.javadoc.internal.doclets.toolkit.ConstantsSummaryWriter;
import jdk.javadoc.internal.doclets.toolkit.Content;
import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
@ -111,8 +111,7 @@ public class ConstantsSummaryWriterImpl extends HtmlDocletWriter implements Cons
contents.defaultPackageLabel, "");
} else {
String parsedPackageName = utils.parsePackageName(pkg);
Content packageNameContent = getPackageLabel(parsedPackageName);
packageNameContent.add(".*");
Content packageNameContent = Text.of(parsedPackageName + ".*");
link = links.createLink(DocLink.fragment(parsedPackageName),
packageNameContent, "");
PackageElement abbrevPkg = configuration.workArounds.getAbbreviatedPackageElement(pkg);
@ -156,7 +155,7 @@ public class ConstantsSummaryWriterImpl extends HtmlDocletWriter implements Cons
anchorName = htmlIds.forPackage(pkg);
pkgNameContent = getPackageLabel(parsedPackageName);
}
Content headingContent = new StringContent(".*");
Content headingContent = Text.of(".*");
Content heading = HtmlTree.HEADING_TITLE(Headings.ConstantsSummary.PACKAGE_HEADING,
pkgNameContent);
heading.add(headingContent);
@ -186,7 +185,7 @@ public class ConstantsSummaryWriterImpl extends HtmlDocletWriter implements Cons
Content classlink = (utils.isPublic(typeElement) || utils.isProtected(typeElement)) ?
getLink(new HtmlLinkInfo(configuration,
HtmlLinkInfo.Kind.CONSTANT_SUMMARY, typeElement)) :
new StringContent(utils.getFullyQualifiedName(typeElement));
Text.of(utils.getFullyQualifiedName(typeElement));
PackageElement enclosingPackage = utils.containingPackage(typeElement);
Content caption = new ContentBuilder();
@ -218,9 +217,8 @@ public class ConstantsSummaryWriterImpl extends HtmlDocletWriter implements Cons
Content code = new HtmlTree(TagName.CODE)
.setId(htmlIds.forMember(currentTypeElement, member));
for (Modifier mod : member.getModifiers()) {
Content modifier = new StringContent(mod.toString());
code.add(modifier);
code.add(Entity.NO_BREAK_SPACE);
code.add(Text.of(mod.toString()))
.add(Entity.NO_BREAK_SPACE);
}
Content type = getLink(new HtmlLinkInfo(configuration,
HtmlLinkInfo.Kind.CONSTANT_SUMMARY, member.asType()));
@ -249,8 +247,7 @@ public class ConstantsSummaryWriterImpl extends HtmlDocletWriter implements Cons
*/
private Content getValue(VariableElement member) {
String value = utils.constantValueExpression(member);
Content valueContent = new StringContent(value);
return HtmlTree.CODE(valueContent);
return HtmlTree.CODE(Text.of(value));
}
@Override

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

@ -38,7 +38,7 @@ import jdk.javadoc.internal.doclets.formats.html.markup.HtmlId;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;
import jdk.javadoc.internal.doclets.formats.html.markup.TagName;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
import jdk.javadoc.internal.doclets.formats.html.markup.Text;
import jdk.javadoc.internal.doclets.toolkit.ConstructorWriter;
import jdk.javadoc.internal.doclets.toolkit.Content;
import jdk.javadoc.internal.doclets.toolkit.MemberSummaryWriter;
@ -117,7 +117,7 @@ public class ConstructorWriterImpl extends AbstractExecutableMemberWriter
public Content getConstructorDocTreeHeader(ExecutableElement constructor) {
Content constructorDocTree = new ContentBuilder();
HtmlTree heading = HtmlTree.HEADING(Headings.TypeDeclaration.MEMBER_HEADING,
new StringContent(name(constructor)));
Text.of(name(constructor)));
HtmlId erasureAnchor = htmlIds.forErasure(constructor);
if (erasureAnchor != null) {
heading.setId(erasureAnchor);

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

@ -31,11 +31,9 @@ import java.util.Objects;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import jdk.javadoc.internal.doclets.formats.html.markup.Comment;
import jdk.javadoc.internal.doclets.formats.html.markup.ContentBuilder;
import jdk.javadoc.internal.doclets.formats.html.markup.Entity;
import jdk.javadoc.internal.doclets.formats.html.markup.FixedStringContent;
import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
import jdk.javadoc.internal.doclets.formats.html.markup.Text;
import jdk.javadoc.internal.doclets.toolkit.Content;
import jdk.javadoc.internal.doclets.toolkit.Resources;
import jdk.javadoc.internal.doclets.toolkit.util.DocletConstants;
@ -349,7 +347,7 @@ public class Contents {
* @return a content tree for the string
*/
public Content getContent(String key) {
return new FixedStringContent(resources.getText(key));
return Text.of(resources.getText(key));
}
/**

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

@ -33,7 +33,7 @@ import javax.lang.model.element.VariableElement;
import jdk.javadoc.internal.doclets.formats.html.markup.ContentBuilder;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
import jdk.javadoc.internal.doclets.formats.html.markup.Text;
import jdk.javadoc.internal.doclets.toolkit.Content;
import jdk.javadoc.internal.doclets.toolkit.EnumConstantWriter;
import jdk.javadoc.internal.doclets.toolkit.MemberSummaryWriter;
@ -88,7 +88,7 @@ public class EnumConstantWriterImpl extends AbstractMemberWriter
Content enumConstantsDetailsTree) {
Content enumConstantsTree = new ContentBuilder();
HtmlTree heading = HtmlTree.HEADING(Headings.TypeDeclaration.MEMBER_HEADING,
new StringContent(name(enumConstant)));
Text.of(name(enumConstant)));
enumConstantsTree.add(heading);
return HtmlTree.SECTION(HtmlStyle.detail, enumConstantsTree)
.setId(htmlIds.forMember(enumConstant));

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

@ -36,7 +36,7 @@ import jdk.javadoc.internal.doclets.formats.html.markup.ContentBuilder;
import jdk.javadoc.internal.doclets.formats.html.markup.Entity;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
import jdk.javadoc.internal.doclets.formats.html.markup.Text;
import jdk.javadoc.internal.doclets.toolkit.Content;
import jdk.javadoc.internal.doclets.toolkit.FieldWriter;
import jdk.javadoc.internal.doclets.toolkit.MemberSummaryWriter;
@ -89,7 +89,7 @@ public class FieldWriterImpl extends AbstractMemberWriter
public Content getFieldDocTreeHeader(VariableElement field) {
Content fieldTree = new ContentBuilder();
Content heading = HtmlTree.HEADING(Headings.TypeDeclaration.MEMBER_HEADING,
new StringContent(name(field)));
Text.of(name(field)));
fieldTree.add(heading);
return HtmlTree.SECTION(HtmlStyle.detail, fieldTree)
.setId(htmlIds.forMember(field));
@ -164,11 +164,11 @@ public class FieldWriterImpl extends AbstractMemberWriter
HtmlLinkInfo.Kind.MEMBER, typeElement);
Content label;
if (options.summarizeOverriddenMethods()) {
label = new StringContent(utils.isClass(typeElement)
label = Text.of(utils.isClass(typeElement)
? resources.getText("doclet.Fields_Declared_In_Class")
: resources.getText("doclet.Fields_Declared_In_Interface"));
} else {
label = new StringContent(utils.isClass(typeElement)
label = Text.of(utils.isClass(typeElement)
? resources.getText("doclet.Fields_Inherited_From_Class")
: resources.getText("doclet.Fields_Inherited_From_Interface"));
}

6
src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/HelpWriter.java

@ -33,7 +33,7 @@ import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;
import jdk.javadoc.internal.doclets.formats.html.markup.TagName;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
import jdk.javadoc.internal.doclets.formats.html.Navigation.PageMode;
import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
import jdk.javadoc.internal.doclets.formats.html.markup.Text;
import jdk.javadoc.internal.doclets.toolkit.Content;
import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
import jdk.javadoc.internal.doclets.toolkit.util.DocPath;
@ -215,7 +215,7 @@ public class HelpWriter extends HtmlDocletWriter {
section = newHelpSection(getContent("doclet.help.tree.head"));
Content treeIntro = getContent("doclet.help.tree.intro",
links.createLink(DocPaths.OVERVIEW_TREE, resources.getText("doclet.Class_Hierarchy")),
HtmlTree.CODE(new StringContent("java.lang.Object")));
HtmlTree.CODE(Text.of("java.lang.Object")));
section.add(HtmlTree.P(treeIntro))
.add(newHelpSectionList(
getContent("doclet.help.tree.overview"),
@ -285,7 +285,7 @@ public class HelpWriter extends HtmlDocletWriter {
for (String[] example : SEARCH_EXAMPLES) {
searchExamples.add(HtmlTree.LI(
getContent("doclet.help.search.example",
HtmlTree.CODE(new StringContent(example[0])), example[1])));
HtmlTree.CODE(Text.of(example[0])), example[1])));
}
Content searchSpecLink = HtmlTree.A(
resources.getText("doclet.help.search.spec.url", configuration.getDocletVersion().feature()),

66
src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/HtmlDocletWriter.java

@ -38,7 +38,6 @@ import java.util.Map;
import java.util.Set;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import javax.lang.model.element.AnnotationMirror;
import javax.lang.model.element.AnnotationValue;
import javax.lang.model.element.Element;
@ -77,20 +76,18 @@ import com.sun.source.doctree.SystemPropertyTree;
import com.sun.source.doctree.TextTree;
import com.sun.source.util.SimpleDocTreeVisitor;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlId;
import jdk.javadoc.internal.doclint.HtmlTag;
import jdk.javadoc.internal.doclets.formats.html.markup.ContentBuilder;
import jdk.javadoc.internal.doclets.formats.html.markup.Entity;
import jdk.javadoc.internal.doclets.formats.html.markup.FixedStringContent;
import jdk.javadoc.internal.doclets.formats.html.markup.Head;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlDocument;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlId;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;
import jdk.javadoc.internal.doclets.formats.html.markup.TagName;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
import jdk.javadoc.internal.doclets.formats.html.markup.Links;
import jdk.javadoc.internal.doclets.formats.html.markup.RawHtml;
import jdk.javadoc.internal.doclets.formats.html.markup.Script;
import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
import jdk.javadoc.internal.doclets.formats.html.markup.TagName;
import jdk.javadoc.internal.doclets.formats.html.markup.Text;
import jdk.javadoc.internal.doclets.toolkit.ClassWriter;
import jdk.javadoc.internal.doclets.toolkit.Content;
import jdk.javadoc.internal.doclets.toolkit.Messages;
@ -99,19 +96,20 @@ import jdk.javadoc.internal.doclets.toolkit.Resources;
import jdk.javadoc.internal.doclets.toolkit.taglets.DocRootTaglet;
import jdk.javadoc.internal.doclets.toolkit.taglets.Taglet;
import jdk.javadoc.internal.doclets.toolkit.taglets.TagletWriter;
import jdk.javadoc.internal.doclets.toolkit.util.Comparators;
import jdk.javadoc.internal.doclets.toolkit.util.CommentHelper;
import jdk.javadoc.internal.doclets.toolkit.util.Comparators;
import jdk.javadoc.internal.doclets.toolkit.util.DocFile;
import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
import jdk.javadoc.internal.doclets.toolkit.util.DocLink;
import jdk.javadoc.internal.doclets.toolkit.util.DocPath;
import jdk.javadoc.internal.doclets.toolkit.util.DocPaths;
import jdk.javadoc.internal.doclets.toolkit.util.DocletConstants;
import jdk.javadoc.internal.doclets.toolkit.util.VisibleMemberTable;
import jdk.javadoc.internal.doclets.toolkit.util.Utils;
import jdk.javadoc.internal.doclets.toolkit.util.Utils.DeclarationPreviewLanguageFeatures;
import jdk.javadoc.internal.doclets.toolkit.util.Utils.ElementFlag;
import jdk.javadoc.internal.doclets.toolkit.util.Utils.PreviewSummary;
import jdk.javadoc.internal.doclets.toolkit.util.VisibleMemberTable;
import jdk.javadoc.internal.doclint.HtmlTag;
import static com.sun.source.doctree.DocTree.Kind.CODE;
import static com.sun.source.doctree.DocTree.Kind.COMMENT;
@ -558,7 +556,7 @@ public class HtmlDocletWriter {
*/
protected Content getNavLinkMainTree(String label) {
Content mainTreeContent = links.createLink(pathToRoot.resolve(DocPaths.OVERVIEW_TREE),
new StringContent(label));
Text.of(label));
Content li = HtmlTree.LI(mainTreeContent);
return li;
}
@ -584,7 +582,7 @@ public class HtmlDocletWriter {
* @return the package name content
*/
public Content getPackageLabel(CharSequence packageName) {
return new StringContent(packageName);
return Text.of(packageName);
}
/**
@ -692,7 +690,7 @@ public class HtmlDocletWriter {
}
public Content interfaceName(TypeElement typeElement, boolean qual) {
Content name = new StringContent((qual)
Content name = Text.of((qual)
? typeElement.getQualifiedName()
: utils.getSimpleName(typeElement));
return (utils.isInterface(typeElement)) ? HtmlTree.SPAN(HtmlStyle.interfaceName, name) : name;
@ -767,7 +765,7 @@ public class HtmlDocletWriter {
if (classElement != null) {
String className = utils.getSimpleName(classElement);
PackageElement packageElement = utils.containingPackage(classElement);
Content defaultLabel = new StringContent(className);
Content defaultLabel = Text.of(className);
if (code)
defaultLabel = HtmlTree.CODE(defaultLabel);
if (getCrossPackageLink(packageElement) != null) {
@ -907,7 +905,7 @@ public class HtmlDocletWriter {
*/
public Content getDocLink(HtmlLinkInfo.Kind context, Element element, CharSequence label) {
return getDocLink(context, utils.getEnclosingTypeElement(element), element,
new StringContent(label), null, false);
Text.of(label), null, false);
}
/**
@ -923,7 +921,7 @@ public class HtmlDocletWriter {
*/
public Content getDocLink(HtmlLinkInfo.Kind context, TypeElement typeElement, Element element,
CharSequence label) {
return getDocLink(context, typeElement, element, new StringContent(label), null, false);
return getDocLink(context, typeElement, element, Text.of(label), null, false);
}
/**
@ -940,7 +938,7 @@ public class HtmlDocletWriter {
*/
public Content getDocLink(HtmlLinkInfo.Kind context, TypeElement typeElement, Element element,
CharSequence label, HtmlStyle style) {
return getDocLink(context, typeElement, element, new StringContent(label), style, false);
return getDocLink(context, typeElement, element, Text.of(label), style, false);
}
/**
@ -956,7 +954,7 @@ public class HtmlDocletWriter {
*/
public Content getDocLink(HtmlLinkInfo.Kind context, TypeElement typeElement, Element element,
CharSequence label, boolean isProperty) {
return getDocLink(context, typeElement, element, new StringContent(label), null, isProperty);
return getDocLink(context, typeElement, element, Text.of(label), null, isProperty);
}
/**
@ -1017,7 +1015,7 @@ public class HtmlDocletWriter {
switch (ref.get(0).getKind()) {
case TEXT -> {
// @see "Reference"
return new StringContent(seeText);
return Text.of(seeText);
}
case START_ELEMENT -> {
// @see <a href="...">...</a>
@ -1042,7 +1040,7 @@ public class HtmlDocletWriter {
commentTagsToContent(see, element, label, context));
//The text from the @see tag. We will output this text when a label is not specified.
Content text = plainOrCode(kind == LINK_PLAIN, new StringContent(removeTrailingSlash(seeText)));
Content text = plainOrCode(kind == LINK_PLAIN, Text.of(removeTrailingSlash(seeText)));
TypeElement refClass = ch.getReferencedClass(see);
Element refMem = ch.getReferencedMember(see);
@ -1062,7 +1060,7 @@ public class HtmlDocletWriter {
//@see is referencing an included package
if (labelContent.isEmpty())
labelContent = plainOrCode(isLinkPlain,
new StringContent(refPackage.getQualifiedName()));
Text.of(refPackage.getQualifiedName()));
return getPackageLink(refPackage, labelContent);
} else {
// @see is not referencing an included class, module or package. Check for cross links.
@ -1095,7 +1093,7 @@ public class HtmlDocletWriter {
new HtmlLinkInfo(configuration, HtmlLinkInfo.Kind.DEFAULT, refType)));
}
}
labelContent = plainOrCode(isLinkPlain, new StringContent(utils.getSimpleName(refClass)));
labelContent = plainOrCode(isLinkPlain, Text.of(utils.getSimpleName(refClass)));
}
return getLink(new HtmlLinkInfo(configuration, HtmlLinkInfo.Kind.DEFAULT, refClass)
.label(labelContent));
@ -1151,7 +1149,7 @@ public class HtmlDocletWriter {
}
}
text = plainOrCode(kind == LINK_PLAIN, new StringContent(refMemName));
text = plainOrCode(kind == LINK_PLAIN, Text.of(refMemName));
return getDocLink(HtmlLinkInfo.Kind.SEE_TAG, containing,
refMem, (labelContent.isEmpty() ? text: labelContent), null, false);
@ -1558,7 +1556,7 @@ public class HtmlDocletWriter {
messages.warning(ch.getDocTreePath(node), "doclet.see.nested_link", "{@" + node.getTagName() + "}");
Content label = commentTagsToContent(node, element, node.getLabel(), context);
if (label.isEmpty()) {
label = new StringContent(node.getReference().getSignature());
label = Text.of(node.getReference().getSignature());
}
result.add(label);
} else {
@ -1571,7 +1569,7 @@ public class HtmlDocletWriter {
@Override
public Boolean visitLiteral(LiteralTree node, Content c) {
String s = node.getBody().getBody();
Content content = new StringContent(utils.normalizeNewlines(s));
Content content = Text.of(utils.normalizeNewlines(s));
if (node.getKind() == CODE)
content = HtmlTree.CODE(content);
result.add(content);
@ -1881,8 +1879,7 @@ public class HtmlDocletWriter {
ContentBuilder annotation,
Map<? extends ExecutableElement, ? extends AnnotationValue> map,
boolean linkBreak) {
linkInfo.label = new StringContent("@");
linkInfo.label.add(annotationDoc.getSimpleName());
linkInfo.label = Text.of("@" + annotationDoc.getSimpleName());
annotation.add(getLink(linkInfo));
if (!map.isEmpty()) {
annotation.add("(");
@ -1998,12 +1995,12 @@ public class HtmlDocletWriter {
String name = utils.isIncluded(t.asElement())
? t.asElement().getSimpleName().toString()
: utils.getFullyQualifiedName(t.asElement());
linkInfo.label = new StringContent(name + utils.getDimension(t) + ".class");
linkInfo.label = Text.of(name + utils.getDimension(t) + ".class");
return getLink(linkInfo);
}
@Override
protected Content defaultAction(TypeMirror e, Void p) {
return new StringContent(t + utils.getDimension(t) + ".class");
return Text.of(t + utils.getDimension(t) + ".class");
}
}.visit(t);
}
@ -2033,7 +2030,7 @@ public class HtmlDocletWriter {
}
@Override
protected Content defaultAction(Object o, Void p) {
return new StringContent(annotationValue.toString());
return Text.of(annotationValue.toString());
}
}.visit(annotationValue);
}
@ -2169,7 +2166,7 @@ public class HtmlDocletWriter {
}
Content getVerticalSeparator() {
return HtmlTree.SPAN(HtmlStyle.verticalSeparator, new FixedStringContent("|"));
return HtmlTree.SPAN(HtmlStyle.verticalSeparator, Text.of("|"));
}
public void addPreviewSummary(Element forWhat, Content target) {
@ -2192,7 +2189,7 @@ public class HtmlDocletWriter {
((TypeElement) forWhat.getEnclosingElement()).getSimpleName();
default -> forWhat.getSimpleName();
}).toString();
Content nameCode = HtmlTree.CODE(new StringContent(name));
Content nameCode = HtmlTree.CODE(Text.of(name));
boolean isReflectivePreview = utils.isReflectivePreviewAPI(forWhat);
String leadingNoteKey =
!isReflectivePreview ? "doclet.PreviewPlatformLeadingNote"
@ -2213,7 +2210,7 @@ public class HtmlDocletWriter {
List<Content> previewNotes = getPreviewNotes((TypeElement) forWhat);
if (!previewNotes.isEmpty()) {
Name name = forWhat.getSimpleName();
Content nameCode = HtmlTree.CODE(new StringContent(name));
Content nameCode = HtmlTree.CODE(Text.of(name));
HtmlTree previewDiv = HtmlTree.DIV(HtmlStyle.previewBlock);
previewDiv.setId(htmlIds.forPreviewSection(forWhat));
Content leadingNote = contents.getContent("doclet.PreviewLeadingNote", nameCode);
@ -2295,7 +2292,7 @@ public class HtmlDocletWriter {
sep[0] = ", ";
});
return contents.getContent(key,
HtmlTree.CODE(new StringContent(className)),
HtmlTree.CODE(Text.of(className)),
new HtmlTree(TagName.EM).add(featureName),
featureCodes);
}
@ -2306,14 +2303,15 @@ public class HtmlDocletWriter {
elements.stream()
.sorted((te1, te2) -> te1.getSimpleName().toString().compareTo(te2.getSimpleName().toString()))
.distinct()
.map(te -> getLink(new HtmlLinkInfo(configuration, HtmlLinkInfo.Kind.CLASS, te).label(HtmlTree.CODE(new StringContent(te.getSimpleName()))).skipPreview(true)))
.map(te -> getLink(new HtmlLinkInfo(configuration, HtmlLinkInfo.Kind.CLASS, te)
.label(HtmlTree.CODE(Text.of(te.getSimpleName()))).skipPreview(true)))
.forEach(c -> {
links.add(sep[0]);
links.add(c);
sep[0] = ", ";
});
return contents.getContent(key,
HtmlTree.CODE(new StringContent(className)),
HtmlTree.CODE(Text.of(className)),
links);
}

4
src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/HtmlLinkInfo.java

@ -32,7 +32,7 @@ import javax.lang.model.type.TypeMirror;
import jdk.javadoc.internal.doclets.formats.html.markup.ContentBuilder;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;
import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
import jdk.javadoc.internal.doclets.formats.html.markup.Text;
import jdk.javadoc.internal.doclets.toolkit.Content;
import jdk.javadoc.internal.doclets.toolkit.util.Utils;
import jdk.javadoc.internal.doclets.toolkit.util.links.LinkInfo;
@ -301,7 +301,7 @@ public class HtmlLinkInfo extends LinkInfo {
* @param label plain-text label for the link
*/
public HtmlLinkInfo label(CharSequence label) {
this.label = new StringContent(label);
this.label = Text.of(label);
return this;
}

8
src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/HtmlSerialFieldWriter.java

@ -38,7 +38,7 @@ import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;
import jdk.javadoc.internal.doclets.formats.html.markup.TagName;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
import jdk.javadoc.internal.doclets.formats.html.markup.RawHtml;
import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
import jdk.javadoc.internal.doclets.formats.html.markup.Text;
import jdk.javadoc.internal.doclets.toolkit.Content;
import jdk.javadoc.internal.doclets.toolkit.SerializedFormWriter;
import jdk.javadoc.internal.doclets.toolkit.util.CommentHelper;
@ -101,7 +101,7 @@ public class HtmlSerialFieldWriter extends FieldWriterImpl
public Content getSerializableFields(String heading, Content serializableFieldsTree) {
HtmlTree section = HtmlTree.SECTION(HtmlStyle.detail);
if (serializableFieldsTree.isValid()) {
Content headingContent = new StringContent(heading);
Content headingContent = Text.of(heading);
Content serialHeading = HtmlTree.HEADING(Headings.SerializedForm.CLASS_SUBHEADING, headingContent);
section.add(serialHeading);
section.add(serializableFieldsTree);
@ -112,7 +112,7 @@ public class HtmlSerialFieldWriter extends FieldWriterImpl
@Override
public void addMemberHeader(TypeElement fieldType, String fieldTypeStr,
String fieldDimensions, String fieldName, Content contentTree) {
Content nameContent = new StringContent(fieldName);
Content nameContent = Text.of(fieldName);
Content heading = HtmlTree.HEADING(Headings.SerializedForm.MEMBER_HEADING, nameContent);
contentTree.add(heading);
Content pre = new HtmlTree(TagName.PRE);
@ -130,7 +130,7 @@ public class HtmlSerialFieldWriter extends FieldWriterImpl
@Override
public void addMemberHeader(TypeMirror fieldType, String fieldName, Content contentTree) {
Content nameContent = new StringContent(fieldName);
Content nameContent = Text.of(fieldName);
Content heading = HtmlTree.HEADING(TagName.H5, nameContent);
contentTree.add(heading);
Content pre = new HtmlTree(TagName.PRE);

13
src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/HtmlSerialMethodWriter.java

@ -1,5 +1,5 @@
/*
* Copyright (c) 1998, 2020, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1998, 2021, Oracle and/or its affiliates. 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
@ -28,15 +28,13 @@ package jdk.javadoc.internal.doclets.formats.html;
import javax.lang.model.element.ExecutableElement;
import javax.lang.model.element.TypeElement;
import jdk.javadoc.internal.doclets.formats.html.markup.ContentBuilder;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;
import jdk.javadoc.internal.doclets.formats.html.markup.TagName;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
import jdk.javadoc.internal.doclets.formats.html.markup.Text;
import jdk.javadoc.internal.doclets.toolkit.Content;
import jdk.javadoc.internal.doclets.toolkit.SerializedFormWriter;
import jdk.javadoc.internal.doclets.toolkit.taglets.TagletManager;
import jdk.javadoc.internal.doclets.toolkit.taglets.TagletWriter;
/**
@ -90,7 +88,7 @@ public class HtmlSerialMethodWriter extends MethodWriterImpl implements
*/
@Override
public Content getSerializableMethods(String heading, Content serializableMethodContent) {
Content headingContent = new StringContent(heading);
Content headingContent = Text.of(heading);
Content serialHeading = HtmlTree.HEADING(Headings.SerializedForm.CLASS_SUBHEADING, headingContent);
Content section = HtmlTree.SECTION(HtmlStyle.detail, serialHeading);
section.add(serializableMethodContent);
@ -105,8 +103,7 @@ public class HtmlSerialMethodWriter extends MethodWriterImpl implements
*/
@Override
public Content getNoCustomizationMsg(String msg) {
Content noCustomizationMsg = new StringContent(msg);
return noCustomizationMsg;
return Text.of(msg);
}
/**
@ -117,7 +114,7 @@ public class HtmlSerialMethodWriter extends MethodWriterImpl implements
*/
@Override
public void addMemberHeader(ExecutableElement member, Content methodsContentTree) {
Content memberContent = new StringContent(name(member));
Content memberContent = Text.of(name(member));
Content heading = HtmlTree.HEADING(Headings.SerializedForm.MEMBER_HEADING, memberContent);
methodsContentTree.add(heading);
methodsContentTree.add(getSignature(member));

6
src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/IndexRedirectWriter.java

@ -1,5 +1,5 @@
/*
* Copyright (c) 2016, 2020, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2016, 2021, Oracle and/or its affiliates. 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
@ -35,7 +35,7 @@ import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;
import jdk.javadoc.internal.doclets.formats.html.markup.TagName;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
import jdk.javadoc.internal.doclets.formats.html.markup.Script;
import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
import jdk.javadoc.internal.doclets.formats.html.markup.Text;
import jdk.javadoc.internal.doclets.toolkit.Content;
import jdk.javadoc.internal.doclets.toolkit.util.DocFile;
import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
@ -102,7 +102,7 @@ public class IndexRedirectWriter extends HtmlDocletWriter {
bodyContent.add(HtmlTree.NOSCRIPT(
HtmlTree.P(contents.getContent("doclet.No_Script_Message"))));
bodyContent.add(HtmlTree.P(HtmlTree.A(targetPath, new StringContent(targetPath))));
bodyContent.add(HtmlTree.P(HtmlTree.A(targetPath, Text.of(targetPath))));
Content body = new HtmlTree(TagName.BODY).setStyle(HtmlStyle.indexRedirectPage);
HtmlTree main = HtmlTree.MAIN(bodyContent);

12
src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/IndexWriter.java

@ -46,7 +46,7 @@ import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;
import jdk.javadoc.internal.doclets.formats.html.markup.TagName;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
import jdk.javadoc.internal.doclets.formats.html.Navigation.PageMode;
import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
import jdk.javadoc.internal.doclets.formats.html.markup.Text;
import jdk.javadoc.internal.doclets.toolkit.Content;
import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
import jdk.javadoc.internal.doclets.toolkit.util.DocPath;
@ -165,7 +165,7 @@ public class IndexWriter extends HtmlDocletWriter {
* @param contentTree the tree to which to add the items
*/
protected void addHeading(char ch, Content contentTree) {
Content headContent = new StringContent(String.valueOf(ch));
Content headContent = Text.of(String.valueOf(ch));
HtmlTree heading = HtmlTree.HEADING(Headings.CONTENT_HEADING, HtmlStyle.title, headContent)
.setId(HtmlIds.forIndexChar(ch));
contentTree.add(heading);
@ -197,12 +197,12 @@ public class IndexWriter extends HtmlDocletWriter {
String label = item.getLabel();
switch (element.getKind()) {
case MODULE:
dt = HtmlTree.DT(getModuleLink((ModuleElement) element, new StringContent(label)));
dt = HtmlTree.DT(getModuleLink((ModuleElement) element, Text.of(label)));
dt.add(" - ").add(contents.module_).add(" " + label);
break;
case PACKAGE:
dt = HtmlTree.DT(getPackageLink((PackageElement) element, new StringContent(label)));
dt = HtmlTree.DT(getPackageLink((PackageElement) element, Text.of(label)));
if (configuration.showModules) {
item.setContainingModule(utils.getFullyQualifiedName(utils.containingModule(element)));
}
@ -267,7 +267,7 @@ public class IndexWriter extends HtmlDocletWriter {
protected void addTagDescription(IndexItem item, Content dlTree) {
String itemPath = pathToRoot.isEmpty() ? "" : pathToRoot.getPath() + "/";
itemPath += item.getUrl();
HtmlTree labelLink = HtmlTree.A(itemPath, new StringContent(item.getLabel()));
HtmlTree labelLink = HtmlTree.A(itemPath, Text.of(item.getLabel()));
Content dt = HtmlTree.DT(labelLink.setStyle(HtmlStyle.searchTagLink));
dt.add(" - ");
dt.add(contents.getContent("doclet.Search_tag_in", item.getHolder()));
@ -352,7 +352,7 @@ public class IndexWriter extends HtmlDocletWriter {
ListIterator<Character> iter = allFirstCharacters.listIterator();
while (iter.hasNext()) {
char ch = iter.next();
Content label = new StringContent(Character.toString(ch));
Content label = Text.of(Character.toString(ch));
Content link = splitIndex
? links.createLink(DocPaths.indexN(iter.nextIndex()), label)
: links.createLink(HtmlIds.forIndexChar(ch), label);

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

@ -38,7 +38,7 @@ import jdk.javadoc.internal.doclets.formats.html.markup.Entity;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlId;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
import jdk.javadoc.internal.doclets.formats.html.markup.Text;
import jdk.javadoc.internal.doclets.toolkit.Content;
import jdk.javadoc.internal.doclets.toolkit.MemberSummaryWriter;
import jdk.javadoc.internal.doclets.toolkit.MethodWriter;
@ -103,7 +103,7 @@ public class MethodWriterImpl extends AbstractExecutableMemberWriter
public Content getMethodDocTreeHeader(ExecutableElement method) {
Content methodDocTree = new ContentBuilder();
HtmlTree heading = HtmlTree.HEADING(Headings.TypeDeclaration.MEMBER_HEADING,
new StringContent(name(method)));
Text.of(name(method)));
HtmlId erasureAnchor;
if ((erasureAnchor = htmlIds.forErasure(method)) != null) {
heading.setId(erasureAnchor);
@ -218,11 +218,11 @@ public class MethodWriterImpl extends AbstractExecutableMemberWriter
HtmlLinkInfo.Kind.MEMBER, typeElement);
Content label;
if (options.summarizeOverriddenMethods()) {
label = new StringContent(utils.isClass(typeElement)
label = Text.of(utils.isClass(typeElement)
? resources.getText("doclet.Methods_Declared_In_Class")
: resources.getText("doclet.Methods_Declared_In_Interface"));
} else {
label = new StringContent(utils.isClass(typeElement)
label = Text.of(utils.isClass(typeElement)
? resources.getText("doclet.Methods_Inherited_From_Class")
: resources.getText("doclet.Methods_Inherited_From_Interface"));
}

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

@ -25,13 +25,15 @@
package jdk.javadoc.internal.doclets.formats.html;
import java.util.*;
import java.util.Map;
import java.util.Set;
import java.util.SortedSet;
import javax.lang.model.element.ModuleElement;
import jdk.javadoc.internal.doclets.formats.html.markup.ContentBuilder;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;
import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
import jdk.javadoc.internal.doclets.formats.html.markup.Text;
import jdk.javadoc.internal.doclets.toolkit.Content;
import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
import jdk.javadoc.internal.doclets.toolkit.util.DocPath;
@ -104,7 +106,7 @@ public class ModuleIndexWriter extends AbstractOverviewIndexWriter {
for (ModuleElement mdle : modules) {
if (!mdle.isUnnamed()) {
if (!(options.noDeprecated() && utils.isDeprecated(mdle))) {
Content moduleLinkContent = getModuleLink(mdle, new StringContent(mdle.getQualifiedName().toString()));
Content moduleLinkContent = getModuleLink(mdle, Text.of(mdle.getQualifiedName().toString()));
Content summaryContent = new ContentBuilder();
addPreviewSummary(mdle, summaryContent);
addSummaryComment(mdle, summaryContent);

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

@ -50,7 +50,7 @@ import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;
import jdk.javadoc.internal.doclets.formats.html.markup.TagName;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
import jdk.javadoc.internal.doclets.formats.html.Navigation.PageMode;
import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
import jdk.javadoc.internal.doclets.formats.html.markup.Text;
import jdk.javadoc.internal.doclets.toolkit.Content;
import jdk.javadoc.internal.doclets.toolkit.ModuleSummaryWriter;
import jdk.javadoc.internal.doclets.toolkit.util.CommentHelper;
@ -242,14 +242,14 @@ public class ModuleWriterImpl extends HtmlDocletWriter implements ModuleSummaryW
// required modules.
dependentModules.forEach((module, mod) -> {
if (shouldDocument(module)) {
indirectModules.put(module, new StringContent(mod));
indirectModules.put(module, Text.of(mod));
}
});
ElementFilter.requiresIn(mdle.getDirectives()).forEach(directive -> {
ModuleElement m = directive.getDependency();
if (shouldDocument(m)) {
if (moduleMode == ModuleMode.ALL || directive.isTransitive()) {
requires.put(m, new StringContent(utils.getModifiers(directive)));
requires.put(m, Text.of(utils.getModifiers(directive)));
} else {
// For api mode, just keep the public requires in dependentModules for display of
// indirect packages in the "Packages" section.
@ -477,7 +477,7 @@ public class ModuleWriterImpl extends HtmlDocletWriter implements ModuleSummaryW
addSummaryHeader(MarkerComments.START_OF_MODULES_SUMMARY, contents.navModules, section);
if (display(requires)) {
String text = resources.getText("doclet.Requires_Summary");
Content caption = new StringContent(text);
Content caption = Text.of(text);
Table table = getTable3(caption, requiresTableHeader);
addModulesList(requires, table);
section.add(table);
@ -485,7 +485,7 @@ public class ModuleWriterImpl extends HtmlDocletWriter implements ModuleSummaryW
// Display indirect modules table in both "api" and "all" mode.
if (display(indirectModules)) {
String amrText = resources.getText("doclet.Indirect_Requires_Summary");
Content amrCaption = new StringContent(amrText);
Content amrCaption = Text.of(amrText);
Table amrTable = getTable3(amrCaption, requiresTableHeader);
addModulesList(indirectModules, amrTable);
section.add(amrTable);
@ -503,7 +503,7 @@ public class ModuleWriterImpl extends HtmlDocletWriter implements ModuleSummaryW
private void addModulesList(Map<ModuleElement, Content> mdleMap, Table table) {
for (ModuleElement m : mdleMap.keySet()) {
Content modifiers = mdleMap.get(m);
Content moduleLink = getModuleLink(m, new StringContent(m.getQualifiedName()));
Content moduleLink = getModuleLink(m, Text.of(m.getQualifiedName()));
Content moduleSummary = new ContentBuilder();
addSummaryComment(m, moduleSummary);
table.addRow(modifiers, moduleLink, moduleSummary);
@ -524,13 +524,13 @@ public class ModuleWriterImpl extends HtmlDocletWriter implements ModuleSummaryW
new TableHeader(contents.fromLabel, contents.packagesLabel);
if (display(indirectPackages)) {
String aepText = resources.getText("doclet.Indirect_Exports_Summary");
Table aepTable = getTable2(new StringContent(aepText), indirectPackagesHeader);
Table aepTable = getTable2(Text.of(aepText), indirectPackagesHeader);
addIndirectPackages(aepTable, indirectPackages);
section.add(aepTable);
}
if (display(indirectOpenPackages)) {
String aopText = resources.getText("doclet.Indirect_Opens_Summary");
Table aopTable = getTable2(new StringContent(aopText), indirectPackagesHeader);
Table aopTable = getTable2(Text.of(aopText), indirectPackagesHeader);
addIndirectPackages(aopTable, indirectOpenPackages);
section.add(aopTable);
}
@ -643,16 +643,16 @@ public class ModuleWriterImpl extends HtmlDocletWriter implements ModuleSummaryW
private Content getPackageExportOpensTo(Set<ModuleElement> modules) {
if (modules == null) {
return new StringContent(resources.getText("doclet.None"));
return Text.of(resources.getText("doclet.None"));
} else if (modules.isEmpty()) {
return new StringContent(resources.getText("doclet.All_Modules"));
return Text.of(resources.getText("doclet.All_Modules"));
} else {
Content list = new ContentBuilder();
for (ModuleElement m : modules) {
if (!list.isEmpty()) {
list.add(new StringContent(", "));
list.add(Text.of(", "));
}
list.add(getModuleLink(m, new StringContent(m.getQualifiedName())));
list.add(getModuleLink(m, Text.of(m.getQualifiedName())));
}
return list;
}
@ -668,7 +668,7 @@ public class ModuleWriterImpl extends HtmlDocletWriter implements ModuleSummaryW
for (Map.Entry<ModuleElement, SortedSet<PackageElement>> entry : ip.entrySet()) {
ModuleElement m = entry.getKey();
SortedSet<PackageElement> pkgList = entry.getValue();
Content moduleLinkContent = getModuleLink(m, new StringContent(m.getQualifiedName()));
Content moduleLinkContent = getModuleLink(m, Text.of(m.getQualifiedName()));
Content list = new ContentBuilder();
String sep = "";
for (PackageElement pkg : pkgList) {
@ -694,7 +694,7 @@ public class ModuleWriterImpl extends HtmlDocletWriter implements ModuleSummaryW
new TableHeader(contents.typeLabel, contents.descriptionLabel);
if (haveProvides) {
String label = resources.getText("doclet.Provides_Summary");
Table table = getTable2(new StringContent(label), usesProvidesTableHeader);
Table table = getTable2(Text.of(label), usesProvidesTableHeader);
addProvidesList(table);
if (!table.isEmpty()) {
section.add(table);
@ -702,7 +702,7 @@ public class ModuleWriterImpl extends HtmlDocletWriter implements ModuleSummaryW
}
if (haveUses){
String label = resources.getText("doclet.Uses_Summary");
Table table = getTable2(new StringContent(label), usesProvidesTableHeader);
Table table = getTable2(Text.of(label), usesProvidesTableHeader);
addUsesList(table);
if (!table.isEmpty()) {
section.add(table);

6
src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/NestedClassWriterImpl.java

@ -35,7 +35,7 @@ import jdk.javadoc.internal.doclets.formats.html.markup.ContentBuilder;
import jdk.javadoc.internal.doclets.formats.html.markup.Entity;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
import jdk.javadoc.internal.doclets.formats.html.markup.Text;
import jdk.javadoc.internal.doclets.toolkit.Content;
import jdk.javadoc.internal.doclets.toolkit.MemberSummaryWriter;
@ -104,11 +104,11 @@ public class NestedClassWriterImpl extends AbstractMemberWriter
Content classLink = writer.getPreQualifiedClassLink(HtmlLinkInfo.Kind.MEMBER, typeElement);
Content label;
if (options.summarizeOverriddenMethods()) {
label = new StringContent(utils.isInterface(typeElement)
label = Text.of(utils.isInterface(typeElement)
? resources.getText("doclet.Nested_Classes_Interfaces_Declared_In_Interface")
: resources.getText("doclet.Nested_Classes_Interfaces_Declared_In_Class"));
} else {
label = new StringContent(utils.isInterface(typeElement)
label = Text.of(utils.isInterface(typeElement)
? resources.getText("doclet.Nested_Classes_Interfaces_Inherited_From_Interface")
: resources.getText("doclet.Nested_Classes_Interfaces_Inherited_From_Class"));
}

6
src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/PackageUseWriter.java

@ -1,5 +1,5 @@
/*
* Copyright (c) 1998, 2020, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1998, 2021, Oracle and/or its affiliates. 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
@ -40,7 +40,7 @@ import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;
import jdk.javadoc.internal.doclets.formats.html.markup.TagName;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
import jdk.javadoc.internal.doclets.formats.html.Navigation.PageMode;
import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
import jdk.javadoc.internal.doclets.formats.html.markup.Text;
import jdk.javadoc.internal.doclets.toolkit.Content;
import jdk.javadoc.internal.doclets.toolkit.util.ClassUseMapper;
import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
@ -198,7 +198,7 @@ public class PackageUseWriter extends SubWriterHolderWriter {
for (TypeElement te : usingPackageToUsedClasses.get(packageName)) {
DocPath dp = pathString(te,
DocPaths.CLASS_USE.resolve(docPaths.forName(te)));
Content stringContent = new StringContent(utils.getSimpleName(te));
Content stringContent = Text.of(utils.getSimpleName(te));
Content typeContent = links.createLink(dp.fragment(htmlIds.forPackage(usingPackage).name()),
stringContent);
Content summary = new ContentBuilder();

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

@ -42,7 +42,7 @@ import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;
import jdk.javadoc.internal.doclets.formats.html.markup.TagName;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
import jdk.javadoc.internal.doclets.formats.html.Navigation.PageMode;
import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
import jdk.javadoc.internal.doclets.formats.html.markup.Text;
import jdk.javadoc.internal.doclets.toolkit.Content;
import jdk.javadoc.internal.doclets.toolkit.PackageSummaryWriter;
import jdk.javadoc.internal.doclets.toolkit.util.CommentHelper;
@ -105,7 +105,7 @@ public class PackageWriterImpl extends HtmlDocletWriter
Content moduleNameDiv = HtmlTree.DIV(HtmlStyle.subTitle, classModuleLabel);
moduleNameDiv.add(Entity.NO_BREAK_SPACE);
moduleNameDiv.add(getModuleLink(mdle,
new StringContent(mdle.getQualifiedName().toString())));
Text.of(mdle.getQualifiedName().toString())));
div.add(moduleNameDiv);
}
Content packageHead = new ContentBuilder();
@ -208,7 +208,7 @@ public class PackageWriterImpl extends HtmlDocletWriter
TableHeader tableHeader, Content summaryContentTree) {
if(!classes.isEmpty()) {
Table table = new Table(HtmlStyle.summaryTable)
.setCaption(new StringContent(label))
.setCaption(Text.of(label))
.setHeader(tableHeader)
.setColumnStyles(HtmlStyle.colFirst, HtmlStyle.colLast);

10
src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/PropertyWriterImpl.java

@ -33,7 +33,7 @@ import jdk.javadoc.internal.doclets.formats.html.markup.ContentBuilder;
import jdk.javadoc.internal.doclets.formats.html.markup.Entity;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
import jdk.javadoc.internal.doclets.formats.html.markup.Text;
import jdk.javadoc.internal.doclets.toolkit.Content;
import jdk.javadoc.internal.doclets.toolkit.MemberSummaryWriter;
import jdk.javadoc.internal.doclets.toolkit.PropertyWriter;
@ -81,7 +81,7 @@ public class PropertyWriterImpl extends AbstractMemberWriter
public Content getPropertyDocTreeHeader(ExecutableElement property) {
Content propertyDocTree = new ContentBuilder();
Content heading = HtmlTree.HEADING(Headings.TypeDeclaration.MEMBER_HEADING,
new StringContent(utils.getPropertyLabel(name(property))));
Text.of(utils.getPropertyLabel(name(property))));
propertyDocTree.add(heading);
return HtmlTree.SECTION(HtmlStyle.detail, propertyDocTree)
.setId(htmlIds.forProperty(property));
@ -172,11 +172,11 @@ public class PropertyWriterImpl extends AbstractMemberWriter
HtmlLinkInfo.Kind.MEMBER, typeElement);
Content label;
if (options.summarizeOverriddenMethods()) {
label = new StringContent(utils.isClass(typeElement)
label = Text.of(utils.isClass(typeElement)
? resources.getText("doclet.Properties_Declared_In_Class")
: resources.getText("doclet.Properties_Declared_In_Interface"));
} else {
label = new StringContent(utils.isClass(typeElement)
label = Text.of(utils.isClass(typeElement)
? resources.getText("doclet.Properties_Inherited_From_Class")
: resources.getText("doclet.Properties_Inherited_From_Interface"));
}
@ -193,7 +193,7 @@ public class PropertyWriterImpl extends AbstractMemberWriter
Content tdSummary) {
Content memberLink = writer.getDocLink(context, typeElement,
member,
new StringContent(utils.getPropertyLabel(name(member))),
Text.of(utils.getPropertyLabel(name(member))),
HtmlStyle.memberNameLink,
true);

10
src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/SerializedFormWriterImpl.java

@ -34,7 +34,7 @@ import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;
import jdk.javadoc.internal.doclets.formats.html.markup.TagName;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
import jdk.javadoc.internal.doclets.formats.html.Navigation.PageMode;
import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
import jdk.javadoc.internal.doclets.formats.html.markup.Text;
import jdk.javadoc.internal.doclets.toolkit.Content;
import jdk.javadoc.internal.doclets.toolkit.SerializedFormWriter;
import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
@ -72,7 +72,7 @@ public class SerializedFormWriterImpl extends SubWriterHolderWriter
@Override
public Content getHeader(String header) {
HtmlTree bodyTree = getBody(getWindowTitle(header));
Content h1Content = new StringContent(header);
Content h1Content = Text.of(header);
Content heading = HtmlTree.HEADING_TITLE(Headings.PAGE_TITLE_HEADING,
HtmlStyle.title, h1Content);
Content div = HtmlTree.DIV(HtmlStyle.header, heading);
@ -152,7 +152,7 @@ public class SerializedFormWriterImpl extends SubWriterHolderWriter
Content classLink = (isVisibleClass(typeElement))
? getLink(new HtmlLinkInfo(configuration, HtmlLinkInfo.Kind.DEFAULT, typeElement)
.label(configuration.getClassName(typeElement)))
: new StringContent(utils.getFullyQualifiedName(typeElement));
: Text.of(utils.getFullyQualifiedName(typeElement));
Content section = HtmlTree.SECTION(HtmlStyle.serializedClassDetails)
.setId(htmlIds.forClass(typeElement));
Content superClassLink = typeElement.getSuperclass() != null
@ -194,9 +194,9 @@ public class SerializedFormWriterImpl extends SubWriterHolderWriter
String serialUID,
Content serialUidTree)
{
Content headerContent = new StringContent(header);
Content headerContent = Text.of(header);
serialUidTree.add(HtmlTree.DT(headerContent));
Content serialContent = new StringContent(serialUID);
Content serialContent = Text.of(serialUID);
serialUidTree.add(HtmlTree.DD(serialContent));
}

12
src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/Signatures.java

@ -30,7 +30,7 @@ import jdk.javadoc.internal.doclets.formats.html.markup.ContentBuilder;
import jdk.javadoc.internal.doclets.formats.html.markup.Entity;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
import jdk.javadoc.internal.doclets.formats.html.markup.Text;
import jdk.javadoc.internal.doclets.formats.html.markup.TagName;
import jdk.javadoc.internal.doclets.toolkit.Content;
import jdk.javadoc.internal.doclets.toolkit.util.DocletConstants;
@ -75,7 +75,7 @@ public class Signatures {
public static Content getPackageSignature(PackageElement pkg, PackageWriterImpl pkgWriter) {
if (pkg.isUnnamed()) {
return new StringContent();
return Text.EMPTY;
}
Content signature = HtmlTree.DIV(HtmlStyle.packageSignature);
Content annotations = pkgWriter.getAnnotationInfo(pkg, true);
@ -119,7 +119,7 @@ public class Signatures {
content.add(HtmlTree.SPAN(HtmlStyle.modifiers, modifiers));
HtmlTree nameSpan = new HtmlTree(TagName.SPAN).setStyle(HtmlStyle.elementName);
Content className = new StringContent(utils.getSimpleName(typeElement));
Content className = Text.of(utils.getSimpleName(typeElement));
if (classWriter.options.linkSource()) {
classWriter.addSrcLink(typeElement, className, nameSpan);
} else {
@ -200,7 +200,7 @@ public class Signatures {
permitsSpan.add(link);
}
if (linkablePermits.size() < permits.size()) {
Content c = new StringContent(classWriter.resources.getText("doclet.not.exhaustive"));
Content c = Text.of(classWriter.resources.getText("doclet.not.exhaustive"));
permitsSpan.add(" ");
permitsSpan.add(HtmlTree.SPAN(HtmlStyle.permitsNote, c));
}
@ -363,7 +363,7 @@ public class Signatures {
// Name
HtmlTree nameSpan = new HtmlTree(TagName.SPAN).setStyle(HtmlStyle.elementName);
if (memberWriter.options.linkSource()) {
Content name = new StringContent(memberWriter.name(element));
Content name = Text.of(memberWriter.name(element));
memberWriter.writer.addSrcLink(element, name, nameSpan);
} else {
nameSpan.add(memberWriter.name(element));
@ -406,7 +406,7 @@ public class Signatures {
}
if (!set.isEmpty()) {
String mods = set.stream().map(Modifier::toString).collect(Collectors.joining(" "));
htmlTree.add(HtmlTree.SPAN(HtmlStyle.modifiers, new StringContent(mods)))
htmlTree.add(HtmlTree.SPAN(HtmlStyle.modifiers, Text.of(mods)))
.add(Entity.NO_BREAK_SPACE);
}
}

9
src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/SourceToHTMLConverter.java

@ -27,7 +27,9 @@ package jdk.javadoc.internal.doclets.formats.html;
import jdk.javadoc.internal.doclets.formats.html.markup.Head;
import java.io.*;
import java.io.IOException;
import java.io.LineNumberReader;
import java.io.Reader;
import javax.lang.model.element.Element;
import javax.lang.model.element.ModuleElement;
@ -35,13 +37,12 @@ import javax.lang.model.element.PackageElement;
import javax.lang.model.element.TypeElement;
import javax.tools.FileObject;
import jdk.javadoc.doclet.DocletEnvironment;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlDocument;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlId;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;
import jdk.javadoc.internal.doclets.formats.html.markup.TagName;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
import jdk.javadoc.internal.doclets.formats.html.markup.Text;
import jdk.javadoc.internal.doclets.toolkit.Content;
import jdk.javadoc.internal.doclets.toolkit.Messages;
import jdk.javadoc.internal.doclets.toolkit.Resources;
@ -314,7 +315,7 @@ public class SourceToHTMLConverter {
if (line != null) {
Content anchor = HtmlTree.SPAN_ID(
HtmlIds.forLine(currentLineNo),
new StringContent(utils.replaceTabs(line)));
Text.of(utils.replaceTabs(line)));
pre.add(anchor);
pre.add(NEW_LINE);
}

4
src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/SummaryListWriter.java

@ -37,7 +37,7 @@ import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;
import jdk.javadoc.internal.doclets.formats.html.markup.TagName;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
import jdk.javadoc.internal.doclets.formats.html.Navigation.PageMode;
import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
import jdk.javadoc.internal.doclets.formats.html.markup.Text;
import jdk.javadoc.internal.doclets.toolkit.Content;
import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
import jdk.javadoc.internal.doclets.toolkit.util.DocPath;
@ -219,7 +219,7 @@ public abstract class SummaryListWriter<L extends SummaryAPIListBuilder> extends
switch (e.getKind()) {
case MODULE:
ModuleElement m = (ModuleElement) e;
link = getModuleLink(m, new StringContent(m.getQualifiedName()));
link = getModuleLink(m, Text.of(m.getQualifiedName()));
break;
case PACKAGE:
PackageElement pkg = (PackageElement) e;

13
src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/SystemPropertiesWriter.java

@ -1,5 +1,5 @@
/*
* Copyright (c) 2019, 2020, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2019, 2021, Oracle and/or its affiliates. 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
@ -22,16 +22,17 @@
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package jdk.javadoc.internal.doclets.formats.html;
import com.sun.source.doctree.DocTree;
import jdk.javadoc.internal.doclets.formats.html.markup.BodyContents;
import jdk.javadoc.internal.doclets.formats.html.markup.ContentBuilder;
import jdk.javadoc.internal.doclets.formats.html.markup.FixedStringContent;
import jdk.javadoc.internal.doclets.formats.html.markup.Text;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
import jdk.javadoc.internal.doclets.formats.html.Navigation.PageMode;
import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
import jdk.javadoc.internal.doclets.formats.html.markup.TextBuilder;
import jdk.javadoc.internal.doclets.toolkit.Content;
import jdk.javadoc.internal.doclets.toolkit.DocletElement;
import jdk.javadoc.internal.doclets.toolkit.OverviewElement;
@ -126,13 +127,13 @@ public class SystemPropertiesWriter extends HtmlDocletWriter {
*/
protected void addSystemProperties(Content content) {
Map<String, List<IndexItem>> searchIndexMap = groupSystemProperties();
Content separator = new StringContent(", ");
Content separator = Text.of(", ");
Table table = new Table(HtmlStyle.summaryTable)
.setCaption(contents.systemPropertiesSummaryLabel)
.setHeader(new TableHeader(contents.propertyLabel, contents.referencedIn))
.setColumnStyles(HtmlStyle.colFirst, HtmlStyle.colLast);
for (Entry<String, List<IndexItem>> entry : searchIndexMap.entrySet()) {
Content propertyName = new StringContent(entry.getKey());
Content propertyName = Text.of(entry.getKey());
List<IndexItem> searchIndexItems = entry.getValue();
Content separatedReferenceLinks = new ContentBuilder();
separatedReferenceLinks.add(createLink(searchIndexItems.get(0)));
@ -169,7 +170,7 @@ public class SystemPropertiesWriter extends HtmlDocletWriter {
t = p.getFileName().toString();
}
ContentBuilder b = new ContentBuilder();
b.add(HtmlTree.CODE(new FixedStringContent(i.getHolder() + ": ")));
b.add(HtmlTree.CODE(Text.of(i.getHolder() + ": ")));
// non-program elements should be displayed using a normal font
b.add(t);
return links.createLink(pathToRoot.resolve(i.getUrl()), b);

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

@ -43,7 +43,7 @@ import jdk.javadoc.internal.doclets.formats.html.markup.HtmlAttr;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlId;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
import jdk.javadoc.internal.doclets.formats.html.markup.Text;
import jdk.javadoc.internal.doclets.formats.html.markup.TagName;
import jdk.javadoc.internal.doclets.toolkit.Content;
@ -381,7 +381,7 @@ public class Table extends Content {
main.add(caption);
} else {
String tabName = tabs.iterator().next();
main.add(getCaption(new StringContent(tabName)));
main.add(getCaption(Text.of(tabName)));
}
table.add(getTableBody());
main.add(table);

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

@ -53,7 +53,7 @@ import jdk.javadoc.internal.doclets.formats.html.markup.HtmlId;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
import jdk.javadoc.internal.doclets.formats.html.markup.RawHtml;
import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
import jdk.javadoc.internal.doclets.formats.html.markup.Text;
import jdk.javadoc.internal.doclets.toolkit.BaseConfiguration;
import jdk.javadoc.internal.doclets.toolkit.Content;
import jdk.javadoc.internal.doclets.toolkit.DocletElement;
@ -190,8 +190,7 @@ public class TagletWriterImpl extends TagletWriter {
@Override
protected Content codeTagOutput(Element element, DocTree tag) {
CommentHelper ch = utils.getCommentHelper(element);
StringContent content = new StringContent(utils.normalizeNewlines(ch.getText(tag)));
Content result = HtmlTree.CODE(content);
Content result = HtmlTree.CODE(Text.of(utils.normalizeNewlines(ch.getText(tag))));
return result;
}
@ -224,7 +223,7 @@ public class TagletWriterImpl extends TagletWriter {
path = ".";
else
path = htmlWriter.pathToRoot.getPath();
return new StringContent(path);
return Text.of(path);
}
@Override
@ -267,7 +266,7 @@ public class TagletWriterImpl extends TagletWriter {
@Override
protected Content literalTagOutput(Element element, LiteralTree tag) {
CommentHelper ch = utils.getCommentHelper(element);
Content result = new StringContent(utils.normalizeNewlines(ch.getText(tag)));
Content result = Text.of(utils.normalizeNewlines(ch.getText(tag)));
return result;
}
@ -291,7 +290,7 @@ public class TagletWriterImpl extends TagletWriter {
// define id attributes for state components so that generated descriptions may refer to them
boolean defineID = (element.getKind() == ElementKind.RECORD)
&& !paramTag.isTypeParameter();
Content nameTree = new StringContent(paramName);
Content nameTree = Text.of(paramName);
body.add(HtmlTree.CODE(defineID ? HtmlTree.SPAN_ID(HtmlIds.forParam(paramName), nameTree) : nameTree));
body.add(" - ");
List<? extends DocTree> description = ch.getDescription(paramTag);
@ -327,7 +326,7 @@ public class TagletWriterImpl extends TagletWriter {
utils.getSimpleName(holder);
DocLink link = constantsPath.fragment(whichConstant);
body.add(htmlWriter.links.createLink(link,
new StringContent(resources.getText("doclet.Constants_Summary"))));
Text.of(resources.getText("doclet.Constants_Summary"))));
}
if (utils.isClass(holder) && utils.isSerializable((TypeElement)holder)) {
//Automatically add link to serialized form page for serializable classes.
@ -337,7 +336,7 @@ public class TagletWriterImpl extends TagletWriter {
DocPath serialPath = htmlWriter.pathToRoot.resolve(DocPaths.SERIALIZED_FORM);
DocLink link = serialPath.fragment(utils.getFullyQualifiedName(holder));
body.add(htmlWriter.links.createLink(link,
new StringContent(resources.getText("doclet.Serialized_Form"))));
Text.of(resources.getText("doclet.Serialized_Form"))));
}
}
if (body.isEmpty())
@ -426,7 +425,7 @@ public class TagletWriterImpl extends TagletWriter {
public Content valueTagOutput(VariableElement field, String constantVal, boolean includeLink) {
return includeLink
? htmlWriter.getDocLink(HtmlLinkInfo.Kind.VALUE_TAG, field, constantVal)
: new StringContent(constantVal);
: Text.of(constantVal);
}
@Override
@ -463,10 +462,10 @@ public class TagletWriterImpl extends TagletWriter {
private Content createAnchorAndSearchIndex(Element element, String tagText, String desc, DocTree tree) {
Content result = null;
if (context.isFirstSentence && context.inSummary || context.inTags.contains(DocTree.Kind.INDEX)) {
result = new StringContent(tagText);
result = Text.of(tagText);
} else {
HtmlId id = HtmlIds.forText(tagText, htmlWriter.indexAnchorTable);
result = HtmlTree.SPAN(id, HtmlStyle.searchTagResult, new StringContent(tagText));
result = HtmlTree.SPAN(id, HtmlStyle.searchTagResult, Text.of(tagText));
if (options.createIndex() && !tagText.isEmpty()) {
String holder = new SimpleElementVisitor14<String, Void>() {

3
src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/TreeWriter.java

@ -1,5 +1,5 @@
/*
* Copyright (c) 1997, 2020, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1997, 2021, Oracle and/or its affiliates. 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
@ -35,6 +35,7 @@ import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;
import jdk.javadoc.internal.doclets.formats.html.markup.TagName;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
import jdk.javadoc.internal.doclets.formats.html.Navigation.PageMode;
import jdk.javadoc.internal.doclets.formats.html.markup.Text;
import jdk.javadoc.internal.doclets.toolkit.Content;
import jdk.javadoc.internal.doclets.toolkit.util.ClassTree;
import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;

12
src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/ContentBuilder.java

@ -1,5 +1,5 @@
/*
* Copyright (c) 2003, 2020, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2003, 2021, Oracle and/or its affiliates. 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
@ -64,13 +64,13 @@ public class ContentBuilder extends Content {
if (text.length() > 0) {
ensureMutableContents();
Content c = contents.isEmpty() ? null : contents.get(contents.size() - 1);
StringContent sc;
if (c != null && c instanceof StringContent) {
sc = (StringContent) c;
TextBuilder tb;
if (c != null && c instanceof TextBuilder) {
tb = (TextBuilder) c;
} else {
contents.add(sc = new StringContent());
contents.add(tb = new TextBuilder());
}
sc.add(text);
tb.add(text);
}
return this;
}

9
src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/HtmlTree.java

@ -86,8 +86,9 @@ public class HtmlTree extends Content {
/**
* A sentinel value to explicitly indicate empty content.
* The '==' identity of this object is significant.
*/
public static final Content EMPTY = new StringContent("");
public static final Content EMPTY = Text.of("");
/**
* Creates an {@code HTMLTree} object representing an HTML element
@ -198,14 +199,14 @@ public class HtmlTree extends Content {
public HtmlTree add(CharSequence stringContent) {
if (!content.isEmpty()) {
Content lastContent = content.get(content.size() - 1);
if (lastContent instanceof StringContent)
if (lastContent instanceof TextBuilder)
lastContent.add(stringContent);
else {
add(new StringContent(stringContent));
add(new TextBuilder(stringContent));
}
}
else {
add(new StringContent(stringContent));
add(new TextBuilder(stringContent));
}
return this;
}

4
src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/Links.java

@ -1,5 +1,5 @@
/*
* Copyright (c) 1997, 2019, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1997, 2021, Oracle and/or its affiliates. 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
@ -85,7 +85,7 @@ public class Links {
* @return a content tree for the link
*/
public Content createLink(DocPath path, String label) {
return createLink(path, new StringContent(label), null, "");
return createLink(path, Text.of(label), null, "");
}
/**

21
src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/FixedStringContent.java → src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/Text.java

@ -1,5 +1,5 @@
/*
* Copyright (c) 2010, 2020, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2010, 2021, Oracle and/or its affiliates. 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
@ -22,6 +22,7 @@
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package jdk.javadoc.internal.doclets.formats.html.markup;
import java.io.IOException;
@ -31,22 +32,34 @@ import jdk.javadoc.internal.doclets.toolkit.Content;
import jdk.javadoc.internal.doclets.toolkit.util.DocletConstants;
/**
* Class for containing fixed string content for HTML tags of javadoc output.
* Class for containing immutable string content for HTML tags of javadoc output.
*
* <p><b>This is NOT part of any supported API.
* If you write code that depends on this, you do so at your own risk.
* This code and its internal interfaces are subject to change or
* deletion without notice.</b>
*/
public class FixedStringContent extends Content {
public class Text extends Content {
private final String string;
public static final Text EMPTY = Text.of("");
/**
* Creates a new object containing immutable text.
*
* @param content the text content
* @return the object
*/
public static Text of(CharSequence content) {
return new Text(content);
}
/**
* Constructor to construct FixedStringContent object.
*
* @param content content for the object
*/
public FixedStringContent(CharSequence content) {
private Text(CharSequence content) {
string = Entity.escapeHtmlChars(content);
}

29
src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/StringContent.java → src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/TextBuilder.java

@ -1,5 +1,5 @@
/*
* Copyright (c) 2010, 2020, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2010, 2021, Oracle and/or its affiliates. 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
@ -33,21 +33,22 @@ import jdk.javadoc.internal.doclets.toolkit.util.DocletConstants;
/**
* Class for generating string content for HTML tags of javadoc output.
* The content is mutable to the extent that additional content may be added.
*
* <p><b>This is NOT part of any supported API.
* If you write code that depends on this, you do so at your own risk.
* This code and its internal interfaces are subject to change or
* deletion without notice.</b>
*/
public class StringContent extends Content {
public class TextBuilder extends Content {
private final StringBuilder stringContent;
private final StringBuilder stringBuilder;
/**
* Constructor to construct StringContent object.
*/
public StringContent() {
stringContent = new StringBuilder();
public TextBuilder() {
stringBuilder = new StringBuilder();
}
/**
@ -55,9 +56,9 @@ public class StringContent extends Content {
*
* @param initialContent initial content for the object
*/
public StringContent(CharSequence initialContent) {
stringContent = new StringBuilder();
Entity.escapeHtmlChars(initialContent, stringContent);
public TextBuilder(CharSequence initialContent) {
stringBuilder = new StringBuilder();
Entity.escapeHtmlChars(initialContent, stringBuilder);
}
/**
@ -67,29 +68,29 @@ public class StringContent extends Content {
* @param strContent string content to be added
*/
@Override
public StringContent add(CharSequence strContent) {
Entity.escapeHtmlChars(strContent, stringContent);
public TextBuilder add(CharSequence strContent) {
Entity.escapeHtmlChars(strContent, stringBuilder);
return this;
}
@Override
public boolean isEmpty() {
return (stringContent.length() == 0);
return (stringBuilder.length() == 0);
}
@Override
public int charCount() {
return RawHtml.charCount(stringContent.toString());
return RawHtml.charCount(stringBuilder.toString());
}
@Override
public String toString() {
return stringContent.toString();
return stringBuilder.toString();
}
@Override
public boolean write(Writer out, boolean atNewline) throws IOException {
String s = stringContent.toString();
String s = stringBuilder.toString();
out.write(s);
return s.endsWith(DocletConstants.NL);
}

14
src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/Utils.java

@ -1114,20 +1114,6 @@ public class Utils {
return pkgname;
}
/**
* Given a string, replace all occurrences of 'newStr' with 'oldStr'.
* @param originalStr the string to modify.
* @param oldStr the string to replace.
* @param newStr the string to insert in place of the old string.
*/
public String replaceText(String originalStr, String oldStr,
String newStr) {
if (oldStr == null || newStr == null || oldStr.equals(newStr)) {
return originalStr;
}
return originalStr.replace(oldStr, newStr);
}
/**
* Given an annotation, return true if it should be documented and false
* otherwise.

12
test/langtools/jdk/javadoc/doclet/testHtmlDocument/TestHtmlDocument.java

@ -74,7 +74,7 @@ public class TestHtmlDocument extends JavadocTester {
HtmlTree head = new HtmlTree(TagName.HEAD);
HtmlTree title = new HtmlTree(TagName.TITLE);
// String content within the document
StringContent titleContent = new StringContent("Markup test");
TextBuilder titleContent = new TextBuilder("Markup test");
title.add(titleContent);
head.add(title);
// Test META tag
@ -101,16 +101,16 @@ public class TestHtmlDocument extends JavadocTester {
Comment pMarker = new Comment("======== START OF PARAGRAPH ========");
body.add(pMarker);
HtmlTree p = new HtmlTree(TagName.P);
StringContent bodyContent = new StringContent(
TextBuilder bodyContent = new TextBuilder(
"This document is generated from sample source code and HTML " +
"files with examples of a wide variety of Java language constructs: packages, " +
"subclasses, subinterfaces, nested classes, nested interfaces," +
"inheriting from other packages, constructors, fields," +
"methods, and so forth. ");
p.add(bodyContent);
StringContent anchorContent = new StringContent("Click Here");
TextBuilder anchorContent = new TextBuilder("Click Here");
p.add(HtmlTree.A("testLink.html", anchorContent));
StringContent pContent = new StringContent(" to <test> out a link.");
TextBuilder pContent = new TextBuilder(" to <test> out a link.");
p.add(pContent);
body.add(p);
HtmlTree p1 = new HtmlTree(TagName.P);
@ -131,11 +131,11 @@ public class TestHtmlDocument extends JavadocTester {
HtmlTree dlDisplay = new HtmlTree(TagName.DL);
dlDisplay.add(new HtmlTree(TagName.DT));
HtmlTree dd = new HtmlTree (TagName.DD);
StringContent ddContent = new StringContent("Test DD");
TextBuilder ddContent = new TextBuilder("Test DD");
dd.add(ddContent);
dlDisplay.add(dd);
body.add(dlDisplay);
StringContent emptyString = new StringContent("");
TextBuilder emptyString = new TextBuilder("");
body.add(emptyString);
Comment emptyComment = new Comment("");
body.add(emptyComment);