1 /*
   2  * Copyright (c) 2003, 2015, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package com.sun.tools.doclets.internal.toolkit;
  27 
  28 import java.io.*;
  29 import com.sun.javadoc.*;
  30 


  31 /**
  32  * The interface for writing annotation type output.
  33  *
  34  *  <p><b>This is NOT part of any supported API.
  35  *  If you write code that depends on this, you do so at your own risk.
  36  *  This code and its internal interfaces are subject to change or
  37  *  deletion without notice.</b>
  38  *
  39  * @author Jamie Ho
  40  * @author Bhavesh Patel (Modified)
  41  * @since 1.5
  42  */
  43 
  44 public interface AnnotationTypeWriter {
  45 
  46     /**
  47      * Get the header of the page.
  48      *
  49      * @param header the header string to write
  50      * @return a content tree for the header documentation

 144     /**
 145      * Add the footer of the page.
 146      *
 147      * @param contentTree content tree to which the footer will be added
 148      */
 149     public void addFooter(Content contentTree);
 150 
 151     /**
 152      * Print the document.
 153      *
 154      * @param contentTree content tree that will be printed as a document
 155      */
 156     public void printDocument(Content contentTree) throws IOException;
 157 
 158     /**
 159      * Close the writer.
 160      */
 161     public void close() throws IOException;
 162 
 163     /**
 164      * Return the {@link AnnotationTypeDoc} being documented.
 165      *
 166      * @return the AnnotationTypeDoc being documented.
 167      */
 168     public AnnotationTypeDoc getAnnotationTypeDoc();
 169 }

   1 /*
   2  * Copyright (c) 2003, 2016, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package jdk.javadoc.internal.doclets.toolkit;
  27 
  28 import java.io.*;

  29 
  30 import javax.lang.model.element.TypeElement;
  31 
  32 /**
  33  * The interface for writing annotation type output.
  34  *
  35  *  <p><b>This is NOT part of any supported API.
  36  *  If you write code that depends on this, you do so at your own risk.
  37  *  This code and its internal interfaces are subject to change or
  38  *  deletion without notice.</b>
  39  *
  40  * @author Jamie Ho
  41  * @author Bhavesh Patel (Modified)
  42  * @since 1.5
  43  */
  44 
  45 public interface AnnotationTypeWriter {
  46 
  47     /**
  48      * Get the header of the page.
  49      *
  50      * @param header the header string to write
  51      * @return a content tree for the header documentation

 145     /**
 146      * Add the footer of the page.
 147      *
 148      * @param contentTree content tree to which the footer will be added
 149      */
 150     public void addFooter(Content contentTree);
 151 
 152     /**
 153      * Print the document.
 154      *
 155      * @param contentTree content tree that will be printed as a document
 156      */
 157     public void printDocument(Content contentTree) throws IOException;
 158 
 159     /**
 160      * Close the writer.
 161      */
 162     public void close() throws IOException;
 163 
 164     /**
 165      * Return the {@link TypeElement} being documented.
 166      *
 167      * @return the TypeElement representing the annotation being documented.
 168      */
 169     public TypeElement getAnnotationTypeElement();
 170 }