src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/ConstantsSummaryWriterImpl.java - platform/libcore - Git at Google

 /*
  * Copyright (c) 2001, 2020, 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
  * under the terms of the GNU General Public License version 2 only, as
  * published by the Free Software Foundation.  Oracle designates this
  * particular file as subject to the "Classpath" exception as provided
  * by Oracle in the LICENSE file that accompanied this code.
  *
  * This code is distributed in the hope that it will be useful, but WITHOUT
  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  * version 2 for more details (a copy is included in the LICENSE file that
  * accompanied this code).
  *
  * You should have received a copy of the GNU General Public License version
  * 2 along with this work; if not, write to the Free Software Foundation,
  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  *
  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  * or visit www.oracle.com if you need additional information or have any
  * questions.
  */

 package jdk.javadoc.internal.doclets.formats.html;

 import java.util.Collection;
 import java.util.Set;

 import javax.lang.model.element.Modifier;
 import javax.lang.model.element.PackageElement;
 import javax.lang.model.element.TypeElement;
 import javax.lang.model.element.VariableElement;

 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.Entity;
 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.Table;
 import jdk.javadoc.internal.doclets.formats.html.markup.TableHeader;
 import jdk.javadoc.internal.doclets.toolkit.ConstantsSummaryWriter;
 import jdk.javadoc.internal.doclets.toolkit.Content;
 import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
 import jdk.javadoc.internal.doclets.toolkit.util.DocLink;
 import jdk.javadoc.internal.doclets.toolkit.util.DocPaths;
 import jdk.javadoc.internal.doclets.toolkit.util.IndexItem;


 /**
  * Write the Constants Summary Page in HTML format.
  *
  *  <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 ConstantsSummaryWriterImpl extends HtmlDocletWriter implements ConstantsSummaryWriter {

     /**
      * The current class being documented.
      */
     private TypeElement currentTypeElement;

     private final TableHeader constantsTableHeader;

     /**
      * The HTML tree for constant values summary.
      */
     private HtmlTree summaryTree;

     private final Navigation navBar;

     private final BodyContents bodyContents = new BodyContents();

     private boolean hasConstants = false;

     /**
      * Construct a ConstantsSummaryWriter.
      * @param configuration the configuration used in this run
      *        of the standard doclet.
      */
     public ConstantsSummaryWriterImpl(HtmlConfiguration configuration) {
         super(configuration, DocPaths.CONSTANT_VALUES);
         constantsTableHeader = new TableHeader(
                 contents.modifierAndTypeLabel, contents.constantFieldLabel, contents.valueLabel);
         this.navBar = new Navigation(null, configuration, PageMode.CONSTANT_VALUES, path);
         configuration.conditionalPages.add(HtmlConfiguration.ConditionalPage.CONSTANT_VALUES);
     }

     @Override
     public Content getHeader() {
         String label = resources.getText("doclet.Constants_Summary");
         HtmlTree bodyTree = getBody(getWindowTitle(label));
         Content headerContent = new ContentBuilder();
         addTop(headerContent);
         navBar.setUserHeader(getUserHeaderFooter(true));
         headerContent.add(navBar.getContent(Navigation.Position.TOP));
         bodyContents.setHeader(headerContent);
         return bodyTree;
     }

     @Override
     public Content getContentsHeader() {
         return new HtmlTree(TagName.UL);
     }

     @Override
     public void addLinkToPackageContent(PackageElement pkg,
             Set<PackageElement> printedPackageHeaders, Content contentListTree) {
         //add link to summary
         Content link;
         if (pkg.isUnnamed()) {
             link = links.createLink(SectionName.UNNAMED_PACKAGE_ANCHOR,
                     contents.defaultPackageLabel, "", "");
         } else {
             String parsedPackageName = utils.parsePackageName(pkg);
             Content packageNameContent = getPackageLabel(parsedPackageName);
             packageNameContent.add(".*");
             link = links.createLink(DocLink.fragment(parsedPackageName),
                     packageNameContent, "", "");
             PackageElement abbrevPkg = configuration.workArounds.getAbbreviatedPackageElement(pkg);
             printedPackageHeaders.add(abbrevPkg);
         }
         contentListTree.add(HtmlTree.LI(link));
     }

     @Override
     public void addContentsList(Content contentListTree) {
         Content titleContent = contents.constantsSummaryTitle;
         Content pHeading = HtmlTree.HEADING_TITLE(Headings.PAGE_TITLE_HEADING,
                 HtmlStyle.title, titleContent);
         Content div = HtmlTree.DIV(HtmlStyle.header, pHeading);
         Content headingContent = contents.contentsHeading;
         Content heading = HtmlTree.HEADING_TITLE(Headings.CONTENT_HEADING,
                 headingContent);
         HtmlTree section = HtmlTree.SECTION(HtmlStyle.packages, heading);
         section.add(contentListTree);
         div.add(section);
         bodyContents.addMainContent(div);
     }

     @Override
     public Content getConstantSummaries() {
         return new ContentBuilder();
     }

     @Override
     public void addPackageName(PackageElement pkg, Content summariesTree, boolean first) {
         Content pkgNameContent;
         String anchorName;
         if (!first) {
             summariesTree.add(summaryTree);
         }
         if (pkg.isUnnamed()) {
             anchorName = SectionName.UNNAMED_PACKAGE_ANCHOR.getName();
             pkgNameContent = contents.defaultPackageLabel;
         } else {
             String parsedPackageName = utils.parsePackageName(pkg);
             anchorName = parsedPackageName;
             pkgNameContent = getPackageLabel(parsedPackageName);
         }
         Content headingContent = new StringContent(".*");
         Content heading = HtmlTree.HEADING_TITLE(Headings.ConstantsSummary.PACKAGE_HEADING,
                 pkgNameContent);
         heading.add(headingContent);
         summaryTree = HtmlTree.SECTION(HtmlStyle.constantsSummary, heading)
                 .setId(links.getName(anchorName));
     }

     @Override
     public Content getClassConstantHeader() {
         HtmlTree ul = new HtmlTree(TagName.UL);
         ul.setStyle(HtmlStyle.blockList);
         return ul;
     }

     @Override
     public void addClassConstant(Content summariesTree, Content classConstantTree) {
         summaryTree.add(classConstantTree);
         hasConstants = true;
     }

     @Override
     public void addConstantMembers(TypeElement typeElement, Collection<VariableElement> fields,
             Content classConstantTree) {
         currentTypeElement = typeElement;

         //generate links backward only to public classes.
         Content classlink = (utils.isPublic(typeElement) || utils.isProtected(typeElement)) ?
             getLink(new LinkInfoImpl(configuration,
                     LinkInfoImpl.Kind.CONSTANT_SUMMARY, typeElement)) :
             new StringContent(utils.getFullyQualifiedName(typeElement));

         PackageElement enclosingPackage  = utils.containingPackage(typeElement);
         Content caption = new ContentBuilder();
         if (!enclosingPackage.isUnnamed()) {
             caption.add(enclosingPackage.getQualifiedName());
             caption.add(".");
         }
         caption.add(classlink);

         Table table = new Table(HtmlStyle.summaryTable)
                 .setCaption(caption)
                 .setHeader(constantsTableHeader)
                 .setColumnStyles(HtmlStyle.colFirst, HtmlStyle.colSecond, HtmlStyle.colLast);

         for (VariableElement field : fields) {
             table.addRow(getTypeColumn(field), getNameColumn(field), getValue(field));
         }
         classConstantTree.add(HtmlTree.LI(table));
     }

     /**
      * Get the type column for the constant summary table row.
      *
      * @param member the field to be documented.
      * @return the type column of the constant table row
      */
     private Content getTypeColumn(VariableElement member) {
         Content typeContent = new ContentBuilder();
         String id = currentTypeElement.getQualifiedName() + "." + member.getSimpleName();
         Content code = new HtmlTree(TagName.CODE).setId(id);
         for (Modifier mod : member.getModifiers()) {
             Content modifier = new StringContent(mod.toString());
             code.add(modifier);
             code.add(Entity.NO_BREAK_SPACE);
         }
         Content type = getLink(new LinkInfoImpl(configuration,
                 LinkInfoImpl.Kind.CONSTANT_SUMMARY, member.asType()));
         code.add(type);
         typeContent.add(code);
         return typeContent;
     }

     /**
      * Get the name column for the constant summary table row.
      *
      * @param member the field to be documented.
      * @return the name column of the constant table row
      */
     private Content getNameColumn(VariableElement member) {
         Content nameContent = getDocLink(LinkInfoImpl.Kind.CONSTANT_SUMMARY,
                 member, member.getSimpleName(), false);
         return HtmlTree.CODE(nameContent);
     }

     /**
      * Get the value column for the constant summary table row.
      *
      * @param member the field to be documented.
      * @return the value column of the constant table row
      */
     private Content getValue(VariableElement member) {
         String value = utils.constantValueExpression(member);
         Content valueContent = new StringContent(value);
         return HtmlTree.CODE(valueContent);
     }

     @Override
     public void addConstantSummaries(Content summariesTree) {
         if (summaryTree != null) {
             summariesTree.add(summaryTree);
         }
         bodyContents.addMainContent(summariesTree);
     }

     @Override
     public void addFooter() {
         Content htmlTree = HtmlTree.FOOTER();
         navBar.setUserFooter(getUserHeaderFooter(false));
         htmlTree.add(navBar.getContent(Navigation.Position.BOTTOM));
         addBottom(htmlTree);
         bodyContents.setFooter(htmlTree);
     }

     @Override
     public void printDocument(Content contentTree) throws DocFileIOException {
         contentTree.add(bodyContents);
         printHtmlDocument(null, "summary of constants", contentTree);

         if (hasConstants && configuration.mainIndex != null) {
             configuration.mainIndex.add(IndexItem.of(IndexItem.Category.TAGS,
                     resources.getText("doclet.Constants_Summary"), path));
         }
     }
 }
	/*
	* Copyright (c) 2001, 2020, 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
	* under the terms of the GNU General Public License version 2 only, as
	* published by the Free Software Foundation. Oracle designates this
	* particular file as subject to the "Classpath" exception as provided
	* by Oracle in the LICENSE file that accompanied this code.
	*
	* This code is distributed in the hope that it will be useful, but WITHOUT
	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
	* version 2 for more details (a copy is included in the LICENSE file that
	* accompanied this code).
	*
	* You should have received a copy of the GNU General Public License version
	* 2 along with this work; if not, write to the Free Software Foundation,
	* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
	*
	* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
	* or visit www.oracle.com if you need additional information or have any
	* questions.
	*/

	package jdk.javadoc.internal.doclets.formats.html;

	import java.util.Collection;
	import java.util.Set;

	import javax.lang.model.element.Modifier;
	import javax.lang.model.element.PackageElement;
	import javax.lang.model.element.TypeElement;
	import javax.lang.model.element.VariableElement;

	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.Entity;
	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.Table;
	import jdk.javadoc.internal.doclets.formats.html.markup.TableHeader;
	import jdk.javadoc.internal.doclets.toolkit.ConstantsSummaryWriter;
	import jdk.javadoc.internal.doclets.toolkit.Content;
	import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
	import jdk.javadoc.internal.doclets.toolkit.util.DocLink;
	import jdk.javadoc.internal.doclets.toolkit.util.DocPaths;
	import jdk.javadoc.internal.doclets.toolkit.util.IndexItem;


	/**
	* Write the Constants Summary Page in HTML format.
	*
	* <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 ConstantsSummaryWriterImpl extends HtmlDocletWriter implements ConstantsSummaryWriter {

	/**
	* The current class being documented.
	*/
	private TypeElement currentTypeElement;

	private final TableHeader constantsTableHeader;

	/**
	* The HTML tree for constant values summary.
	*/
	private HtmlTree summaryTree;

	private final Navigation navBar;

	private final BodyContents bodyContents = new BodyContents();

	private boolean hasConstants = false;

	/**
	* Construct a ConstantsSummaryWriter.
	* @param configuration the configuration used in this run
	* of the standard doclet.
	*/
	public ConstantsSummaryWriterImpl(HtmlConfiguration configuration) {
	super(configuration, DocPaths.CONSTANT_VALUES);
	constantsTableHeader = new TableHeader(
	contents.modifierAndTypeLabel, contents.constantFieldLabel, contents.valueLabel);
	this.navBar = new Navigation(null, configuration, PageMode.CONSTANT_VALUES, path);
	configuration.conditionalPages.add(HtmlConfiguration.ConditionalPage.CONSTANT_VALUES);
	}

	@Override
	public Content getHeader() {
	String label = resources.getText("doclet.Constants_Summary");
	HtmlTree bodyTree = getBody(getWindowTitle(label));
	Content headerContent = new ContentBuilder();
	addTop(headerContent);
	navBar.setUserHeader(getUserHeaderFooter(true));
	headerContent.add(navBar.getContent(Navigation.Position.TOP));
	bodyContents.setHeader(headerContent);
	return bodyTree;
	}

	@Override
	public Content getContentsHeader() {
	return new HtmlTree(TagName.UL);
	}

	@Override
	public void addLinkToPackageContent(PackageElement pkg,
	Set<PackageElement> printedPackageHeaders, Content contentListTree) {
	//add link to summary
	Content link;
	if (pkg.isUnnamed()) {
	link = links.createLink(SectionName.UNNAMED_PACKAGE_ANCHOR,
	contents.defaultPackageLabel, "", "");
	} else {
	String parsedPackageName = utils.parsePackageName(pkg);
	Content packageNameContent = getPackageLabel(parsedPackageName);
	packageNameContent.add(".*");
	link = links.createLink(DocLink.fragment(parsedPackageName),
	packageNameContent, "", "");
	PackageElement abbrevPkg = configuration.workArounds.getAbbreviatedPackageElement(pkg);
	printedPackageHeaders.add(abbrevPkg);
	}
	contentListTree.add(HtmlTree.LI(link));
	}

	@Override
	public void addContentsList(Content contentListTree) {
	Content titleContent = contents.constantsSummaryTitle;
	Content pHeading = HtmlTree.HEADING_TITLE(Headings.PAGE_TITLE_HEADING,
	HtmlStyle.title, titleContent);
	Content div = HtmlTree.DIV(HtmlStyle.header, pHeading);
	Content headingContent = contents.contentsHeading;
	Content heading = HtmlTree.HEADING_TITLE(Headings.CONTENT_HEADING,
	headingContent);
	HtmlTree section = HtmlTree.SECTION(HtmlStyle.packages, heading);
	section.add(contentListTree);
	div.add(section);
	bodyContents.addMainContent(div);
	}

	@Override
	public Content getConstantSummaries() {
	return new ContentBuilder();
	}

	@Override
	public void addPackageName(PackageElement pkg, Content summariesTree, boolean first) {
	Content pkgNameContent;
	String anchorName;
	if (!first) {
	summariesTree.add(summaryTree);
	}
	if (pkg.isUnnamed()) {
	anchorName = SectionName.UNNAMED_PACKAGE_ANCHOR.getName();
	pkgNameContent = contents.defaultPackageLabel;
	} else {
	String parsedPackageName = utils.parsePackageName(pkg);
	anchorName = parsedPackageName;
	pkgNameContent = getPackageLabel(parsedPackageName);
	}
	Content headingContent = new StringContent(".*");
	Content heading = HtmlTree.HEADING_TITLE(Headings.ConstantsSummary.PACKAGE_HEADING,
	pkgNameContent);
	heading.add(headingContent);
	summaryTree = HtmlTree.SECTION(HtmlStyle.constantsSummary, heading)
	.setId(links.getName(anchorName));
	}

	@Override
	public Content getClassConstantHeader() {
	HtmlTree ul = new HtmlTree(TagName.UL);
	ul.setStyle(HtmlStyle.blockList);
	return ul;
	}

	@Override
	public void addClassConstant(Content summariesTree, Content classConstantTree) {
	summaryTree.add(classConstantTree);
	hasConstants = true;
	}

	@Override
	public void addConstantMembers(TypeElement typeElement, Collection<VariableElement> fields,
	Content classConstantTree) {
	currentTypeElement = typeElement;

	//generate links backward only to public classes.
	Content classlink = (utils.isPublic(typeElement) \|\| utils.isProtected(typeElement)) ?
	getLink(new LinkInfoImpl(configuration,
	LinkInfoImpl.Kind.CONSTANT_SUMMARY, typeElement)) :
	new StringContent(utils.getFullyQualifiedName(typeElement));

	PackageElement enclosingPackage = utils.containingPackage(typeElement);
	Content caption = new ContentBuilder();
	if (!enclosingPackage.isUnnamed()) {
	caption.add(enclosingPackage.getQualifiedName());
	caption.add(".");
	}
	caption.add(classlink);

	Table table = new Table(HtmlStyle.summaryTable)
	.setCaption(caption)
	.setHeader(constantsTableHeader)
	.setColumnStyles(HtmlStyle.colFirst, HtmlStyle.colSecond, HtmlStyle.colLast);

	for (VariableElement field : fields) {
	table.addRow(getTypeColumn(field), getNameColumn(field), getValue(field));
	}
	classConstantTree.add(HtmlTree.LI(table));
	}

	/**
	* Get the type column for the constant summary table row.
	*
	* @param member the field to be documented.
	* @return the type column of the constant table row
	*/
	private Content getTypeColumn(VariableElement member) {
	Content typeContent = new ContentBuilder();
	String id = currentTypeElement.getQualifiedName() + "." + member.getSimpleName();
	Content code = new HtmlTree(TagName.CODE).setId(id);
	for (Modifier mod : member.getModifiers()) {
	Content modifier = new StringContent(mod.toString());
	code.add(modifier);
	code.add(Entity.NO_BREAK_SPACE);
	}
	Content type = getLink(new LinkInfoImpl(configuration,
	LinkInfoImpl.Kind.CONSTANT_SUMMARY, member.asType()));
	code.add(type);
	typeContent.add(code);
	return typeContent;
	}

	/**
	* Get the name column for the constant summary table row.
	*
	* @param member the field to be documented.
	* @return the name column of the constant table row
	*/
	private Content getNameColumn(VariableElement member) {
	Content nameContent = getDocLink(LinkInfoImpl.Kind.CONSTANT_SUMMARY,
	member, member.getSimpleName(), false);
	return HtmlTree.CODE(nameContent);
	}

	/**
	* Get the value column for the constant summary table row.
	*
	* @param member the field to be documented.
	* @return the value column of the constant table row
	*/
	private Content getValue(VariableElement member) {
	String value = utils.constantValueExpression(member);
	Content valueContent = new StringContent(value);
	return HtmlTree.CODE(valueContent);
	}

	@Override
	public void addConstantSummaries(Content summariesTree) {
	if (summaryTree != null) {
	summariesTree.add(summaryTree);
	}
	bodyContents.addMainContent(summariesTree);
	}

	@Override
	public void addFooter() {
	Content htmlTree = HtmlTree.FOOTER();
	navBar.setUserFooter(getUserHeaderFooter(false));
	htmlTree.add(navBar.getContent(Navigation.Position.BOTTOM));
	addBottom(htmlTree);
	bodyContents.setFooter(htmlTree);
	}

	@Override
	public void printDocument(Content contentTree) throws DocFileIOException {
	contentTree.add(bodyContents);
	printHtmlDocument(null, "summary of constants", contentTree);

	if (hasConstants && configuration.mainIndex != null) {
	configuration.mainIndex.add(IndexItem.of(IndexItem.Category.TAGS,
	resources.getText("doclet.Constants_Summary"), path));
	}
	}
	}