All Downloads are FREE. Search and download functionalities are using the official Maven repository.

jdk.javadoc.internal.doclets.toolkit.builders.PackageSummaryBuilder Maven / Gradle / Ivy

There is a newer version: 21.0.0
Show newest version
/*
 * Copyright (c) 2003, 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.toolkit.builders;

import java.util.Set;
import java.util.SortedSet;

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

import jdk.javadoc.internal.doclets.toolkit.Content;
import jdk.javadoc.internal.doclets.toolkit.DocFilesHandler;
import jdk.javadoc.internal.doclets.toolkit.DocletException;
import jdk.javadoc.internal.doclets.toolkit.PackageSummaryWriter;


/**
 * Builds the summary for a given package.
 *
 *  

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. */ public class PackageSummaryBuilder extends AbstractBuilder { /** * The package being documented. */ private final PackageElement packageElement; /** * The doclet specific writer that will output the result. */ private final PackageSummaryWriter packageWriter; /** * Construct a new PackageSummaryBuilder. * * @param context the build context. * @param pkg the package being documented. * @param packageWriter the doclet specific writer that will output the * result. */ private PackageSummaryBuilder(Context context, PackageElement pkg, PackageSummaryWriter packageWriter) { super(context); this.packageElement = pkg; this.packageWriter = packageWriter; } /** * Construct a new PackageSummaryBuilder. * * @param context the build context. * @param pkg the package being documented. * @param packageWriter the doclet specific writer that will output the * result. * * @return an instance of a PackageSummaryBuilder. */ public static PackageSummaryBuilder getInstance(Context context, PackageElement pkg, PackageSummaryWriter packageWriter) { return new PackageSummaryBuilder(context, pkg, packageWriter); } /** * Build the package summary. * * @throws DocletException if there is a problem while building the documentation */ @Override public void build() throws DocletException { if (packageWriter == null) { //Doclet does not support this output. return; } buildPackageDoc(); } /** * Build the package documentation. * * @throws DocletException if there is a problem while building the documentation */ protected void buildPackageDoc() throws DocletException { Content contentTree = packageWriter.getPackageHeader(utils.getPackageName(packageElement)); buildContent(); packageWriter.addPackageFooter(); packageWriter.printDocument(contentTree); DocFilesHandler docFilesHandler = configuration .getWriterFactory() .getDocFilesHandler(packageElement); docFilesHandler.copyDocFiles(); } /** * Build the content for the package. * * @throws DocletException if there is a problem while building the documentation */ protected void buildContent() throws DocletException { Content packageContentTree = packageWriter.getContentHeader(); packageWriter.addPackageSignature(packageContentTree); buildPackageDescription(packageContentTree); buildPackageTags(packageContentTree); buildSummary(packageContentTree); packageWriter.addPackageContent(packageContentTree); } /** * Builds the list of summaries for the different kinds of types in this package. * * @param packageContentTree the package content tree to which the summaries will * be added * @throws DocletException if there is a problem while building the documentation */ protected void buildSummary(Content packageContentTree) throws DocletException { Content summariesList = packageWriter.getSummariesList(); buildInterfaceSummary(summariesList); buildClassSummary(summariesList); buildEnumSummary(summariesList); buildRecordSummary(summariesList); buildExceptionSummary(summariesList); buildErrorSummary(summariesList); buildAnnotationTypeSummary(summariesList); packageContentTree.add(packageWriter.getPackageSummary(summariesList)); } /** * Builds the summary for any interfaces in this package. * * @param summariesList the list of summaries to which the summary will be added */ protected void buildInterfaceSummary(Content summariesList) { SortedSet ilist = utils.isSpecified(packageElement) ? utils.getTypeElementsAsSortedSet(utils.getInterfaces(packageElement)) : configuration.typeElementCatalog.interfaces(packageElement); SortedSet interfaces = utils.filterOutPrivateClasses(ilist, options.javafx()); if (!interfaces.isEmpty()) { packageWriter.addInterfaceSummary(interfaces, summariesList); } } /** * Builds the summary for any classes in this package. * * @param summariesList the list of summaries to which the summary will be added */ protected void buildClassSummary(Content summariesList) { SortedSet clist = utils.isSpecified(packageElement) ? utils.getTypeElementsAsSortedSet(utils.getOrdinaryClasses(packageElement)) : configuration.typeElementCatalog.ordinaryClasses(packageElement); SortedSet classes = utils.filterOutPrivateClasses(clist, options.javafx()); if (!classes.isEmpty()) { packageWriter.addClassSummary(classes, summariesList); } } /** * Builds the summary for the enum types in this package. * * @param summariesList the list of summaries to which the summary will be added */ protected void buildEnumSummary(Content summariesList) { SortedSet elist = utils.isSpecified(packageElement) ? utils.getTypeElementsAsSortedSet(utils.getEnums(packageElement)) : configuration.typeElementCatalog.enums(packageElement); SortedSet enums = utils.filterOutPrivateClasses(elist, options.javafx()); if (!enums.isEmpty()) { packageWriter.addEnumSummary(enums, summariesList); } } /** * Builds the summary for any record types in this package. * * @param summariesList the list of summaries to which the summary will be added */ protected void buildRecordSummary(Content summariesList) { SortedSet rlist = utils.isSpecified(packageElement) ? utils.getTypeElementsAsSortedSet(utils.getRecords(packageElement)) : configuration.typeElementCatalog.records(packageElement); SortedSet records = utils.filterOutPrivateClasses(rlist, options.javafx()); if (!records.isEmpty()) { packageWriter.addRecordSummary(records, summariesList); } } /** * Builds the summary for any exception types in this package. * * @param summariesList the list of summaries to which the summary will be added */ protected void buildExceptionSummary(Content summariesList) { Set iexceptions = utils.isSpecified(packageElement) ? utils.getTypeElementsAsSortedSet(utils.getExceptions(packageElement)) : configuration.typeElementCatalog.exceptions(packageElement); SortedSet exceptions = utils.filterOutPrivateClasses(iexceptions, options.javafx()); if (!exceptions.isEmpty()) { packageWriter.addExceptionSummary(exceptions, summariesList); } } /** * Builds the summary for any error types in this package. * * @param summariesList the list of summaries to which the summary will be added */ protected void buildErrorSummary(Content summariesList) { Set ierrors = utils.isSpecified(packageElement) ? utils.getTypeElementsAsSortedSet(utils.getErrors(packageElement)) : configuration.typeElementCatalog.errors(packageElement); SortedSet errors = utils.filterOutPrivateClasses(ierrors, options.javafx()); if (!errors.isEmpty()) { packageWriter.addErrorSummary(errors, summariesList); } } /** * Builds the summary for any annotation types in this package. * * @param summariesList the list of summaries to which the summary will be added */ protected void buildAnnotationTypeSummary(Content summariesList) { SortedSet iannotationTypes = utils.isSpecified(packageElement) ? utils.getTypeElementsAsSortedSet(utils.getAnnotationTypes(packageElement)) : configuration.typeElementCatalog.annotationTypes(packageElement); SortedSet annotationTypes = utils.filterOutPrivateClasses(iannotationTypes, options.javafx()); if (!annotationTypes.isEmpty()) { packageWriter.addAnnotationTypeSummary(annotationTypes, summariesList); } } /** * Build the description of the summary. * * @param packageContentTree the tree to which the package description will * be added */ protected void buildPackageDescription(Content packageContentTree) { if (options.noComment()) { return; } packageWriter.addPackageDescription(packageContentTree); } /** * Build the tags of the summary. * * @param packageContentTree the tree to which the package tags will be added */ protected void buildPackageTags(Content packageContentTree) { if (options.noComment()) { return; } packageWriter.addPackageTags(packageContentTree); } }





© 2015 - 2025 Weber Informatics LLC | Privacy Policy