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

This is NOT part of any supported API. aoqi@0: * If you write code that depends on this, you do so at your own risk. aoqi@0: * This code and its internal interfaces are subject to change or aoqi@0: * deletion without notice. aoqi@0: * aoqi@0: * @author Jamie Ho aoqi@0: * @author Bhavesh Patel (Modified) aoqi@0: * @since 1.5 aoqi@0: */ aoqi@0: aoqi@0: public interface AnnotationTypeWriter { aoqi@0: aoqi@0: /** aoqi@0: * Get the header of the page. aoqi@0: * aoqi@0: * @param header the header string to write aoqi@0: * @return a content tree for the header documentation aoqi@0: */ aoqi@0: public Content getHeader(String header); aoqi@0: aoqi@0: /** aoqi@0: * Get the annotation content header. aoqi@0: * aoqi@0: * @return annotation content header that needs to be added to the documentation aoqi@0: */ aoqi@0: public Content getAnnotationContentHeader(); aoqi@0: aoqi@0: /** aoqi@0: * Get the annotation information tree header. aoqi@0: * aoqi@0: * @return annotation information tree header that needs to be added to the documentation aoqi@0: */ aoqi@0: public Content getAnnotationInfoTreeHeader(); aoqi@0: aoqi@0: /** aoqi@0: * Get the annotation information. aoqi@0: * aoqi@0: * @param annotationInfoTree content tree containing the annotation information aoqi@0: * @return a content tree for the annotation aoqi@0: */ aoqi@0: public Content getAnnotationInfo(Content annotationInfoTree); aoqi@0: aoqi@0: /** aoqi@0: * Add the signature of the current annotation type. aoqi@0: * aoqi@0: * @param modifiers the modifiers for the signature aoqi@0: * @param annotationInfoTree the annotation content tree to which the signature will be added aoqi@0: */ aoqi@0: public void addAnnotationTypeSignature(String modifiers, Content annotationInfoTree); aoqi@0: aoqi@0: /** aoqi@0: * Build the annotation type description. aoqi@0: * aoqi@0: * @param annotationInfoTree content tree to which the description will be added aoqi@0: */ aoqi@0: public void addAnnotationTypeDescription(Content annotationInfoTree); aoqi@0: aoqi@0: /** aoqi@0: * Add the tag information for the current annotation type. aoqi@0: * aoqi@0: * @param annotationInfoTree content tree to which the tag information will be added aoqi@0: */ aoqi@0: public void addAnnotationTypeTagInfo(Content annotationInfoTree); aoqi@0: aoqi@0: /** aoqi@0: * If this annotation is deprecated, add the appropriate information. aoqi@0: * aoqi@0: * @param annotationInfoTree content tree to which the deprecated information will be added aoqi@0: */ aoqi@0: public void addAnnotationTypeDeprecationInfo (Content annotationInfoTree); aoqi@0: aoqi@0: /** aoqi@0: * Get the member tree header for the annotation type. aoqi@0: * aoqi@0: * @return a content tree for the member tree header aoqi@0: */ aoqi@0: public Content getMemberTreeHeader(); aoqi@0: aoqi@0: /** aoqi@0: * Get the member tree. aoqi@0: * aoqi@0: * @param memberTree the content tree that will be modified and returned aoqi@0: * @return a content tree for the member aoqi@0: */ aoqi@0: public Content getMemberTree(Content memberTree); aoqi@0: aoqi@0: /** aoqi@0: * Get the member summary tree. aoqi@0: * aoqi@0: * @param memberTree the content tree that will be used to build the summary tree aoqi@0: * @return a content tree for the member summary aoqi@0: */ aoqi@0: public Content getMemberSummaryTree(Content memberTree); aoqi@0: aoqi@0: /** aoqi@0: * Get the member details tree. aoqi@0: * aoqi@0: * @param memberTree the content tree that will be used to build the details tree aoqi@0: * @return a content tree for the member details aoqi@0: */ aoqi@0: public Content getMemberDetailsTree(Content memberTree); aoqi@0: aoqi@0: /** aoqi@0: * Add the footer of the page. aoqi@0: * aoqi@0: * @param contentTree content tree to which the footer will be added aoqi@0: */ aoqi@0: public void addFooter(Content contentTree); aoqi@0: aoqi@0: /** aoqi@0: * Print the document. aoqi@0: * aoqi@0: * @param contentTree content tree that will be printed as a document aoqi@0: */ aoqi@0: public void printDocument(Content contentTree) throws IOException; aoqi@0: aoqi@0: /** aoqi@0: * Close the writer. aoqi@0: */ aoqi@0: public void close() throws IOException; aoqi@0: aoqi@0: /** aoqi@0: * Return the {@link AnnotationTypeDoc} being documented. aoqi@0: * aoqi@0: * @return the AnnotationTypeDoc being documented. aoqi@0: */ aoqi@0: public AnnotationTypeDoc getAnnotationTypeDoc(); aoqi@0: }