Skip to content

Commit 1b756bf

Browse files
jonathan-gibbonsjonathan-gibbons
committed
8236048: Cleanup use of Utils.normalizeNewlines
Reviewed-by: hannesw
1 parent 97e2689 commit 1b756bf

26 files changed

+170
-169
lines changed

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

+6-6
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,8 @@
4242
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;
4343
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
4444
import jdk.javadoc.internal.doclets.formats.html.markup.TagName;
45+
import jdk.javadoc.internal.doclets.formats.html.markup.Text;
4546
import jdk.javadoc.internal.doclets.toolkit.Content;
46-
import jdk.javadoc.internal.doclets.toolkit.util.DocletConstants;
4747

4848
import static jdk.javadoc.internal.doclets.formats.html.HtmlLinkInfo.Kind.EXECUTABLE_MEMBER_PARAM;
4949
import static jdk.javadoc.internal.doclets.formats.html.HtmlLinkInfo.Kind.MEMBER;
@@ -211,7 +211,7 @@ protected Content getParameters(ExecutableElement member, boolean includeAnnotat
211211
TypeMirror rcvrType = member.getReceiverType();
212212
if (includeAnnotations && rcvrType != null && isAnnotatedReceiver(rcvrType)) {
213213
addReceiver(member, rcvrType, result);
214-
sep = "," + DocletConstants.NL + " ";
214+
sep = "," + Text.NL + " ";
215215
}
216216
int paramstart;
217217
ExecutableType instMeth = utils.asInstantiatedMethodType(typeElement, member);
@@ -225,7 +225,7 @@ protected Content getParameters(ExecutableElement member, boolean includeAnnotat
225225
Content annotationInfo = writer.getAnnotationInfo(param, false);
226226
if (!annotationInfo.isEmpty()) {
227227
result.add(annotationInfo)
228-
.add(DocletConstants.NL)
228+
.add(Text.NL)
229229
.add(" ");
230230
}
231231
}
@@ -237,14 +237,14 @@ protected Content getParameters(ExecutableElement member, boolean includeAnnotat
237237

238238
for (int i = paramstart + 1; i < parameters.size(); i++) {
239239
result.add(",");
240-
result.add(DocletConstants.NL);
240+
result.add(Text.NL);
241241
result.add(" ");
242242

243243
if (includeAnnotations) {
244244
Content annotationInfo = writer.getAnnotationInfo(parameters.get(i), false);
245245
if (!annotationInfo.isEmpty()) {
246246
result.add(annotationInfo)
247-
.add(DocletConstants.NL)
247+
.add(Text.NL)
248248
.add(" ");
249249
}
250250
}
@@ -268,7 +268,7 @@ protected Content getExceptions(ExecutableElement member) {
268268
for (TypeMirror t : exceptions) {
269269
if (!result.isEmpty()) {
270270
result.add(",");
271-
result.add(DocletConstants.NL);
271+
result.add(Text.NL);
272272
}
273273
Content link = writer.getLink(new HtmlLinkInfo(configuration, THROWS_TYPE, t));
274274
result.add(link);

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

+2-3
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,6 @@
3838
import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
3939
import jdk.javadoc.internal.doclets.toolkit.util.DocPath;
4040
import jdk.javadoc.internal.doclets.toolkit.util.DocPaths;
41-
import jdk.javadoc.internal.doclets.toolkit.util.DocletConstants;
4241
import jdk.javadoc.internal.doclets.toolkit.util.Utils;
4342
import jdk.javadoc.internal.doclint.HtmlTag;
4443

@@ -232,7 +231,7 @@ private List<? extends DocTree> getLocalHeaderTags(List<? extends DocTree> dtree
232231
default:
233232
if (inHead) {
234233
localTags.add(startElem);
235-
localTags.add(docTreeFactory.newTextTree(DocletConstants.NL));
234+
localTags.add(docTreeFactory.newTextTree("\n"));
236235
}
237236
}
238237
break;
@@ -248,7 +247,7 @@ private List<? extends DocTree> getLocalHeaderTags(List<? extends DocTree> dtree
248247
default:
249248
if (inHead) {
250249
localTags.add(endElem);
251-
localTags.add(docTreeFactory.newTextTree(DocletConstants.NL));
250+
localTags.add(docTreeFactory.newTextTree("\n"));
252251
}
253252
}
254253
break;

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

+5-6
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,6 @@
104104
import jdk.javadoc.internal.doclets.toolkit.util.DocLink;
105105
import jdk.javadoc.internal.doclets.toolkit.util.DocPath;
106106
import jdk.javadoc.internal.doclets.toolkit.util.DocPaths;
107-
import jdk.javadoc.internal.doclets.toolkit.util.DocletConstants;
108107
import jdk.javadoc.internal.doclets.toolkit.util.Utils;
109108
import jdk.javadoc.internal.doclets.toolkit.util.Utils.DeclarationPreviewLanguageFeatures;
110109
import jdk.javadoc.internal.doclets.toolkit.util.Utils.ElementFlag;
@@ -1169,7 +1168,7 @@ public Content commentTagsToContent(Element element,
11691168
final Content result = new ContentBuilder() {
11701169
@Override
11711170
public ContentBuilder add(CharSequence text) {
1172-
return super.add(utils.normalizeNewlines(text));
1171+
return super.add(Text.normalizeNewlines(text));
11731172
}
11741173
};
11751174
CommentHelper ch = utils.getCommentHelper(element);
@@ -1357,7 +1356,7 @@ public Boolean visitLink(LinkTree node, Content content) {
13571356
@Override
13581357
public Boolean visitLiteral(LiteralTree node, Content content) {
13591358
String s = node.getBody().getBody();
1360-
Content t = Text.of(utils.normalizeNewlines(s));
1359+
Content t = Text.of(Text.normalizeNewlines(s));
13611360
content.add(node.getKind() == CODE ? HtmlTree.CODE(t) : t);
13621361
return false;
13631362
}
@@ -1405,7 +1404,7 @@ private CharSequence textCleanup(String text, boolean isLast, boolean stripLeadi
14051404
text = text.stripTrailing();
14061405
}
14071406
text = utils.replaceTabs(text);
1408-
return utils.normalizeNewlines(text);
1407+
return Text.normalizeNewlines(text);
14091408
}
14101409

14111410
@Override
@@ -1732,7 +1731,7 @@ public Void visitArray(List<? extends AnnotationValue> vals, List<AnnotationValu
17321731
else {
17331732
addAnnotations(annotationElement, linkInfo, annotation, pairs, lineBreak);
17341733
}
1735-
annotation.add(lineBreak ? DocletConstants.NL : "");
1734+
annotation.add(lineBreak ? Text.NL : "");
17361735
results.add(annotation);
17371736
}
17381737
return results;
@@ -1764,7 +1763,7 @@ private void addAnnotations(TypeElement annotationDoc, HtmlLinkInfo linkInfo,
17641763
} else {
17651764
annotation.add(",");
17661765
if (linkBreak) {
1767-
annotation.add(DocletConstants.NL);
1766+
annotation.add(Text.NL);
17681767
int spaces = annotationDoc.getSimpleName().length() + 2;
17691768
for (int k = 0; k < (spaces); k++) {
17701769
annotation.add(" ");

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -39,12 +39,12 @@
3939
import jdk.javadoc.internal.doclets.formats.html.markup.ContentBuilder;
4040
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
4141
import jdk.javadoc.internal.doclets.formats.html.markup.TagName;
42+
import jdk.javadoc.internal.doclets.formats.html.markup.Text;
4243
import jdk.javadoc.internal.doclets.toolkit.BaseConfiguration;
4344
import jdk.javadoc.internal.doclets.toolkit.Content;
4445
import jdk.javadoc.internal.doclets.toolkit.Resources;
4546
import jdk.javadoc.internal.doclets.toolkit.util.DocPath;
4647
import jdk.javadoc.internal.doclets.toolkit.util.DocPaths;
47-
import jdk.javadoc.internal.doclets.toolkit.util.DocletConstants;
4848
import jdk.javadoc.internal.doclets.toolkit.util.Utils.ElementFlag;
4949
import jdk.javadoc.internal.doclets.toolkit.util.links.LinkFactory;
5050
import jdk.javadoc.internal.doclets.toolkit.util.links.LinkInfo;
@@ -178,7 +178,7 @@ protected Content getTypeParameterLinks(LinkInfo linkInfo) {
178178
links.add(",");
179179
links.add(new HtmlTree(TagName.WBR));
180180
if (((HtmlLinkInfo) linkInfo).getContext() == HtmlLinkInfo.Kind.MEMBER_TYPE_PARAMS) {
181-
links.add(DocletConstants.NL);
181+
links.add(Text.NL);
182182
}
183183
}
184184
links.add(getTypeParameterLink(linkInfo, t));

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

+6-7
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,6 @@
3333
import jdk.javadoc.internal.doclets.formats.html.markup.Text;
3434
import jdk.javadoc.internal.doclets.formats.html.markup.TagName;
3535
import jdk.javadoc.internal.doclets.toolkit.Content;
36-
import jdk.javadoc.internal.doclets.toolkit.util.DocletConstants;
3736
import jdk.javadoc.internal.doclets.toolkit.util.Utils;
3837

3938
import javax.lang.model.element.Element;
@@ -150,7 +149,7 @@ public Content toContent() {
150149
if (!utils.isPlainInterface(typeElement)) {
151150
TypeMirror superclass = utils.getFirstVisibleSuperClass(typeElement);
152151
if (superclass != null) {
153-
content.add(DocletConstants.NL);
152+
content.add(Text.NL);
154153
extendsImplements.add("extends ");
155154
Content link = writer.getLink(new HtmlLinkInfo(configuration,
156155
HtmlLinkInfo.Kind.CLASS_SIGNATURE_PARENT_NAME,
@@ -167,7 +166,7 @@ public Content toContent() {
167166
continue;
168167
}
169168
if (isFirst) {
170-
extendsImplements.add(DocletConstants.NL);
169+
extendsImplements.add(Text.NL);
171170
extendsImplements.add(utils.isPlainInterface(typeElement) ? "extends " : "implements ");
172171
isFirst = false;
173172
} else {
@@ -192,7 +191,7 @@ public Content toContent() {
192191
boolean isFirst = true;
193192
for (TypeMirror type : linkablePermits) {
194193
if (isFirst) {
195-
content.add(DocletConstants.NL);
194+
content.add(Text.NL);
196195
permitsSpan.add("permits");
197196
permitsSpan.add(" ");
198197
isFirst = false;
@@ -221,7 +220,7 @@ private Content getRecordComponents() {
221220
for (RecordComponentElement e : typeElement.getRecordComponents()) {
222221
content.add(sep);
223222
writer.getAnnotations(e.getAnnotationMirrors(), false)
224-
.forEach(a -> { content.add(a).add(" "); });
223+
.forEach(a -> content.add(a).add(" "));
225224
Content link = writer.getLink(new HtmlLinkInfo(configuration, HtmlLinkInfo.Kind.RECORD_COMPONENT,
226225
e.asType()));
227226
content.add(link);
@@ -544,7 +543,7 @@ private int appendTypeParameters(Content target, int lastLineSeparator) {
544543

545544
// sum below includes length of modifiers plus type params added above
546545
if (lineLength + returnType.charCount() > RETURN_TYPE_MAX_LINE_LENGTH) {
547-
target.add(DocletConstants.NL);
546+
target.add(Text.NL);
548547
newLastLineSeparator = target.charCount();
549548
} else {
550549
target.add(Entity.NO_BREAK_SPACE);
@@ -574,7 +573,7 @@ private void appendParametersAndExceptions(Content target, int lastLineSeparator
574573
// Exceptions
575574
if (exceptions != null && !exceptions.isEmpty()) {
576575
CharSequence indent = " ".repeat(Math.max(0, indentSize + 1 - 7));
577-
target.add(DocletConstants.NL)
576+
target.add(Text.NL)
578577
.add(indent)
579578
.add("throws ")
580579
.add(HtmlTree.SPAN(HtmlStyle.exceptions, exceptions));

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

+3-4
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,6 @@
5050
import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
5151
import jdk.javadoc.internal.doclets.toolkit.util.DocPath;
5252
import jdk.javadoc.internal.doclets.toolkit.util.DocPaths;
53-
import jdk.javadoc.internal.doclets.toolkit.util.DocletConstants;
5453
import jdk.javadoc.internal.doclets.toolkit.util.SimpleDocletException;
5554
import jdk.javadoc.internal.doclets.toolkit.util.Utils;
5655

@@ -69,7 +68,7 @@ public class SourceToHTMLConverter {
6968
/**
7069
* New line to be added to the documentation.
7170
*/
72-
private static final String NEW_LINE = DocletConstants.NL;
71+
private static final String NEW_LINE = Text.NL;
7372

7473
private final HtmlConfiguration configuration;
7574
private final HtmlOptions options;
@@ -289,9 +288,9 @@ private static Content getHeader() {
289288
private static void addLineNo(Content pre, int lineno) {
290289
var span = HtmlTree.SPAN(HtmlStyle.sourceLineNo);
291290
if (lineno < 10) {
292-
span.add("00" + Integer.toString(lineno));
291+
span.add("00" + lineno);
293292
} else if (lineno < 100) {
294-
span.add("0" + Integer.toString(lineno));
293+
span.add("0" + lineno);
295294
} else {
296295
span.add(Integer.toString(lineno));
297296
}

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

+2-4
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,7 @@
3030
import java.util.ArrayList;
3131
import java.util.Arrays;
3232
import java.util.HashSet;
33-
import java.util.LinkedHashMap;
3433
import java.util.List;
35-
import java.util.Map;
3634
import java.util.Set;
3735
import java.util.function.Predicate;
3836

@@ -354,8 +352,8 @@ public boolean isEmpty() {
354352
}
355353

356354
@Override
357-
public boolean write(Writer out, boolean atNewline) throws IOException {
358-
return toContent().write(out, atNewline);
355+
public boolean write(Writer out, String newline, boolean atNewline) throws IOException {
356+
return toContent().write(out, newline, atNewline);
359357
}
360358

361359
/**

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -140,8 +140,8 @@ public boolean isEmpty() {
140140
}
141141

142142
@Override
143-
public boolean write(Writer out, boolean atNewline) throws IOException {
144-
return toContent().write(out, atNewline);
143+
public boolean write(Writer out, String newline, boolean atNewline) throws IOException {
144+
return toContent().write(out, newline, atNewline);
145145
}
146146

147147
/**

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

+13-14
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,7 @@ public Content getOutputInstance() {
208208

209209
@Override
210210
protected Content codeTagOutput(Element element, LiteralTree tag) {
211-
return HtmlTree.CODE(Text.of(utils.normalizeNewlines(tag.getBody().getBody())));
211+
return HtmlTree.CODE(Text.of(Text.normalizeNewlines(tag.getBody().getBody())));
212212
}
213213

214214
@Override
@@ -309,18 +309,17 @@ public Content linkTagOutput(Element element, LinkTree tag) {
309309

310310
@Override
311311
protected Content literalTagOutput(Element element, LiteralTree tag) {
312-
return Text.of(utils.normalizeNewlines(tag.getBody().getBody()));
312+
return Text.of(Text.normalizeNewlines(tag.getBody().getBody()));
313313
}
314314

315315
@Override
316316
public Content getParamHeader(ParamTaglet.ParamKind kind) {
317-
Content header;
318-
switch (kind) {
319-
case PARAMETER: header = contents.parameters ; break;
320-
case TYPE_PARAMETER: header = contents.typeParameters ; break;
321-
case RECORD_COMPONENT: header = contents.recordComponents ; break;
322-
default: throw new IllegalArgumentException(kind.toString());
323-
}
317+
Content header = switch (kind) {
318+
case PARAMETER -> contents.parameters;
319+
case TYPE_PARAMETER -> contents.typeParameters;
320+
case RECORD_COMPONENT -> contents.recordComponents;
321+
default -> throw new IllegalArgumentException(kind.toString());
322+
};
324323
return HtmlTree.DT(header);
325324
}
326325

@@ -384,9 +383,9 @@ public Content seeTagOutput(Element holder, List<? extends SeeTree> seeTags) {
384383
// Use a different style if any link label is longer than 30 chars or contains commas.
385384
boolean hasLongLabels = links.stream().anyMatch(this::isLongOrHasComma);
386385
var seeList = HtmlTree.UL(hasLongLabels ? HtmlStyle.seeListLong : HtmlStyle.seeList);
387-
links.stream().filter(Predicate.not(Content::isEmpty)).forEach(item -> {
388-
seeList.add(HtmlTree.LI(item));
389-
});
386+
links.stream()
387+
.filter(Predicate.not(Content::isEmpty))
388+
.forEach(item -> seeList.add(HtmlTree.LI(item)));
390389

391390
return new ContentBuilder(
392391
HtmlTree.DT(contents.seeAlso),
@@ -630,7 +629,7 @@ protected Content snippetTagOutput(Element element, SnippetTree tag, StyledText
630629
}
631630

632631
content.consumeBy((styles, sequence) -> {
633-
CharSequence text = utils.normalizeNewlines(sequence);
632+
CharSequence text = Text.normalizeNewlines(sequence);
634633
if (styles.isEmpty()) {
635634
code.add(text);
636635
} else {
@@ -778,7 +777,7 @@ protected Content invalidTagOutput(String summary, Optional<String> detail) {
778777
return htmlWriter.invalidTagOutput(summary,
779778
detail.isEmpty() || detail.get().isEmpty()
780779
? Optional.empty()
781-
: Optional.of(Text.of(utils.normalizeNewlines(detail.get()))));
780+
: Optional.of(Text.of(Text.normalizeNewlines(detail.get()))));
782781
}
783782

784783
@Override

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

+3-3
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242
*/
4343
public class BodyContents extends Content {
4444

45-
private List<Content> mainContents = new ArrayList<>();
45+
private final List<Content> mainContents = new ArrayList<>();
4646
private HtmlTree header = null;
4747
private HtmlTree footer = null;
4848

@@ -74,8 +74,8 @@ public boolean isEmpty() {
7474
}
7575

7676
@Override
77-
public boolean write(Writer out, boolean atNewline) throws IOException {
78-
return toContent().write(out, atNewline);
77+
public boolean write(Writer out, String newline, boolean atNewline) throws IOException {
78+
return toContent().write(out, newline, atNewline);
7979
}
8080

8181
/**

0 commit comments

Comments
 (0)