https://openjdk.java.net/ 
/*
 * Copyright (c) 2003, 2019, 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;

import java.util.SortedSet;

import javax.lang.model.element.TypeElement;

import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;


The interface for writing package summary output.
 
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.

/**
 * The interface for writing package summary output.
 *
 *  <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 interface PackageSummaryWriter {

    
Get the header for the summary.

Params:
  • heading – Package name.
Returns:the header to be added to the content tree
/**
     * Get the header for the summary.
     *
     * @param heading Package name.
     * @return the header to be added to the content tree
     */
    public abstract Content getPackageHeader(String heading);

    
Get the header for the package content.

Returns:a content tree for the package content header
/**
     * Get the header for the package content.
     *
     * @return a content tree for the package content header
     */
    public abstract Content getContentHeader();

    
Get the header for the package summary.

Returns:a content tree with the package summary header
/**
     * Get the header for the package summary.
     *
     * @return a content tree with the package summary header
     */
    public abstract Content getSummaryHeader();

    
Adds the table of interfaces to the documentation tree.

Params:
  • interfaces – the interfaces to document.
  • summaryContentTree – the content tree to which the summaries will be added
/**
     * Adds the table of interfaces to the documentation tree.
     *
     * @param interfaces the interfaces to document.
     * @param summaryContentTree the content tree to which the summaries will be added
     */
    public abstract void addInterfaceSummary(SortedSet<TypeElement> interfaces,
            Content summaryContentTree);

    
Adds the table of classes to the documentation tree.

Params:
  • classes – the classes to document.
  • summaryContentTree – the content tree to which the summaries will be added
/**
     * Adds the table of classes to the documentation tree.
     *
     * @param classes the classes to document.
     * @param summaryContentTree the content tree to which the summaries will be added
     */
    public abstract void addClassSummary(SortedSet<TypeElement> classes,
            Content summaryContentTree);

    
Adds the table of enums to the documentation tree.

Params:
  • enums – the enums to document.
  • summaryContentTree – the content tree to which the summaries will be added
/**
     * Adds the table of enums to the documentation tree.
     *
     * @param enums the enums to document.
     * @param summaryContentTree the content tree to which the summaries will be added
     */
    public abstract void addEnumSummary(SortedSet<TypeElement> enums,
            Content summaryContentTree);

    
Adds the table of records to the documentation tree.

Params:
  • records – the records to document.
  • summaryContentTree – the content tree to which the summaries will be added
/**
     * Adds the table of records to the documentation tree.
     *
     * @param records the records to document.
     * @param summaryContentTree the content tree to which the summaries will be added
     */
    public abstract void addRecordSummary(SortedSet<TypeElement> records,
                                        Content summaryContentTree);

    
Adds the table of exceptions to the documentation tree.

Params:
  • exceptions – the exceptions to document.
  • summaryContentTree – the content tree to which the summaries will be added
/**
     * Adds the table of exceptions to the documentation tree.
     *
     * @param exceptions the exceptions to document.
     * @param summaryContentTree the content tree to which the summaries will be added
     */
    public abstract void addExceptionSummary(SortedSet<TypeElement> exceptions,
            Content summaryContentTree);

    
Adds the table of errors to the documentation tree.

Params:
  • errors – the errors to document.
  • summaryContentTree – the content tree to which the summaries will be added
/**
     * Adds the table of errors to the documentation tree.
     *
     * @param errors the errors to document.
     * @param summaryContentTree the content tree to which the summaries will be added
     */
    public abstract void addErrorSummary(SortedSet<TypeElement> errors,
            Content summaryContentTree);

    
Adds the table of annotation types to the documentation tree.

Params:
  • annoTypes – the annotation types to document.
  • summaryContentTree – the content tree to which the summaries will be added
/**
     * Adds the table of annotation types to the documentation tree.
     *
     * @param annoTypes the annotation types to document.
     * @param summaryContentTree the content tree to which the summaries will be added
     */
    public abstract void addAnnotationTypeSummary(SortedSet<TypeElement> annoTypes,
            Content summaryContentTree);

    
Adds the package description from the "packages.html" file to the documentation
tree.

Params:
  • packageContentTree – the content tree to which the package description
                          will be added
/**
     * Adds the package description from the "packages.html" file to the documentation
     * tree.
     *
     * @param packageContentTree the content tree to which the package description
     *                           will be added
     */
    public abstract void addPackageDescription(Content packageContentTree);

    
Adds the tag information from the "packages.html" file to the documentation
tree.

Params:
  • packageContentTree – the content tree to which the package tags will
                          be added
/**
     * Adds the tag information from the "packages.html" file to the documentation
     * tree.
     *
     * @param packageContentTree the content tree to which the package tags will
     *                           be added
     */
    public abstract void addPackageTags(Content packageContentTree);

    
Adds the tag information from the "packages.html" or "package-info.java" file to the
documentation tree.

Params:
  • packageContentTree – the package content tree to be added
/**
     * Adds the tag information from the "packages.html" or "package-info.java" file to the
     * documentation tree.
     *
     * @param packageContentTree the package content tree to be added
     */
    public abstract void addPackageContent(Content packageContentTree);

    
Adds the footer to the documentation tree.

/**
     * Adds the footer to the documentation tree.
     */
    public abstract void addPackageFooter();

    
Print the package summary document.

Params:
  • contentTree – the content tree that will be printed
Throws:
/**
     * Print the package summary document.
     *
     * @param contentTree the content tree that will be printed
     * @throws DocFileIOException if there is a problem while writing the document
     */
    public abstract void printDocument(Content contentTree) throws DocFileIOException;

    
Gets the package summary tree.

Params:
  • summaryContentTree – the content tree representing the package summary
Returns:a content tree for the package summary
/**
     * Gets the package summary tree.
     * @param summaryContentTree the content tree representing the package summary
     * @return a content tree for the package summary
     */
    public abstract Content getPackageSummary(Content summaryContentTree);

}