/*

 * Copyright (c) 2003, 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.toolkit;

import java.util.*;

import javax.lang.model.element.PackageElement;

import javax.lang.model.element.TypeElement;

import javax.lang.model.element.VariableElement;

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

/**

 * The interface for writing constants 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>

 *

 * @author Jamie Ho

 * @author Bhavesh Patel (Modified)

 */

public interface ConstantsSummaryWriter {

    /**

     * Get the header for the constant summary documentation.

     *

     * @return header that needs to be added to the documentation

     */

    public abstract Content getHeader();

    /**

     * Get the header for the constant content list.

     *

     * @return content header that needs to be added to the documentation

     */

    public abstract Content getContentsHeader();

    /**

     * Adds the given package name link to the constant content list tree.

     *

     * @param pkg                    the {@link PackageElement} to index.

     * @param writtenPackageHeaders  the set of package headers that have already

     *                               been indexed, we want to index utmost once.

     * @param contentListTree        the content tree to which the link will be added

     */

    public abstract void addLinkToPackageContent(PackageElement pkg,

            Set<PackageElement> writtenPackageHeaders, Content contentListTree);

    /**

     * Add the content list to the documentation tree.

     *

     * @param contentListTree the content that will be added to the list

     */

    /**

     * Get the constant summaries for the document.

     *

     * @return constant summaries header to be added to the documentation tree

     */

    public abstract Content getConstantSummaries();

    /**

     * Adds the given package name.

     *

     * @param pkg  the parsed package name.  We only Write the

     *                          first 2 directory levels of the package

     *                          name. For example, java.lang.ref would be

     *                          indexed as java.lang.*.

     * @param summariesTree the summaries documentation tree

     * @param first true if the first package is listed

     *                    be written

     */

    public abstract void addPackageName(PackageElement pkg, Content summariesTree, boolean first);

    /**

     * Get the class summary header for the constants summary.

     *

     * @return the header content for the class constants summary

     */

    public abstract Content getClassConstantHeader();

    /**

     * Add the content list to the documentation summaries tree.

     *

     * @param summariesTree the tree to which the class constants list will be added

     * @param classConstantTree the class constant tree that will be added to the list

     */

    public abstract void addClassConstant(Content summariesTree, Content classConstantTree);

    /**

     * Adds the constant member table to the documentation tree.

     *

     * @param typeElement the class whose constants are being documented.

     * @param fields the constants being documented.

     * @param classConstantTree the documentation tree to which theconstant member

     *                    table content will be added

     */

    public abstract void addConstantMembers(TypeElement typeElement, Collection<VariableElement> fields,

            Content classConstantTree);

    /**

     * Add the summaries list to the content tree.

     *

     * @param summariesTree the summaries content tree that will be added to the list

     */

    /**

     * Adds the footer for the summary documentation.

     */

    /**

     * Print the constants summary document.

     *

     * @param contentTree content tree which should be printed

     * @throws DocFileIOException if there is a problem while writing the document

     */

    public abstract void printDocument(Content contentTree) throws DocFileIOException;

}