/* * Copyright (c) 1998, 2016, 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.io.*; import java.util.*; import javax.lang.model.element.TypeElement; import jdk.javadoc.internal.doclets.formats.html.markup.HtmlConstants; 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.toolkit.Content; import jdk.javadoc.internal.doclets.toolkit.util.ClassTree; import jdk.javadoc.internal.doclets.toolkit.util.DocPath; import jdk.javadoc.internal.doclets.toolkit.util.DocletAbortException; /** * Abstract class to print the class hierarchy page for all the Classes. This * is sub-classed by {@link PackageTreeWriter} and {@link TreeWriter} to * generate the Package Tree and global Tree(for all the classes and packages) * pages. * *

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. * * @author Atul M Dambalkar */ public abstract class AbstractTreeWriter extends HtmlDocletWriter { /** * The class and interface tree built by using {@link ClassTree} */ protected final ClassTree classtree; /** * Constructor initializes classtree variable. This constructor will be used * while generating global tree file "overview-tree.html". * * @param configuration The current configuration * @param filename File to be generated. * @param classtree Tree built by {@link ClassTree}. * @throws IOException * @throws DocletAbortException */ protected AbstractTreeWriter(ConfigurationImpl configuration, DocPath filename, ClassTree classtree) throws IOException { super(configuration, filename); this.classtree = classtree; } /** * Add each level of the class tree. For each sub-class or * sub-interface indents the next level information. * Recurses itself to add sub-classes info. * * @param parent the superclass or superinterface of the sset * @param list sset of the sub-classes at this level * @param isEnum true if we are generating a tree for enums * @param contentTree the content tree to which the level information will be added */ protected void addLevelInfo(TypeElement parent, Collection list, boolean isEnum, Content contentTree) { if (!list.isEmpty()) { Content ul = new HtmlTree(HtmlTag.UL); for (TypeElement local : list) { HtmlTree li = new HtmlTree(HtmlTag.LI); li.addStyle(HtmlStyle.circle); addPartialInfo(local, li); addExtendsImplements(parent, local, li); addLevelInfo(local, classtree.directSubClasses(local, isEnum), isEnum, li); // Recurse ul.addContent(li); } contentTree.addContent(ul); } } /** * Add the heading for the tree depending upon tree type if it's a * Class Tree or Interface tree. * * @param sset classes which are at the most base level, all the * other classes in this run will derive from these classes * @param heading heading for the tree * @param div the content tree to which the tree will be added */ protected void addTree(SortedSet sset, String heading, HtmlTree div) { addTree(sset, heading, div, false); } protected void addTree(SortedSet sset, String heading, HtmlTree div, boolean isEnums) { if (!sset.isEmpty()) { TypeElement firstTypeElement = sset.first(); Content headingContent = getResource(heading); Content sectionHeading = HtmlTree.HEADING(HtmlConstants.CONTENT_HEADING, true, headingContent); HtmlTree htmlTree; if (configuration.allowTag(HtmlTag.SECTION)) { htmlTree = HtmlTree.SECTION(sectionHeading); } else { div.addContent(sectionHeading); htmlTree = div; } addLevelInfo(!utils.isInterface(firstTypeElement) ? firstTypeElement : null, sset, isEnums, htmlTree); if (configuration.allowTag(HtmlTag.SECTION)) { div.addContent(htmlTree); } } } /** * Add information regarding the classes which this class extends or * implements. * * @param parent the parent class of the class being documented * @param typeElement the TypeElement under consideration * @param contentTree the content tree to which the information will be added */ protected void addExtendsImplements(TypeElement parent, TypeElement typeElement, Content contentTree) { SortedSet interfaces = new TreeSet<>(utils.makeGeneralPurposeComparator()); typeElement.getInterfaces().stream().forEach((t) -> { interfaces.add(utils.asTypeElement(t)); }); if (interfaces.size() > (utils.isInterface(typeElement) ? 1 : 0)) { boolean isFirst = true; for (TypeElement intf : interfaces) { if (parent != intf) { if (utils.isPublic(intf) || utils.isLinkable(intf)) { if (isFirst) { isFirst = false; if (utils.isInterface(typeElement)) { contentTree.addContent(" ("); contentTree.addContent(getResource("doclet.also")); contentTree.addContent(" extends "); } else { contentTree.addContent(" (implements "); } } else { contentTree.addContent(", "); } addPreQualifiedClassLink(LinkInfoImpl.Kind.TREE, intf, contentTree); } } } if (!isFirst) { contentTree.addContent(")"); } } } /** * Add information about the class kind, if it's a "class" or "interface". * * @param typeElement the class being documented * @param contentTree the content tree to which the information will be added */ protected void addPartialInfo(TypeElement typeElement, Content contentTree) { addPreQualifiedStrongClassLink(LinkInfoImpl.Kind.TREE, typeElement, contentTree); } /** * Get the tree label for the navigation bar. * * @return a content tree for the tree label */ protected Content getNavLinkTree() { Content li = HtmlTree.LI(HtmlStyle.navBarCell1Rev, treeLabel); return li; } }