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

equal deleted inserted replaced

-:e17429a7e843
+:1c355ea550ed
 * questions.
 */
 package jdk.javadoc.internal.doclets.formats.html;
-import java.io.*;
 import java.util.*;
 import javax.lang.model.element.PackageElement;
-import jdk.javadoc.doclet.DocletEnvironment;
 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.HtmlTag;
 import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
 import jdk.javadoc.internal.doclets.formats.html.markup.RawHtml;
 import jdk.javadoc.internal.doclets.toolkit.Content;
-import jdk.javadoc.internal.doclets.toolkit.Messages;
+import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
 import jdk.javadoc.internal.doclets.toolkit.util.DocPath;
 import jdk.javadoc.internal.doclets.toolkit.util.DocPaths;
-import jdk.javadoc.internal.doclets.toolkit.util.DocletAbortException;
 import jdk.javadoc.internal.doclets.toolkit.util.Group;
 /**
 * Generate the package index page "overview-summary.html" for the right-hand
 * frame. A click on the package name on this page will update the same frame
 * @author Atul M Dambalkar
 * @author Bhavesh Patel (Modified)
 */
 public class PackageIndexWriter extends AbstractPackageIndexWriter {
-/**
-* Root of the program structure. Used for "overview" documentation.
-*/
-private DocletEnvironment docEnv;
 /**
 * Map representing the group of packages as specified on the command line.
 *
 * @see Group
 */
-private Map<String, SortedSet<PackageElement>> groupPackageMap;
+private final Map<String, SortedSet<PackageElement>> groupPackageMap;
 /**
 * List to store the order groups as specified on the command line.
 */
-private List<String> groupList;
+private final List<String> groupList;
 /**
 * HTML tree for main tag.
 */
-private HtmlTree htmlTree = HtmlTree.MAIN();
+private final HtmlTree htmlTree = HtmlTree.MAIN();
 /**
 * Construct the PackageIndexWriter. Also constructs the grouping
 * information as provided on the command line by "-group" option. Stores
 * the order of groups specified by the user.
 *
+* @param configuration the configuration for this doclet
+* @param filename the path of the page to be generated
 * @see Group
 */
-public PackageIndexWriter(ConfigurationImpl configuration, DocPath filename) throws IOException {
+public PackageIndexWriter(ConfigurationImpl configuration, DocPath filename) {
 super(configuration, filename);
-this.docEnv = configuration.docEnv;
 groupPackageMap = configuration.group.groupPackages(packages);
 groupList = configuration.group.getGroupList();
 }
 /**
 * Generate the package index page for the right-hand frame.
 *
 * @param configuration the current configuration of the doclet.
-*/
+* @throws DocFileIOException if there is a problem generating the package index page
-public static void generate(ConfigurationImpl configuration) {
+*/
-PackageIndexWriter packgen;
+public static void generate(ConfigurationImpl configuration) throws DocFileIOException {
 DocPath filename = DocPaths.overviewSummary(configuration.frames);
-try {
+PackageIndexWriter packgen = new PackageIndexWriter(configuration, filename);
-packgen = new PackageIndexWriter(configuration, filename);
+packgen.buildPackageIndexFile("doclet.Window_Overview_Summary", true);
-packgen.buildPackageIndexFile("doclet.Window_Overview_Summary", true);
-} catch (IOException exc) {
-Messages messages = configuration.getMessages();
-messages.error("doclet.exception_encountered",
-exc.toString(), filename);
-throw new DocletAbortException(exc);
-}
 }
 /**
 * Depending upon the grouping information and their titles, add
 * separate table indices for each package group.
 *
 * @param body the documentation tree to which the index will be added
 */
+@Override
 protected void addIndex(Content body) {
 for (String groupname : groupList) {
 SortedSet<PackageElement> list = groupPackageMap.get(groupname);
 if (list != null && !list.isEmpty()) {
 addIndexContents(list,
 }
 /**
 * {@inheritDoc}
 */
+@Override
 protected void addPackagesList(Collection<PackageElement> packages, String text,
 String tableSummary, Content body) {
 Content table = (configuration.isOutputHtml5())
 ? HtmlTree.TABLE(HtmlStyle.overviewSummary, getTableCaption(new RawHtml(text)))
 : HtmlTree.TABLE(HtmlStyle.overviewSummary, tableSummary, getTableCaption(new RawHtml(text)));
 * summary at the top of the page and generate a link to the description,
 * which is added at the end of this page.
 *
 * @param body the documentation tree to which the overview header will be added
 */
+@Override
 protected void addOverviewHeader(Content body) {
 addConfigurationTitle(body);
 if (!utils.getBody(configuration.overviewElement).isEmpty()) {
 HtmlTree subTitleDiv = new HtmlTree(HtmlTag.DIV);
 subTitleDiv.addStyle(HtmlStyle.subTitle);
 * Adds the tag information as provided in the file specified by the
 * "-overview" option on the command line.
 *
 * @param body the documentation tree to which the overview will be added
 */
-protected void addOverview(Content body) throws IOException {
+@Override
+protected void addOverview(Content body) {
 HtmlTree div = new HtmlTree(HtmlTag.DIV);
 div.addStyle(HtmlStyle.contentContainer);
 addOverviewComment(div);
 if (configuration.allowTag(HtmlTag.MAIN)) {
 htmlTree.addContent(div);
 * navigation bar, and then the title (from the"-title"
 * option), at the top of page.
 *
 * @param body the documentation tree to which the navigation bar header will be added
 */
+@Override
 protected void addNavigationBarHeader(Content body) {
 Content htmlTree = (configuration.allowTag(HtmlTag.HEADER))
 ? HtmlTree.HEADER()
 : body;
 addTop(htmlTree);
 * Adds the lower navigation bar and the bottom text
 * (from the -bottom option) at the bottom of page.
 *
 * @param body the documentation tree to which the navigation bar footer will be added
 */
+@Override
 protected void addNavigationBarFooter(Content body) {
 Content htmlTree = (configuration.allowTag(HtmlTag.FOOTER))
 ? HtmlTree.FOOTER()
 : body;
 addNavLinks(false, htmlTree);

changeset 40587	1c355ea550ed
parent 40500	f293dbb81a53
child 41157	b235a429089a