duke@1: /* jjg@1359: * Copyright (c) 2003, 2012, Oracle and/or its affiliates. All rights reserved. duke@1: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. duke@1: * duke@1: * This code is free software; you can redistribute it and/or modify it duke@1: * under the terms of the GNU General Public License version 2 only, as ohair@554: * published by the Free Software Foundation. Oracle designates this duke@1: * particular file as subject to the "Classpath" exception as provided ohair@554: * by Oracle in the LICENSE file that accompanied this code. duke@1: * duke@1: * This code is distributed in the hope that it will be useful, but WITHOUT duke@1: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or duke@1: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License duke@1: * version 2 for more details (a copy is included in the LICENSE file that duke@1: * accompanied this code). duke@1: * duke@1: * You should have received a copy of the GNU General Public License version duke@1: * 2 along with this work; if not, write to the Free Software Foundation, duke@1: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. duke@1: * ohair@554: * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA ohair@554: * or visit www.oracle.com if you need additional information or have any ohair@554: * questions. duke@1: */ duke@1: duke@1: duke@1: package com.sun.tools.doclets.internal.toolkit; duke@1: duke@1: import java.io.*; duke@1: import com.sun.javadoc.*; duke@1: duke@1: /** duke@1: * The interface for writing class output. duke@1: * jjg@1359: *

This is NOT part of any supported API. jjg@1359: * If you write code that depends on this, you do so at your own risk. jjg@1359: * This code and its internal interfaces are subject to change or jjg@1359: * deletion without notice. duke@1: * duke@1: * @author Jamie Ho bpatel@766: * @author Bhavesh Patel (Modified) duke@1: * @since 1.5 duke@1: */ duke@1: duke@1: public interface ClassWriter { duke@1: duke@1: /** bpatel@766: * Get the header of the page. bpatel@766: * bpatel@766: * @param header the header string to write bpatel@766: * @return header content that needs to be added to the documentation duke@1: */ bpatel@766: public Content getHeader(String header); duke@1: duke@1: /** bpatel@766: * Get the class content header. bpatel@766: * bpatel@766: * @return class content header that needs to be added to the documentation duke@1: */ bpatel@766: public Content getClassContentHeader(); duke@1: duke@1: /** bpatel@766: * Add the class tree documentation. bpatel@766: * bpatel@766: * @param classContentTree class content tree to which the documentation will be added duke@1: */ bpatel@766: public void addClassTree(Content classContentTree); duke@1: duke@1: /** bpatel@766: * Get the class information tree header. bpatel@766: * bpatel@766: * @return class informaion tree header that needs to be added to the documentation duke@1: */ bpatel@766: public Content getClassInfoTreeHeader(); duke@1: duke@1: /** bpatel@766: * Add the type parameter information. bpatel@766: * bpatel@766: * @param classInfoTree content tree to which the documentation will be added duke@1: */ bpatel@766: public void addTypeParamInfo(Content classInfoTree); duke@1: duke@1: /** bpatel@766: * Add all super interfaces if this is an interface. bpatel@766: * bpatel@766: * @param classInfoTree content tree to which the documentation will be added duke@1: */ bpatel@766: public void addSuperInterfacesInfo(Content classInfoTree); duke@1: duke@1: /** bpatel@766: * Add all implemented interfaces if this is a class. bpatel@766: * bpatel@766: * @param classInfoTree content tree to which the documentation will be added duke@1: */ bpatel@766: public void addImplementedInterfacesInfo(Content classInfoTree); duke@1: duke@1: /** bpatel@766: * Add all the classes that extend this one. bpatel@766: * bpatel@766: * @param classInfoTree content tree to which the documentation will be added duke@1: */ bpatel@766: public void addSubClassInfo(Content classInfoTree); duke@1: duke@1: /** bpatel@766: * Add all the interfaces that extend this one. bpatel@766: * bpatel@766: * @param classInfoTree content tree to which the documentation will be added duke@1: */ bpatel@766: public void addSubInterfacesInfo(Content classInfoTree); duke@1: duke@1: /** bpatel@766: * If this is an interface, add all classes that implement this bpatel@766: * interface. bpatel@766: * bpatel@766: * @param classInfoTree content tree to which the documentation will be added duke@1: */ bpatel@766: public void addInterfaceUsageInfo(Content classInfoTree); duke@1: duke@1: /** bpatel@1468: * If this is an functional interface, display appropriate message. bpatel@1468: * bpatel@1468: * @param classInfoTree content tree to which the documentation will be added bpatel@1468: */ bpatel@1468: public void addFunctionalInterfaceInfo(Content classInfoTree); bpatel@1468: bpatel@1468: /** bpatel@766: * If this is an inner class or interface, add the enclosing class or bpatel@766: * interface. duke@1: * bpatel@766: * @param classInfoTree content tree to which the documentation will be added duke@1: */ bpatel@766: public void addNestedClassInfo (Content classInfoTree); bpatel@766: bpatel@766: /** bpatel@766: * Get the class information. bpatel@766: * bpatel@766: * @param classInfoTree content tree conatining the class information bpatel@766: * @return a content tree for the class bpatel@766: */ bpatel@766: public Content getClassInfo(Content classInfoTree); bpatel@766: bpatel@766: /** bpatel@766: * If this class is deprecated, add the appropriate information. bpatel@766: * bpatel@766: * @param classInfoTree content tree to which the documentation will be added bpatel@766: */ bpatel@766: public void addClassDeprecationInfo (Content classInfoTree); bpatel@766: bpatel@766: /** bpatel@766: * Add the signature of the current class content tree. bpatel@766: * bpatel@766: * @param modifiers the modifiers for the signature bpatel@766: * @param classInfoTree the class content tree to which the signature will be added bpatel@766: */ bpatel@766: public void addClassSignature(String modifiers, Content classInfoTree); duke@1: duke@1: /** duke@1: * Build the class description. bpatel@766: * bpatel@766: * @param classInfoTree content tree to which the documentation will be added duke@1: */ bpatel@766: public void addClassDescription(Content classInfoTree); duke@1: duke@1: /** bpatel@766: * Add the tag information for the current class. bpatel@766: * bpatel@766: * @param classInfoTree content tree to which the tag information will be added duke@1: */ bpatel@766: public void addClassTagInfo(Content classInfoTree); duke@1: duke@1: /** bpatel@766: * Get the member tree header for the class. bpatel@766: * bpatel@766: * @return a content tree for the member tree header duke@1: */ bpatel@766: public Content getMemberTreeHeader(); bpatel@766: bpatel@766: /** bpatel@766: * Add the footer of the page. bpatel@766: * bpatel@766: * @param contentTree content tree to which the footer will be added bpatel@766: */ bpatel@766: public void addFooter(Content contentTree); bpatel@766: bpatel@766: /** bpatel@766: * Print the document. bpatel@766: * bpatel@766: * @param contentTree content tree that will be printed as a document bpatel@766: */ jjg@1364: public void printDocument(Content contentTree) throws IOException; duke@1: duke@1: /** duke@1: * Close the writer. duke@1: */ duke@1: public void close() throws IOException; duke@1: duke@1: /** duke@1: * Return the classDoc being documented. duke@1: * duke@1: * @return the classDoc being documented. duke@1: */ duke@1: public ClassDoc getClassDoc(); duke@1: duke@1: /** bpatel@766: * Get the member summary tree. bpatel@766: * bpatel@766: * @param memberTree the content tree used to build the summary tree bpatel@766: * @return a content tree for the member summary duke@1: */ bpatel@766: public Content getMemberSummaryTree(Content memberTree); bpatel@766: bpatel@766: /** bpatel@766: * Get the member details tree. bpatel@766: * bpatel@766: * @param memberTree the content tree used to build the details tree bpatel@766: * @return a content tree for the member details bpatel@766: */ bpatel@766: public Content getMemberDetailsTree(Content memberTree); duke@1: }