Skip to content

Commit dabf4d1

Browse files
author
Amos Shi
committed
8220202: Simplify/standardize method naming for HtmlTree
Reviewed-by: lucy Backport-of: 1b9db9b
1 parent decacb8 commit dabf4d1

File tree

83 files changed

+1219
-1223
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

83 files changed

+1219
-1223
lines changed

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

+39-39
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 1997, 2018, Oracle and/or its affiliates. All rights reserved.
2+
* Copyright (c) 1997, 2019, Oracle and/or its affiliates. All rights reserved.
33
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
44
*
55
* This code is free software; you can redistribute it and/or modify it
@@ -78,8 +78,8 @@ public AbstractExecutableMemberWriter(SubWriterHolderWriter writer) {
7878
protected void addTypeParameters(ExecutableElement member, Content htmltree) {
7979
Content typeParameters = getTypeParameters(member);
8080
if (!typeParameters.isEmpty()) {
81-
htmltree.addContent(typeParameters);
82-
htmltree.addContent(Contents.SPACE);
81+
htmltree.add(typeParameters);
82+
htmltree.add(Contents.SPACE);
8383
}
8484
}
8585

@@ -100,16 +100,16 @@ protected Content getTypeParameters(ExecutableElement member) {
100100
@Override
101101
protected Content getDeprecatedLink(Element member) {
102102
Content deprecatedLinkContent = new ContentBuilder();
103-
deprecatedLinkContent.addContent(utils.getFullyQualifiedName(member));
103+
deprecatedLinkContent.add(utils.getFullyQualifiedName(member));
104104
if (!utils.isConstructor(member)) {
105-
deprecatedLinkContent.addContent(".");
106-
deprecatedLinkContent.addContent(member.getSimpleName());
105+
deprecatedLinkContent.add(".");
106+
deprecatedLinkContent.add(member.getSimpleName());
107107
}
108108
String signature = utils.flatSignature((ExecutableElement) member);
109109
if (signature.length() > 2) {
110-
deprecatedLinkContent.addContent(Contents.ZERO_WIDTH_SPACE);
110+
deprecatedLinkContent.add(Contents.ZERO_WIDTH_SPACE);
111111
}
112-
deprecatedLinkContent.addContent(signature);
112+
deprecatedLinkContent.add(signature);
113113

114114
return writer.getDocLink(MEMBER, utils.getEnclosingTypeElement(member), member, deprecatedLinkContent);
115115
}
@@ -131,7 +131,7 @@ protected void addSummaryLink(LinkInfoImpl.Kind context, TypeElement te, Element
131131
name(ee), false));
132132
Content code = HtmlTree.CODE(memberLink);
133133
addParameters(ee, false, code, name(ee).length() - 1);
134-
tdSummary.addContent(code);
134+
tdSummary.add(code);
135135
}
136136

137137
/**
@@ -143,7 +143,7 @@ protected void addSummaryLink(LinkInfoImpl.Kind context, TypeElement te, Element
143143
*/
144144
@Override
145145
protected void addInheritedSummaryLink(TypeElement te, Element member, Content linksTree) {
146-
linksTree.addContent(writer.getDocLink(MEMBER, te, member, name(member), false));
146+
linksTree.add(writer.getDocLink(MEMBER, te, member, name(member), false));
147147
}
148148

149149
/**
@@ -158,10 +158,10 @@ protected void addParam(ExecutableElement member, VariableElement param,
158158
boolean isVarArg, Content tree) {
159159
Content link = writer.getLink(new LinkInfoImpl(configuration, EXECUTABLE_MEMBER_PARAM,
160160
param.asType()).varargs(isVarArg));
161-
tree.addContent(link);
161+
tree.add(link);
162162
if(name(param).length() > 0) {
163-
tree.addContent(Contents.SPACE);
164-
tree.addContent(name(param));
163+
tree.add(Contents.SPACE);
164+
tree.add(name(param));
165165
}
166166
}
167167

@@ -176,12 +176,12 @@ protected void addParam(ExecutableElement member, VariableElement param,
176176
protected void addReceiverAnnotations(ExecutableElement member, TypeMirror rcvrType,
177177
List<? extends AnnotationMirror> annotationMirrors, Content tree) {
178178
writer.addReceiverAnnotationInfo(member, rcvrType, annotationMirrors, tree);
179-
tree.addContent(Contents.SPACE);
180-
tree.addContent(utils.getTypeName(rcvrType, false));
179+
tree.add(Contents.SPACE);
180+
tree.add(utils.getTypeName(rcvrType, false));
181181
LinkInfoImpl linkInfo = new LinkInfoImpl(configuration, RECEIVER_TYPE, rcvrType);
182-
tree.addContent(writer.getTypeParameterLinks(linkInfo));
183-
tree.addContent(Contents.SPACE);
184-
tree.addContent("this");
182+
tree.add(writer.getTypeParameterLinks(linkInfo));
183+
tree.add(Contents.SPACE);
184+
tree.add("this");
185185
}
186186

187187

@@ -216,7 +216,7 @@ protected void addParameters(ExecutableElement member,
216216
}
217217
int paramstart;
218218
for (paramstart = 0; paramstart < parameters.size(); paramstart++) {
219-
paramTree.addContent(sep);
219+
paramTree.add(sep);
220220
VariableElement param = parameters.get(paramstart);
221221

222222
if (param.getKind() != ElementKind.INSTANCE_INIT) {
@@ -225,8 +225,8 @@ protected void addParameters(ExecutableElement member,
225225
writer.addAnnotationInfo(indent.length(),
226226
member, param, paramTree);
227227
if (foundAnnotations) {
228-
paramTree.addContent(DocletConstants.NL);
229-
paramTree.addContent(indent);
228+
paramTree.add(DocletConstants.NL);
229+
paramTree.add(indent);
230230
}
231231
}
232232
addParam(member, param,
@@ -236,28 +236,28 @@ protected void addParameters(ExecutableElement member,
236236
}
237237

238238
for (int i = paramstart + 1; i < parameters.size(); i++) {
239-
paramTree.addContent(",");
240-
paramTree.addContent(DocletConstants.NL);
241-
paramTree.addContent(indent);
239+
paramTree.add(",");
240+
paramTree.add(DocletConstants.NL);
241+
paramTree.add(indent);
242242
if (includeAnnotations) {
243243
boolean foundAnnotations =
244244
writer.addAnnotationInfo(indent.length(), member, parameters.get(i),
245245
paramTree);
246246
if (foundAnnotations) {
247-
paramTree.addContent(DocletConstants.NL);
248-
paramTree.addContent(indent);
247+
paramTree.add(DocletConstants.NL);
248+
paramTree.add(indent);
249249
}
250250
}
251251
addParam(member, parameters.get(i), (i == parameters.size() - 1) && member.isVarArgs(),
252252
paramTree);
253253
}
254254
if (paramTree.isEmpty()) {
255-
htmltree.addContent("()");
255+
htmltree.add("()");
256256
} else {
257-
htmltree.addContent(Contents.ZERO_WIDTH_SPACE);
258-
htmltree.addContent("(");
259-
htmltree.addContent(paramTree);
260-
paramTree.addContent(")");
257+
htmltree.add(Contents.ZERO_WIDTH_SPACE);
258+
htmltree.add("(");
259+
htmltree.add(paramTree);
260+
paramTree.add(")");
261261
}
262262
}
263263

@@ -271,19 +271,19 @@ protected void addExceptions(ExecutableElement member, Content htmltree, int ind
271271
List<? extends TypeMirror> exceptions = member.getThrownTypes();
272272
if (!exceptions.isEmpty()) {
273273
CharSequence indent = makeSpace(indentSize + 1 - 7);
274-
htmltree.addContent(DocletConstants.NL);
275-
htmltree.addContent(indent);
276-
htmltree.addContent("throws ");
274+
htmltree.add(DocletConstants.NL);
275+
htmltree.add(indent);
276+
htmltree.add("throws ");
277277
indent = makeSpace(indentSize + 1);
278278
Content link = writer.getLink(new LinkInfoImpl(configuration, MEMBER, exceptions.get(0)));
279-
htmltree.addContent(link);
279+
htmltree.add(link);
280280
for(int i = 1; i < exceptions.size(); i++) {
281-
htmltree.addContent(",");
282-
htmltree.addContent(DocletConstants.NL);
283-
htmltree.addContent(indent);
281+
htmltree.add(",");
282+
htmltree.add(DocletConstants.NL);
283+
htmltree.add(indent);
284284
Content exceptionLink = writer.getLink(new LinkInfoImpl(configuration, MEMBER,
285285
exceptions.get(i)));
286-
htmltree.addContent(exceptionLink);
286+
htmltree.add(exceptionLink);
287287
}
288288
}
289289
}

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

+35-35
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ protected void addContents(Character uc, Collection<? extends Element> memberlis
109109
for (Element element : memberlist) {
110110
addDescription(dl, element);
111111
}
112-
contentTree.addContent(dl);
112+
contentTree.add(dl);
113113
}
114114
}
115115

@@ -122,7 +122,7 @@ protected void addSearchContents(Character uc, List<SearchIndexItem> searchList,
122122
for (SearchIndexItem sii : searchList) {
123123
addDescription(sii, dl);
124124
}
125-
contentTree.addContent(dl);
125+
contentTree.add(dl);
126126
}
127127
}
128128

@@ -163,16 +163,16 @@ protected void addContents(Character uc, List<? extends Element> memberlist,
163163
i++;
164164
}
165165
}
166-
contentTree.addContent(dl);
166+
contentTree.add(dl);
167167
}
168168

169169
protected void addHeading(Character uc, Content contentTree) {
170170
String unicode = uc.toString();
171-
contentTree.addContent(getMarkerAnchorForIndex(unicode));
171+
contentTree.add(getMarkerAnchorForIndex(unicode));
172172
Content headContent = new StringContent(unicode);
173173
Content heading = HtmlTree.HEADING(HtmlConstants.CONTENT_HEADING, false,
174174
HtmlStyle.title, headContent);
175-
contentTree.addContent(heading);
175+
contentTree.add(heading);
176176
}
177177

178178
protected void addDescription(Content dl, Element element) {
@@ -225,13 +225,13 @@ protected void addDescription(ModuleElement mdle, Content dlTree, SearchIndexIte
225225
si.setLabel(moduleName);
226226
si.setCategory(resources.getText("doclet.Modules"));
227227
Content dt = HtmlTree.DT(link);
228-
dt.addContent(" - ");
229-
dt.addContent(contents.module_);
230-
dt.addContent(" " + moduleName);
231-
dlTree.addContent(dt);
228+
dt.add(" - ");
229+
dt.add(contents.module_);
230+
dt.add(" " + moduleName);
231+
dlTree.add(dt);
232232
Content dd = new HtmlTree(HtmlTag.DD);
233233
addSummaryComment(mdle, dd);
234-
dlTree.addContent(dd);
234+
dlTree.add(dd);
235235
}
236236

237237
/**
@@ -249,13 +249,13 @@ protected void addDescription(PackageElement pkg, Content dlTree, SearchIndexIte
249249
si.setLabel(utils.getPackageName(pkg));
250250
si.setCategory(resources.getText("doclet.Packages"));
251251
Content dt = HtmlTree.DT(link);
252-
dt.addContent(" - ");
253-
dt.addContent(contents.package_);
254-
dt.addContent(" " + utils.getPackageName(pkg));
255-
dlTree.addContent(dt);
252+
dt.add(" - ");
253+
dt.add(contents.package_);
254+
dt.add(" " + utils.getPackageName(pkg));
255+
dlTree.add(dt);
256256
Content dd = new HtmlTree(HtmlTag.DD);
257257
addSummaryComment(pkg, dd);
258-
dlTree.addContent(dd);
258+
dlTree.add(dd);
259259
}
260260

261261
/**
@@ -272,12 +272,12 @@ protected void addDescription(TypeElement typeElement, Content dlTree, SearchInd
272272
si.setLabel(utils.getSimpleName(typeElement));
273273
si.setCategory(resources.getText("doclet.Types"));
274274
Content dt = HtmlTree.DT(link);
275-
dt.addContent(" - ");
275+
dt.add(" - ");
276276
addClassInfo(typeElement, dt);
277-
dlTree.addContent(dt);
277+
dlTree.add(dt);
278278
Content dd = new HtmlTree(HtmlTag.DD);
279279
addComment(typeElement, dd);
280-
dlTree.addContent(dd);
280+
dlTree.add(dd);
281281
}
282282

283283
/**
@@ -288,7 +288,7 @@ protected void addDescription(TypeElement typeElement, Content dlTree, SearchInd
288288
* @param contentTree the content tree to which the class info will be added
289289
*/
290290
protected void addClassInfo(TypeElement te, Content contentTree) {
291-
contentTree.addContent(contents.getContent("doclet.in",
291+
contentTree.add(contents.getContent("doclet.in",
292292
utils.getTypeElementName(te, false),
293293
getPackageLink(utils.containingPackage(te),
294294
utils.getPackageName(utils.containingPackage(te)))
@@ -322,29 +322,29 @@ protected void addDescription(Element member, Content dlTree, SearchIndexItem si
322322
Content span = HtmlTree.SPAN(HtmlStyle.memberNameLink,
323323
getDocLink(LinkInfoImpl.Kind.INDEX, member, name));
324324
Content dt = HtmlTree.DT(span);
325-
dt.addContent(" - ");
325+
dt.add(" - ");
326326
addMemberDesc(member, dt);
327-
dlTree.addContent(dt);
327+
dlTree.add(dt);
328328
Content dd = new HtmlTree(HtmlTag.DD);
329329
addComment(member, dd);
330-
dlTree.addContent(dd);
330+
dlTree.add(dd);
331331
}
332332

333333
protected void addDescription(SearchIndexItem sii, Content dlTree) {
334334
String siiPath = pathToRoot.isEmpty() ? "" : pathToRoot.getPath() + "/";
335335
siiPath += sii.getUrl();
336336
HtmlTree labelLink = HtmlTree.A(siiPath, new StringContent(sii.getLabel()));
337337
Content dt = HtmlTree.DT(HtmlTree.SPAN(HtmlStyle.searchTagLink, labelLink));
338-
dt.addContent(" - ");
339-
dt.addContent(contents.getContent("doclet.Search_tag_in", sii.getHolder()));
340-
dlTree.addContent(dt);
338+
dt.add(" - ");
339+
dt.add(contents.getContent("doclet.Search_tag_in", sii.getHolder()));
340+
dlTree.add(dt);
341341
Content dd = new HtmlTree(HtmlTag.DD);
342342
if (sii.getDescription().isEmpty()) {
343-
dd.addContent(Contents.SPACE);
343+
dd.add(Contents.SPACE);
344344
} else {
345-
dd.addContent(sii.getDescription());
345+
dd.add(sii.getDescription());
346346
}
347-
dlTree.addContent(dd);
347+
dlTree.add(dd);
348348
}
349349

350350
/**
@@ -362,17 +362,17 @@ protected void addComment(Element element, Content contentTree) {
362362
HtmlTree div = new HtmlTree(HtmlTag.DIV);
363363
div.setStyle(HtmlStyle.deprecationBlock);
364364
if (utils.isDeprecated(element)) {
365-
div.addContent(span);
365+
div.add(span);
366366
tags = utils.getBlockTags(element, DocTree.Kind.DEPRECATED);
367367
if (!tags.isEmpty())
368368
addInlineDeprecatedComment(element, tags.get(0), div);
369-
contentTree.addContent(div);
369+
contentTree.add(div);
370370
} else {
371371
TypeElement encl = utils.getEnclosingTypeElement(element);
372372
while (encl != null) {
373373
if (utils.isDeprecated(encl)) {
374-
div.addContent(span);
375-
contentTree.addContent(div);
374+
div.add(span);
375+
contentTree.add(div);
376376
break;
377377
}
378378
encl = utils.getEnclosingTypeElement(encl);
@@ -395,15 +395,15 @@ protected void addMemberDesc(Element member, Content contentTree) {
395395
Content resource = contents.getContent(utils.isStatic(member)
396396
? "doclet.Static_variable_in"
397397
: "doclet.Variable_in", classdesc);
398-
contentTree.addContent(resource);
398+
contentTree.add(resource);
399399
} else if (utils.isConstructor(member)) {
400-
contentTree.addContent(
400+
contentTree.add(
401401
contents.getContent("doclet.Constructor_for", classdesc));
402402
} else if (utils.isMethod(member)) {
403403
Content resource = contents.getContent(utils.isStatic(member)
404404
? "doclet.Static_method_in"
405405
: "doclet.Method_in", classdesc);
406-
contentTree.addContent(resource);
406+
contentTree.add(resource);
407407
}
408408
addPreQualifiedClassLink(LinkInfoImpl.Kind.INDEX, containing,
409409
false, contentTree);

0 commit comments

Comments
 (0)