1 /*
   2  * Copyright (c) 2003, 2019, 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 javax.lang.model.element.Element;
  29 import javax.lang.model.element.TypeElement;
  30 
  31 /**
  32  * The interface for writing annotation type required member 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 
  40 public interface AnnotationTypeRequiredMemberWriter {
  41 
  42     /**
  43      * Add the annotation type member tree header.
  44      *
  45      * @return content tree for the member tree header
  46      */
  47     Content getMemberTreeHeader();
  48 
  49     /**
  50      * Add the annotation type details marker.
  51      *
  52      * @param memberDetails the content tree representing details marker
  53      */
  54     void addAnnotationDetailsMarker(Content memberDetails);
  55 
  56     /**
  57      * Add the annotation type details tree header.
  58      *
  59      * @param typeElement the annotation type being documented
  60      */
  61     Content getAnnotationDetailsTreeHeader(TypeElement typeElement);
  62 
  63     /**
  64      * Get the annotation type documentation tree header.
  65      *
  66      * @param member the annotation type being documented
  67      * @param annotationDetailsTree the content tree representing annotation type details
  68      * @return content tree for the annotation type documentation header
  69      */
  70     Content getAnnotationDocTreeHeader(Element member, Content annotationDetailsTree);
  71 
  72     /**
  73      * Get the annotation type details tree.
  74      *
  75      * @param annotationDetailsTreeHeader the content tree representing annotation type details header
  76      * @param annotationDetailsTree the content tree representing annotation type details
  77      * @return content tree for the annotation type details
  78      */
  79     Content getAnnotationDetails(Content annotationDetailsTreeHeader, Content annotationDetailsTree);
  80 
  81     /**
  82      * Get the annotation type documentation.
  83      *
  84      * @param annotationDocTree the content tree representing annotation type documentation
  85      * @return content tree for the annotation type documentation
  86      */
  87     Content getAnnotationDoc(Content annotationDocTree);
  88 
  89     /**
  90      * Get the signature for the given member.
  91      *
  92      * @param member the member being documented
  93      * @return content tree for the annotation type signature
  94      */
  95     Content getSignature(Element member);
  96 
  97     /**
  98      * Add the deprecated output for the given member.
  99      *
 100      * @param member the member being documented
 101      * @param annotationDocTree content tree to which the deprecated information will be added
 102      */
 103     void addDeprecated(Element member, Content annotationDocTree);
 104 
 105     /**
 106      * Add the comments for the given member.
 107      *
 108      * @param member the member being documented
 109      * @param annotationDocTree the content tree to which the comments will be added
 110      */
 111     void addComments(Element member, Content annotationDocTree);
 112 
 113     /**
 114      * Add the tags for the given member.
 115      *
 116      * @param member the member being documented
 117      * @param annotationDocTree the content tree to which the tags will be added
 118      */
 119     void addTags(Element member, Content annotationDocTree);
 120 }