jdk.javadoc.internal.doclets.toolkit.MemberSummaryWriter Maven / Gradle / Ivy
/*
* 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.*;
import javax.lang.model.element.Element;
import javax.lang.model.element.TypeElement;
import com.sun.source.doctree.DocTree;
/**
* The interface for writing member 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.
*/
public interface MemberSummaryWriter {
/**
* Returns the member summary header for the given class.
*
* @param typeElement the class the summary belongs to
* @param memberSummaryTree the content tree to which the member summary will be added
*
* @return a content tree for the member summary header
*/
Content getMemberSummaryHeader(TypeElement typeElement, Content memberSummaryTree);
/**
* Returns the summary table for the given class.
*
* @param typeElement the class the summary table belongs to
*
* @return a content tree for the member summary table
*/
Content getSummaryTableTree(TypeElement typeElement);
/**
* Adds the member summary for the given class and member.
*
* @param typeElement the class the summary belongs to
* @param member the member that is documented
* @param firstSentenceTrees the tags for the sentence being documented
*/
void addMemberSummary(TypeElement typeElement, Element member,
List firstSentenceTrees);
/**
* Returns the inherited member summary header for the given class.
*
* @param typeElement the class the summary belongs to
*
* @return a content tree containing the inherited summary header
*/
Content getInheritedSummaryHeader(TypeElement typeElement);
/**
* Adds the inherited member summary for the given class and member.
*
* @param typeElement the class the inherited member belongs to
* @param member the inherited member that is being documented
* @param isFirst true if this is the first member in the list
* @param isLast true if this is the last member in the list
* @param linksTree the content tree to which the links will be added
*/
void addInheritedMemberSummary(TypeElement typeElement,
Element member, boolean isFirst, boolean isLast,
Content linksTree);
/**
* Returns the inherited summary links.
*
* @return a content tree containing the inherited summary links
*/
Content getInheritedSummaryLinksTree();
/**
* Adds the given summary to the list of summaries.
*
* @param summariesList the list of summaries
* @param content the summary
*/
void addSummary(Content summariesList, Content content);
/**
* Returns the member tree.
*
* @param memberTree the content tree representing the member
*
* @return a content tree for the member
*/
Content getMemberTree(Content memberTree);
}