1 /*
   2  * Copyright (c) 2013, 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.Element;
  31 import javax.lang.model.element.TypeElement;
  32 
  33 /**
  34  * The interface for writing annotation type field output.
  35  *
  36  *  <p><b>This is NOT part of any supported API.
  37  *  If you write code that depends on this, you do so at your own risk.
  38  *  This code and its internal interfaces are subject to change or
  39  *  deletion without notice.</b>
  40  *
  41  *
  42  * @author Bhavesh Patel
  43  * @since 1.8
  44  */
  45 
  46 public interface AnnotationTypeFieldWriter {
  47 
  48     /**
  49      * Add the annotation type member tree header.
  50      *
  51      * @return content tree for the member tree header
  52      */
  53     public Content getMemberTreeHeader();
  54 
  55     /**
  56      * Add the annotation type field details marker.
  57      *
  58      * @param memberDetails the content tree representing field details marker
  59      */
  60     public void addAnnotationFieldDetailsMarker(Content memberDetails);
  61 
  62     /**
  63      * Add the annotation type details tree header.
  64      *
  65      * @param typeElement the annotation type being documented
  66      * @param memberDetailsTree the content tree representing member details
  67      */
  68     public void addAnnotationDetailsTreeHeader(TypeElement typeElement,
  69             Content memberDetailsTree);
  70 
  71     /**
  72      * Get the annotation type documentation tree header.
  73      *
  74      * @param member the annotation type being documented
  75      * @param annotationDetailsTree the content tree representing annotation type details
  76      * @return content tree for the annotation type documentation header
  77      */
  78     public Content getAnnotationDocTreeHeader(Element member, Content annotationDetailsTree);
  79 
  80     /**
  81      * Get the annotation type details tree.
  82      *
  83      * @param annotationDetailsTree the content tree representing annotation type details
  84      * @return content tree for the annotation type details
  85      */
  86     public Content getAnnotationDetails(Content annotationDetailsTree);
  87 
  88     /**
  89      * Get the annotation type documentation.
  90      *
  91      * @param annotationDocTree the content tree representing annotation type documentation
  92      * @param isLastContent true if the content to be added is the last content
  93      * @return content tree for the annotation type documentation
  94      */
  95     public Content getAnnotationDoc(Content annotationDocTree, boolean isLastContent);
  96 
  97     /**
  98      * Get the signature for the given member.
  99      *
 100      * @param member the member being documented
 101      * @return content tree for the annotation type signature
 102      */
 103     public Content getSignature(Element member);
 104 
 105     /**
 106      * Add the deprecated output for the given member.
 107      *
 108      * @param member the member being documented
 109      * @param annotationDocTree content tree to which the deprecated information will be added
 110      */
 111     public void addDeprecated(Element member, Content annotationDocTree);
 112 
 113     /**
 114      * Add the comments for the given member.
 115      *
 116      * @param member the member being documented
 117      * @param annotationDocTree the content tree to which the comments will be added
 118      */
 119     public void addComments(Element member, Content annotationDocTree);
 120 
 121     /**
 122      * Add the tags for the given member.
 123      *
 124      * @param member the member being documented
 125      * @param annotationDocTree the content tree to which the tags will be added
 126      */
 127     public void addTags(Element member, Content annotationDocTree);
 128 
 129     /**
 130      * Close the writer.
 131      */
 132     public void close() throws IOException;
 133 }