jdk-sandbox: comparison langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/HtmlDocletWriter.java

equal deleted inserted replaced

-:9d823cc0fe98
+:d31e4986dc8b
 * To check whether the container annotations is documented or not.
 */
 private boolean isContainerDocumented = false;
 HtmlTree fixedNavDiv = new HtmlTree(HtmlTag.DIV);
+final static Pattern IMPROPER_HTML_CHARS = Pattern.compile(".*[&<>].*");
 /**
 * Constructor to construct the HtmlStandardWriter object.
 *
 * @param path File to be generated.
 * @return package name content
 */
 public Content getPackageName(PackageElement packageElement) {
 return packageElement == null || packageElement.isUnnamed()
 ? defaultPackageLabel
-: getPackageLabel(packageElement.getQualifiedName().toString());
+: getPackageLabel(packageElement.getQualifiedName());
 }
 /**
 * Returns a package name label.
 *
 * @param packageName the package name
 * @return the package name content
 */
-public Content getPackageLabel(String packageName) {
+public Content getPackageLabel(CharSequence packageName) {
 return new StringContent(packageName);
 }
 /**
 * Add package deprecation information to the documentation tree
 *
 * @param packageElement the package to link to.
 * @param label the label for the link.
 * @return a content tree for the package link.
 */
-public Content getPackageLink(PackageElement packageElement, String label) {
+public Content getPackageLink(PackageElement packageElement, CharSequence label) {
 return getPackageLink(packageElement, new StringContent(label));
 }
 public Content getPackageLink(PackageElement packageElement) {
 StringContent content =  packageElement.isUnnamed()
 }
 }
 public Content interfaceName(TypeElement typeElement, boolean qual) {
 Content name = new StringContent((qual)
-? typeElement.getQualifiedName().toString()
+? typeElement.getQualifiedName()
 : utils.getSimpleName(typeElement));
 return (utils.isInterface(typeElement)) ?  HtmlTree.SPAN(HtmlStyle.interfaceName, name) : name;
 }
 /**
 * @param context the id of the context where the link will be added
 * @param element the member being linked to
 * @param label the label for the link
 * @return a content tree for the element link
 */
-public Content getDocLink(LinkInfoImpl.Kind context, Element element, String label) {
+public Content getDocLink(LinkInfoImpl.Kind context, Element element, CharSequence label) {
 return getDocLink(context, utils.getEnclosingTypeElement(element), element,
 new StringContent(label));
 }
 /**
 * @param element the member being linked to.
 * @param label the label for the link.
 * @param strong true if the link should be strong.
 * @return the link for the given member.
 */
-public Content getDocLink(LinkInfoImpl.Kind context, Element element, String label,
+public Content getDocLink(LinkInfoImpl.Kind context, Element element, CharSequence label,
 boolean strong) {
 return getDocLink(context, utils.getEnclosingTypeElement(element), element, label, strong);
 }
 /**
 * @param label the label for the link.
 * @param strong true if the link should be strong.
 * @return the link for the given member.
 */
 public Content getDocLink(LinkInfoImpl.Kind context, TypeElement typeElement, Element element,
-String label, boolean strong) {
+CharSequence label, boolean strong) {
 return getDocLink(context, typeElement, element, label, strong, false);
 }
 public Content getDocLink(LinkInfoImpl.Kind context, TypeElement typeElement, Element element,
 Content label, boolean strong) {
 * @param strong true if the link should be strong.
 * @param isProperty true if the element parameter is a JavaFX property.
 * @return the link for the given member.
 */
 public Content getDocLink(LinkInfoImpl.Kind context, TypeElement typeElement, Element element,
-String label, boolean strong, boolean isProperty) {
+CharSequence label, boolean strong, boolean isProperty) {
 return getDocLink(context, typeElement, element, new StringContent(check(label)), strong, isProperty);
 }
-String check(String s) {
+CharSequence check(CharSequence s) {
-if (s.matches(".*[&<>].*")) {
+Matcher m = IMPROPER_HTML_CHARS.matcher(s);
-throw new IllegalArgumentException(s);
+if (m.matches()) {
+throw new IllegalArgumentException(s.toString());
 }
 return s;
 }
 public Content getDocLink(LinkInfoImpl.Kind context, TypeElement typeElement, Element element,
 return new ContentBuilder();
 }
 CommentHelper ch = utils.getCommentHelper(element);
 String tagName = ch.getTagName(see);
-String seetext = replaceDocRootDir(utils.normalizeNewlines(ch.getText(see)));
+String seetext = replaceDocRootDir(utils.normalizeNewlines(ch.getText(see)).toString());
 // Check if @see is an href or "string"
 if (seetext.startsWith("<") || seetext.startsWith("\"")) {
 return new RawHtml(seetext);
 }
 boolean isLinkPlain = kind == LINK_PLAIN;
 PackageElement refPackage = ch.getReferencedPackage(configuration, see);
 if (refPackage != null && utils.isIncluded(refPackage)) {
 //@see is referencing an included package
 if (label.isEmpty())
 label = plainOrCode(isLinkPlain,
-new StringContent(refPackage.getQualifiedName().toString()));
+new StringContent(refPackage.getQualifiedName()));
 return getPackageLink(refPackage, label);
 } else {
 // @see is not referencing an included class or package.  Check for cross links.
 Content classCrossLink;
 DocLink packageCrossLink = getCrossPackageLink(refClassName);
 public Content commentTagsToContent(DocTree holderTag, Element element,
 List<? extends DocTree> tags, boolean isFirstSentence) {
 final Content result = new ContentBuilder() {
 @Override
-public void addContent(String text) {
+public void addContent(CharSequence text) {
 super.addContent(utils.normalizeNewlines(text));
 }
 };
 CommentHelper ch = utils.getCommentHelper(element);
 // Array of all possible inline tags for this javadoc run
 @Override @DefinedBy(Api.COMPILER_TREE)
 public Boolean visitAttribute(AttributeTree node, Content c) {
 StringBuilder sb = new StringBuilder(SPACER).append(node.getName());
 if (node.getValueKind() == ValueKind.EMPTY) {
-result.addContent(sb.toString());
+result.addContent(sb);
 return false;
 }
 sb.append("=");
 String quote;
 switch (node.getValueKind()) {
 default:
 quote = "";
 break;
 }
 sb.append(quote);
-result.addContent(sb.toString());
+result.addContent(sb);
 Content docRootContent = new ContentBuilder();
 for (DocTree dt : node.getValue()) {
 if (utils.isText(dt) && inAnAtag()) {
 String text = ((TextTree) dt).getBody();
 if (text.startsWith("/..") && !configuration.docrootparent.isEmpty()) {
 result.addContent(configuration.docrootparent);
 docRootContent = new ContentBuilder();
-text = textCleanup(text.substring(3), isLast(node));
+result.addContent(textCleanup(text.substring(3), isLast(node)));
 } else {
 if (!docRootContent.isEmpty()) {
 docRootContent = copyDocRootContent(docRootContent);
 } else {
 text = redirectRelativeLinks(element, (TextTree) dt);
 }
-text = textCleanup(text, isLast(node));
+result.addContent(textCleanup(text, isLast(node)));
 }
-result.addContent(text);
 } else {
 docRootContent = copyDocRootContent(docRootContent);
 dt.accept(this, docRootContent);
 }
 }
 }
 @Override @DefinedBy(Api.COMPILER_TREE)
 public Boolean visitStartElement(StartElementTree node, Content c) {
 String text = "<" + node.getName();
-text = utils.normalizeNewlines(text);
+RawHtml rawHtml = new RawHtml(utils.normalizeNewlines(text));
-RawHtml rawHtml = new RawHtml(text);
 result.addContent(rawHtml);
 for (DocTree dt : node.getAttributes()) {
 dt.accept(this, null);
 }
 result.addContent(new RawHtml(node.isSelfClosing() ? "/>" : ">"));
 return false;
 }
-private String textCleanup(String text, boolean isLast) {
+private CharSequence textCleanup(String text, boolean isLast) {
 return textCleanup(text, isLast, false);
 }
-private String textCleanup(String text, boolean isLast, boolean trimLeader) {
+private CharSequence textCleanup(String text, boolean isLast, boolean trimLeader) {
 if (trimLeader) {
 text = removeLeadingWhitespace(text);
 }
 if (isFirstSentence && isLast) {
 text = removeTrailingWhitespace(text);
 }
 text = utils.replaceTabs(text);
-text = utils.normalizeNewlines(text);
+return utils.normalizeNewlines(text);
-return text;
 }
 @Override @DefinedBy(Api.COMPILER_TREE)
 public Boolean visitText(TextTree node, Content c) {
 String text = node.getBody();
-text = textCleanup(text, isLast(node), commentRemoved);
+result.addContent(new RawHtml(textCleanup(text, isLast(node), commentRemoved)));
 commentRemoved = false;
-result.addContent(new RawHtml(text));
 return false;
 }
 @Override @DefinedBy(Api.COMPILER_TREE)
 protected Boolean defaultAction(DocTree node, Content c) {
 * @param linkBreak if true, add new line between each member value
 */
 private void addAnnotations(TypeElement annotationDoc, LinkInfoImpl linkInfo,
 ContentBuilder annotation, Map<? extends ExecutableElement,? extends AnnotationValue>map,
 int indent, boolean linkBreak) {
-linkInfo.label = new StringContent("@" + annotationDoc.getSimpleName().toString());
+linkInfo.label = new StringContent("@");
+linkInfo.label.addContent(annotationDoc.getSimpleName());
 annotation.addContent(getLink(linkInfo));
 if (!map.isEmpty()) {
 annotation.addContent("(");
 boolean isFirst = true;
 Set<? extends ExecutableElement> keys = map.keySet();
 isFirst = false;
 } else {
 annotation.addContent(",");
 if (linkBreak) {
 annotation.addContent(DocletConstants.NL);
-int spaces = annotationDoc.getSimpleName().toString().length() + 2;
+int spaces = annotationDoc.getSimpleName().length() + 2;
 for (int k = 0; k < (spaces + indent); k++) {
 annotation.addContent(" ");
 }
 }
 }
 return buf;
 }
 @Override @DefinedBy(Api.LANGUAGE_MODEL)
 public Content visitEnumConstant(VariableElement c, Void p) {
 return getDocLink(LinkInfoImpl.Kind.ANNOTATION,
-c, c.getSimpleName().toString(), false);
+c, c.getSimpleName(), false);
 }
 @Override @DefinedBy(Api.LANGUAGE_MODEL)
 public Content visitArray(List<? extends AnnotationValue> vals, Void p) {
 ContentBuilder buf = new ContentBuilder();
 String sep = "";

changeset 36500	d31e4986dc8b
parent 36038	39c5445924b9
child 36526	3b41f1c69604